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

Provides settings for joining a meeting, such as start meeting with microphone or camera disabled. More...

#include <MobileRTCMeetingService.h>

Inherits NSObject.

Properties

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 the organization URL, like "yourcompany" in yourcompany.zoom.us.
 
NSString * meetingNumber
 Meeting number, in format like 123456789.
 
NSString * userName
 User name.
 
NSString * password
 Password.
 
NSString * webinarToken
 WebinarToken.
 
NSString * zak
 The user's Zoom Access Key (ZAK) token.
 
NSString * onBehalfToken
 On behalf token.
 
NSString * appPrivilegeToken
 Token that provides privileges when a user joins a meeting, for example, local recording permissions, streaming to raw, or archiving to raw.
 
NSString * join_token
 Token to join a meeting.
 
BOOL isMyVoiceInMix
 <Optional> Is my voice in the mixed audio raw data?
 
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.
 

Detailed Description

Provides settings for joining a meeting, such as start meeting with microphone or camera disabled.

Definition at line 106 of file MobileRTCMeetingService.h.

Property Documentation

◆ appPrivilegeToken

- (NSString*) appPrivilegeToken
readwritenonatomiccopy

Token that provides privileges when a user joins a meeting, for example, local recording permissions, streaming to raw, or archiving to raw.

Definition at line 156 of file MobileRTCMeetingService.h.

◆ audioRawSampleRate

- (MobileRTCAudioRawdataSamplingRate) audioRawSampleRate
readwritenonatomicassign

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

Definition at line 176 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 121 of file MobileRTCMeetingService.h.

◆ isAudioRawDataStereo

- (BOOL) isAudioRawDataStereo
readwritenonatomicassign

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

Definition at line 171 of file MobileRTCMeetingService.h.

◆ isMyVoiceInMix

- (BOOL) isMyVoiceInMix
readwritenonatomicassign

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

Definition at line 166 of file MobileRTCMeetingService.h.

◆ join_token

- (NSString*) join_token
readwritenonatomiccopy

Token to join a meeting.

Definition at line 161 of file MobileRTCMeetingService.h.

◆ meetingNumber

- (NSString*) meetingNumber
readwritenonatomiccopy

Meeting number, in format like 123456789.

Definition at line 129 of file MobileRTCMeetingService.h.

◆ noAudio

- (BOOL) noAudio
readwritenonatomicassign

Start meeting with microphone disabled.

Definition at line 110 of file MobileRTCMeetingService.h.

◆ noVideo

- (BOOL) noVideo
readwritenonatomicassign

Start meeting with camera disabled.

Definition at line 115 of file MobileRTCMeetingService.h.

◆ onBehalfToken

- (NSString*) onBehalfToken
readwritenonatomiccopy

On behalf token.

Definition at line 151 of file MobileRTCMeetingService.h.

◆ password

- (NSString*) password
readwritenonatomiccopy

Password.

Definition at line 137 of file MobileRTCMeetingService.h.

◆ userName

- (NSString*) userName
readwritenonatomiccopy

User name.

Definition at line 133 of file MobileRTCMeetingService.h.

◆ vanityID

- (NSString*) vanityID
readwritenonatomiccopy

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

Definition at line 125 of file MobileRTCMeetingService.h.

◆ webinarToken

- (NSString*) webinarToken
readwritenonatomiccopy

WebinarToken.

Definition at line 141 of file MobileRTCMeetingService.h.

◆ zak

- (NSString*) zak
readwritenonatomiccopy

The user's Zoom Access Key (ZAK) token.

Definition at line 146 of file MobileRTCMeetingService.h.