Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKStartMeetingElements Class Reference

Meeting start options when using SDK credentials (no ZAK). More...

#include <ZoomSDKMeetingService.h>

Inherits NSObject.

Properties

NSString * vanityID
 Sets meetingNumber to 0 if you want to start a meeting with vanityID.
ZoomSDKUserType userType
 It depends on the type of client account.
long long meetingNumber
 It may be the number of a scheduled meeting or a Personal Meeting ID. Set it to 0 to start an instant meeting.
BOOL isDirectShare
 Sets it to YES to start sharing computer desktop directly when meeting starts.
CGDirectDisplayID displayID
 The APP to be shared.
BOOL isNoVideo
 Sets it to YES to turn off the video when user joins meeting.
BOOL isNoAudio
 Sets it to YES to turn off the audio when user joins meeting.
NSString * customerKey
 Customer Key the customer key of user.
BOOL isMyVoiceInMix
 Sets it to YES to contain my voice in the mixed audio raw data.
NSString * inviteContactID
 Sets the invitation ID for automatic meeting invitation.
BOOL isAudioRawDataStereo
 Is audio raw data stereo? The default is mono.
ZoomSDKAudioRawdataSamplingRate audioRawdataSamplingRate
 The sampling rate of the acquired raw audio data. The default is AudioRawdataSamplingRate_32K.
ZoomSDKVideoRawdataColorspace videoRawdataColorspace
 The colorspace of video rawdata. The default is ZoomSDKVideoRawdataColorspace_BT601_L.

Detailed Description

Meeting start options when using SDK credentials (no ZAK).

Definition at line 85 of file ZoomSDKMeetingService.h.

Property Documentation

◆ audioRawdataSamplingRate

- (ZoomSDKAudioRawdataSamplingRate) audioRawdataSamplingRate
readwritenonatomicassign

The sampling rate of the acquired raw audio data. The default is AudioRawdataSamplingRate_32K.

Definition at line 133 of file ZoomSDKMeetingService.h.

◆ customerKey

- (NSString*) customerKey
readwritenonatomiccopy

Customer Key the customer key of user.

Definition at line 117 of file ZoomSDKMeetingService.h.

◆ displayID

- (CGDirectDisplayID) displayID
readwritenonatomicassign

The APP to be shared.

Definition at line 105 of file ZoomSDKMeetingService.h.

◆ inviteContactID

- (NSString*) inviteContactID
readwritenonatomiccopy

Sets the invitation ID for automatic meeting invitation.

Definition at line 125 of file ZoomSDKMeetingService.h.

◆ isAudioRawDataStereo

- (BOOL) isAudioRawDataStereo
readwritenonatomicassign

Is audio raw data stereo? The default is mono.

Definition at line 129 of file ZoomSDKMeetingService.h.

◆ isDirectShare

- (BOOL) isDirectShare
readwritenonatomicassign

Sets it to YES to start sharing computer desktop directly when meeting starts.

Definition at line 101 of file ZoomSDKMeetingService.h.

◆ isMyVoiceInMix

- (BOOL) isMyVoiceInMix
readwritenonatomicassign

Sets it to YES to contain my voice in the mixed audio raw data.

Definition at line 121 of file ZoomSDKMeetingService.h.

◆ isNoAudio

- (BOOL) isNoAudio
readwritenonatomicassign

Sets it to YES to turn off the audio when user joins meeting.

Definition at line 113 of file ZoomSDKMeetingService.h.

◆ isNoVideo

- (BOOL) isNoVideo
readwritenonatomicassign

Sets it to YES to turn off the video when user joins meeting.

Definition at line 109 of file ZoomSDKMeetingService.h.

◆ meetingNumber

- (long long) meetingNumber
readwritenonatomicassign

It may be the number of a scheduled meeting or a Personal Meeting ID. Set it to 0 to start an instant meeting.

Definition at line 97 of file ZoomSDKMeetingService.h.

◆ userType

- (ZoomSDKUserType) userType
readwritenonatomicassign

It depends on the type of client account.

Definition at line 93 of file ZoomSDKMeetingService.h.

◆ vanityID

- (NSString*) vanityID
readwritenonatomiccopy

Sets meetingNumber to 0 if you want to start a meeting with vanityID.

Definition at line 89 of file ZoomSDKMeetingService.h.

◆ videoRawdataColorspace

- (ZoomSDKVideoRawdataColorspace) videoRawdataColorspace
readwritenonatomicassign

The colorspace of video rawdata. The default is ZoomSDKVideoRawdataColorspace_BT601_L.

Definition at line 137 of file ZoomSDKMeetingService.h.