Interface for managing the waiting room during a meeting. More...

#include <MobileRTCWaitingRoomService.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportWaitingRoom
	Determines if this meeting supports Waiting Room feature.
(BOOL)	- isWaitingRoomOnEntryFlagOn
	Determines if this meeting has Waiting Room feature enabled.
(BOOL)	- isWaitingRoomOnEntryLocked
	Queries if enableWaitingRoomOnEntry feature is locked.
(MobileRTCMeetError)	- enableWaitingRoomOnEntry:
	Enables or disables waiting room feature of this meeting.
(nullable NSArray< NSNumber * > *)	- waitingRoomList
	Gets the waiting room user ID list.
(nullable MobileRTCMeetingUserInfo *)	- waitingRoomUserInfoByID:
	Gets the user detail information in the waiting room.
(MobileRTCSDKError)	- admitToMeeting:
	Admits the user to go to the meeting from the waiting room.
(MobileRTCSDKError)	- admitAllToMeeting
	Permits all of the users currently in the waiting room to join the meeting.
(MobileRTCSDKError)	- putInWaitingRoom:
	Puts the user to the waiting room from the meeting.
(BOOL)	- isAudioEnabledInWaitingRoom
	Determines if the attendee is enabled to turn on audio when joining the meeting.
(BOOL)	- isVideoEnabledInWaitingRoom
	Determines if the attendee is enabled to turn on video when joining the meeting.
(MobileRTCSDKError)	- presetAudioInWaitingRoom:
	Pre-sets audio mute or unmute status in the waiting room.
(BOOL)	- isPresetAudioUnmuteInWaitingRoom
	Gets the audio pre-set mute or unmute status in the waiting room.
(MobileRTCSDKError)	- presetVideoInWaitingRoom:
	Pre-sets video mute or unmute status in the waiting room.
(BOOL)	- isPresetVideoUnmuteInWaitingRoom
	Gets the video pre-set mute or unmute status in the waiting room.
(MobileRTCSDKError)	- requestCustomWaitingRoomData
	Gets the WaitingRoom CustomizeData information in the waiting room.
(BOOL)	- canRenameUser
	Determines if host or co-host is enabled to rename user in the waiting room.
(MobileRTCSDKError)	- renameUser:newUserName:
	Changes the user's screen name in the waiting room.
(BOOL)	- canExpelUser
	Determines if host or co-host is enabled to expel user in the waiting room.
(MobileRTCSDKError)	- expelUser:
	Removes the specified user from the waiting room.

Properties
id< MobileRTCWaitingRoomServiceDelegate > _Nullable	delegate
	Waiting Room service delegate.

Detailed Description

Interface for managing the waiting room during a meeting.

Definition at line 108 of file MobileRTCWaitingRoomService.h.

Method Documentation

◆ admitAllToMeeting

- (MobileRTCSDKError) admitAllToMeeting

Permits all of the users currently in the waiting room to join the meeting.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

References admitAllToMeeting.

Referenced by admitAllToMeeting.

◆ admitToMeeting:

- (MobileRTCSDKError) admitToMeeting: (NSUInteger) userId

Admits the user to go to the meeting from the waiting room.

Parameters

userId The user ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: Only meeting host or co-host can run the function.

◆ canExpelUser

- (BOOL) canExpelUser

Determines if host or co-host is enabled to expel user in the waiting room.

Returns: YES if can expel user. Otherwise, NO.

References canExpelUser.

Referenced by canExpelUser.

◆ canRenameUser

- (BOOL) canRenameUser

Determines if host or co-host is enabled to rename user in the waiting room.

Returns: YES if enabled. Otherwise, NO.

References canRenameUser.

Referenced by canRenameUser.

◆ enableWaitingRoomOnEntry:

- (MobileRTCMeetError) enableWaitingRoomOnEntry: (BOOL) bEnable

Enables or disables waiting room feature of this meeting.

Parameters

bEnable YES to enable. Otherwise, NO to disable.

Returns: The result of this operation.

◆ expelUser:

- (MobileRTCSDKError) expelUser: (NSInteger) userID

Removes the specified user from the waiting room.

Parameters

userID The user ID who is put into waiting room by host or co-host.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

◆ isAudioEnabledInWaitingRoom

- (BOOL) isAudioEnabledInWaitingRoom

Determines if the attendee is enabled to turn on audio when joining the meeting.

Returns: YES if enabled to turn on. Otherwise, NO.

References isAudioEnabledInWaitingRoom.

Referenced by isAudioEnabledInWaitingRoom.

◆ isPresetAudioUnmuteInWaitingRoom

- (BOOL) isPresetAudioUnmuteInWaitingRoom

Gets the audio pre-set mute or unmute status in the waiting room.

Returns: YES if pre-set unmute. Otherwise, NO if pre-set mute.

Warning: Only works in waiting room.

References isPresetAudioUnmuteInWaitingRoom.

Referenced by isPresetAudioUnmuteInWaitingRoom.

