MobileRTCMeetingStartParam Class Reference

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

#include <MobileRTCMeetingService.h>

Inherits NSObject.

Inherited by MobileRTCMeetingStartParam4LoginlUser, and MobileRTCMeetingStartParam4WithoutLoginUser.

Properties
BOOL	isAppShare
	YES to start meeting with screen sharing immediately enabled. Otherwise, NO.
BOOL	noAudio
	YES to start meeting with microphone disabled. Otherwise, NO.
BOOL	noVideo
	YES to start meeting with camera disabled. Otherwise, NO.
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
	The invitation ID for automatic meeting invitation.
BOOL	isAudioRawDataStereo
	<Optional> Is audio raw data stereo? The default is mono.
MobileRTCAudioRawdataSamplingRate	audioRawSampleRate
	<Optional> The sampling rate of the acquired raw audio data, The default is MobileRTCAudioRawdataSamplingRate_32K.
MobileRTCVideoRawdataColorspace	videoRawdataColorspace
	<Optional> The colorspace of video rawdata. The default is VideoRawdataColorspace_BT601_L.

Detailed Description

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

Definition at line 15 of file MobileRTCMeetingService.h.

Property Documentation

audioRawSampleRate

- (MobileRTCAudioRawdataSamplingRate) audioRawSampleRate

readwritenonatomicassign

<Optional> The sampling rate of the acquired raw audio data, The default is MobileRTCAudioRawdataSamplingRate_32K.

Definition at line 65 of file MobileRTCMeetingService.h.

customerKey

- (NSString*) customerKey

readwritenonatomiccopy

Developer-specified string to track end user.

Note

Provided in webhook event, not used internally by SDK.

Definition at line 35 of file MobileRTCMeetingService.h.

inviteContactID

- (NSString*) inviteContactID

readwritenonatomiccopy

The invitation ID for automatic meeting invitation.

Definition at line 55 of file MobileRTCMeetingService.h.

isAppShare

- (BOOL) isAppShare

readwritenonatomicassign

YES to start meeting with screen sharing immediately enabled. Otherwise, NO.

Definition at line 19 of file MobileRTCMeetingService.h.

isAudioRawDataStereo

- (BOOL) isAudioRawDataStereo

readwritenonatomicassign

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

Definition at line 60 of file MobileRTCMeetingService.h.

isMyVoiceInMix

- (BOOL) isMyVoiceInMix

readwritenonatomicassign

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

Definition at line 50 of file MobileRTCMeetingService.h.

meetingNumber

- (NSString*) meetingNumber

readwritenonatomiccopy

Meeting number, in format like 123456789.

Definition at line 45 of file MobileRTCMeetingService.h.

noAudio

- (BOOL) noAudio

readwritenonatomicassign

YES to start meeting with microphone disabled. Otherwise, NO.

Definition at line 24 of file MobileRTCMeetingService.h.

noVideo

- (BOOL) noVideo

readwritenonatomicassign

YES to start meeting with camera disabled. Otherwise, NO.

Definition at line 29 of file MobileRTCMeetingService.h.

vanityID

- (NSString*) vanityID

readwritenonatomiccopy

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

Definition at line 40 of file MobileRTCMeetingService.h.

videoRawdataColorspace

- (MobileRTCVideoRawdataColorspace) videoRawdataColorspace

readwritenonatomicassign

<Optional> The colorspace of video rawdata. The default is VideoRawdataColorspace_BT601_L.

Definition at line 70 of file MobileRTCMeetingService.h.