Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingStartParam Class Reference

Provides settings for starting a meeting, such as enabling screen sharing, microphone, and camera. More...

#import <MobileRTCMeetingService.h>

Inherits NSObject.

Inherited by MobileRTCMeetingStartParam4LoginlUser, and MobileRTCMeetingStartParam4WithoutLoginUser.

Properties

BOOL isAppShare
 Start meeting with screen sharing immediately enabled.
 
BOOL noAudio
 Start meeting with microphone disabled.
 
BOOL noVideo
 Start meeting with camera disabled.
 
NSString * customerKey
 Developer-specified string to track end user.
 
NSString * vanityID
 Special ID for the personal link name in organization URL, like "yourcompany" in yourcompany.zoom.us.
 
NSString * meetingNumber
 Meeting number, in format like 123456789.
 
BOOL isMyVoiceInMix
 <Optional> Is my voice in the mixed audio raw data?
 
NSString * inviteContactID
 <Optional>Set the invitation ID for automatic meeting invitation.
 
BOOL isAudioRawDataStereo
 <Optional> Is audio raw data stereo? The default is mono.
 

Detailed Description

Provides settings for starting a meeting, such as enabling screen sharing, microphone, and camera.

Definition at line 16 of file MobileRTCMeetingService.h.

Property Documentation

◆ customerKey

- (NSString*) customerKey
readwritenonatomicretain

Developer-specified string to track end user.

Note
Provided in webhook event, not used internally by SDK.

Definition at line 37 of file MobileRTCMeetingService.h.

◆ inviteContactID

- (NSString*) inviteContactID
readwritenonatomiccopy

<Optional>Set the invitation ID for automatic meeting invitation.

Definition at line 57 of file MobileRTCMeetingService.h.

◆ isAppShare

- (BOOL) isAppShare
readwritenonatomicassign

Start meeting with screen sharing immediately enabled.

Definition at line 21 of file MobileRTCMeetingService.h.

◆ isAudioRawDataStereo

- (BOOL) isAudioRawDataStereo
readwritenonatomicassign

<Optional> Is audio raw data stereo? The default is mono.

Definition at line 62 of file MobileRTCMeetingService.h.

◆ isMyVoiceInMix

- (BOOL) isMyVoiceInMix
readwritenonatomicassign

<Optional> Is my voice in the mixed audio raw data?

Definition at line 52 of file MobileRTCMeetingService.h.

◆ meetingNumber

- (NSString*) meetingNumber
readwritenonatomicretain

Meeting number, in format like 123456789.

Definition at line 47 of file MobileRTCMeetingService.h.

◆ noAudio

- (BOOL) noAudio
readwritenonatomicassign

Start meeting with microphone disabled.

Definition at line 26 of file MobileRTCMeetingService.h.

◆ noVideo

- (BOOL) noVideo
readwritenonatomicassign

Start meeting with camera disabled.

Definition at line 31 of file MobileRTCMeetingService.h.

◆ vanityID

- (NSString*) vanityID
readwritenonatomicretain

Special ID for the personal link name in organization URL, like "yourcompany" in yourcompany.zoom.us.

Definition at line 42 of file MobileRTCMeetingService.h.