◆ isPresetVideoUnmuteInWaitingRoom

- (BOOL) isPresetVideoUnmuteInWaitingRoom

Gets the video pre-set mute or unmute status in the waiting room.

Returns: YES if pre-set unmute. Otherwise, NO if pre-set mute.

Warning: Only works in waiting room.

References isPresetVideoUnmuteInWaitingRoom.

Referenced by isPresetVideoUnmuteInWaitingRoom.

◆ isSupportWaitingRoom

- (BOOL) isSupportWaitingRoom

Determines if this meeting supports Waiting Room feature.

Returns: YES if supports waiting room. Otherwise, NO.

References isSupportWaitingRoom.

Referenced by isSupportWaitingRoom.

◆ isVideoEnabledInWaitingRoom

- (BOOL) isVideoEnabledInWaitingRoom

Determines if the attendee is enabled to turn on video when joining the meeting.

Returns: YES if enabled to turn on. Otherwise, NO.

References isVideoEnabledInWaitingRoom.

Referenced by isVideoEnabledInWaitingRoom.

◆ isWaitingRoomOnEntryFlagOn

- (BOOL) isWaitingRoomOnEntryFlagOn

Determines if this meeting has Waiting Room feature enabled.

Returns: YES if enabled. Otherwise, NO.

References isWaitingRoomOnEntryFlagOn.

Referenced by isWaitingRoomOnEntryFlagOn.

◆ isWaitingRoomOnEntryLocked

- (BOOL) isWaitingRoomOnEntryLocked

Queries if enableWaitingRoomOnEntry feature is locked.

Returns: YES if enabled. Otherwise, NO.

References isWaitingRoomOnEntryLocked.

Referenced by isWaitingRoomOnEntryLocked.

◆ presetAudioInWaitingRoom:

- (MobileRTCSDKError) presetAudioInWaitingRoom: (BOOL) muteAudio

Pre-sets audio mute or unmute status in the waiting room.

Parameters

muteAudio YES to pre-set audio mute. Otherwise, NO to pre-set unmute.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: Only works in waiting room.

◆ presetVideoInWaitingRoom:

- (MobileRTCSDKError) presetVideoInWaitingRoom: (BOOL) muteVideo

Pre-sets video mute or unmute status in the waiting room.

Parameters

muteVideo YES to pre-set video mute. Otherwise, NO to pre-set unmute.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: Only works in waiting room.

◆ putInWaitingRoom:

- (MobileRTCSDKError) putInWaitingRoom: (NSUInteger) userId

Puts the user to the waiting room from the meeting.

Parameters

userId The user ID.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

Warning: Only meeting host or co-host can run the function.

◆ renameUser:newUserName:

- (MobileRTCSDKError) renameUser:		(NSInteger)	userID
newUserName:		(nonnull NSString *)	userName

Changes the user's screen name in the waiting room.

Parameters

userID	The user ID who is put into waiting room by host or co-host.
userName	The new user name.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

◆ requestCustomWaitingRoomData

- (MobileRTCSDKError) requestCustomWaitingRoomData

Gets the WaitingRoom CustomizeData information in the waiting room.

Returns: If the function succeeds, it returns MobileRTCSDKError_Success. Otherwise, this function returns an error.

References requestCustomWaitingRoomData.

Referenced by requestCustomWaitingRoomData.

◆ waitingRoomList

- (nullable NSArray< NSNumber * > *) waitingRoomList

Gets the waiting room user ID list.

Returns: Waiting room user list.

References waitingRoomList.

Referenced by waitingRoomList.

◆ waitingRoomUserInfoByID:

- (nullable MobileRTCMeetingUserInfo *) waitingRoomUserInfoByID: (NSUInteger) userId

Gets the user detail information in the waiting room.

Parameters

userId The user ID.

Returns: The waiting room user information.

Property Documentation

◆ delegate

- (id<MobileRTCWaitingRoomServiceDelegate> _Nullable) delegate

readwritenonatomicweak

Waiting Room service delegate.

Definition at line 113 of file MobileRTCWaitingRoomService.h.

Instance Methods

Properties

Detailed Description

Method Documentation

◆ admitAllToMeeting

◆ admitToMeeting:

◆ canExpelUser

◆ canRenameUser

◆ enableWaitingRoomOnEntry:

◆ expelUser:

◆ isAudioEnabledInWaitingRoom

◆ isPresetAudioUnmuteInWaitingRoom

◆ isPresetVideoUnmuteInWaitingRoom

◆ isSupportWaitingRoom

◆ isVideoEnabledInWaitingRoom

◆ isWaitingRoomOnEntryFlagOn

◆ isWaitingRoomOnEntryLocked

◆ presetAudioInWaitingRoom:

◆ presetVideoInWaitingRoom:

◆ putInWaitingRoom:

◆ renameUser:newUserName:

◆ requestCustomWaitingRoomData

◆ waitingRoomList

◆ waitingRoomUserInfoByID:

Property Documentation

◆ delegate