Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
Instance Methods | Properties | List of all members
MobileRTCWaitingRoomService Class Reference

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

#include <MobileRTCWaitingRoomService.h>

Inherits NSObject.

Instance Methods

(BOOL) - isSupportWaitingRoom
 Is this meeting support Waiting Room feature.
 
(BOOL) - isWaitingRoomOnEntryFlagOn
 Is this meeting enabled Waiting Room feature.
 
(BOOL) - isWaitingRoomOnEntryLocked
 Query if enableWaitingRoomOnEntry feature locked.
 
(MobileRTCMeetError) - enableWaitingRoomOnEntry:
 Enable or disable waiting room feature of this meeting.
 
(nullable NSArray< NSNumber * > *) - waitingRoomList
 Get the waiting room user id list.
 
(nullable MobileRTCMeetingUserInfo *) - waitingRoomUserInfoByID:
 Get the user detail information in waiting room.
 
(MobileRTCSDKError) - admitToMeeting:
 Admit the user go to meeting fram waiting room.
 
(MobileRTCSDKError) - admitAllToMeeting
 Permit all of the users currently in the waiting room to join the meeting.
 
(MobileRTCSDKError) - putInWaitingRoom:
 Put the user to waiting room from meeting.
 
(BOOL) - isAudioEnabledInWaitingRoom
 Determine if the attendee is enabled to turn on audio when joining the meeting.
 
(BOOL) - isVideoEnabledInWaitingRoom
 Determine if the attendee is enabled to turn on video when joining the meeting.
 
(MobileRTCSDKError) - presetAudioInWaitingRoom:
 Pre-set audio mute or unmute status in waiting room.
 
(BOOL) - isPresetAudioUnmuteInWaitingRoom
 Get the audio pre-set mute or unmute status in the waiting room.
 
(MobileRTCSDKError) - presetVideoInWaitingRoom:
 Pre-set video mute or unmute status in waiting room.
 
(BOOL) - isPresetVideoUnmuteInWaitingRoom
 Get the video pre-set mute or unmute status in the waiting room.
 
(MobileRTCSDKError) - requestCustomWaitingRoomData
 Get the WaitingRoom CustomizeData information in the waiting room.
 
(BOOL) - canRenameUser
 Determine if host or cohost is enabled to rename user in the waiting room.
 
(MobileRTCSDKError) - renameUser:newUserName:
 Change user's screen name in the waiting room.
 
(BOOL) - canExpelUser
 Determine if host or cohost is enabled to expel user in the waiting room.
 
(MobileRTCSDKError) - expelUser:
 Remove the specified user from 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 109 of file MobileRTCWaitingRoomService.h.

Method Documentation

◆ admitAllToMeeting

- (MobileRTCSDKError) admitAllToMeeting

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

Returns
If the function succeeds, the return value is MobileRTCSDKError_Success, otherwise failed, the return is error. For more details, see [MobileRTCSDKError] enum.

◆ admitToMeeting:

- (MobileRTCSDKError) admitToMeeting: (NSUInteger) userId

Admit the user go to meeting fram waiting room.

Returns
The result of this operation.
Warning
Only meeting host/co-host can run the function.

◆ canExpelUser

- (BOOL) canExpelUser

Determine if host or cohost is enabled to expel user in the waiting room.

Returns
YES indicates can expel user.

◆ canRenameUser

- (BOOL) canRenameUser

Determine if host or cohost is enabled to rename user in the waiting room.

Returns
YES indicates to enable to turn on.

◆ enableWaitingRoomOnEntry:

- (MobileRTCMeetError) enableWaitingRoomOnEntry: (BOOL) bEnable

Enable or disable waiting room feature of this meeting.

Returns
The result of this operation.

◆ expelUser:

- (MobileRTCSDKError) expelUser: (NSInteger) userID

Remove the specified user from waiting room.

Parameters
userIDThe ID of user who is put into waiting room by host/co-host.
Returns
If the function succeeds, it will return MobileRTCSDKError_Success. Otherwise failed.

◆ isAudioEnabledInWaitingRoom

- (BOOL) isAudioEnabledInWaitingRoom

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

Returns
YES indicates to enable to turn on.

◆ isPresetAudioUnmuteInWaitingRoom

- (BOOL) isPresetAudioUnmuteInWaitingRoom

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

Returns
YES means pre-set unmute, NO means pre-set mute.
Warning
Only worked in waiting room.

◆ isPresetVideoUnmuteInWaitingRoom

- (BOOL) isPresetVideoUnmuteInWaitingRoom

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

Returns
YES means pre-set unmute, NO means pre-set mute.
Warning
Only worked in waiting room.

◆ isSupportWaitingRoom

- (BOOL) isSupportWaitingRoom

Is this meeting support Waiting Room feature.

Returns
Yes if support waiting room.

◆ isVideoEnabledInWaitingRoom

- (BOOL) isVideoEnabledInWaitingRoom

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

Returns
YES indicates to enable to turn on.

◆ isWaitingRoomOnEntryFlagOn

- (BOOL) isWaitingRoomOnEntryFlagOn

Is this meeting enabled Waiting Room feature.

Returns
Yes if enabled.

◆ isWaitingRoomOnEntryLocked

- (BOOL) isWaitingRoomOnEntryLocked

Query if enableWaitingRoomOnEntry feature locked.

Returns
YES means enabled. NO not.

◆ presetAudioInWaitingRoom:

- (MobileRTCSDKError) presetAudioInWaitingRoom: (BOOL) muteAudio

Pre-set audio mute or unmute status in waiting room.

Parameters
muteAudioPre-set audio mute or unmute status.
Returns
MobileRTCSDKError_Success means the pre-set success, otherwise failed.
Warning
Only worked in waiting room.

◆ presetVideoInWaitingRoom:

- (MobileRTCSDKError) presetVideoInWaitingRoom: (BOOL) muteVideo

Pre-set video mute or unmute status in waiting room.

Parameters
muteVideoPre-set video mute or unmute status.
Returns
MobileRTCSDKError_Success means the pre-set succeeded, otherwise it failed.
Warning
Only worked in waiting room.

◆ putInWaitingRoom:

- (MobileRTCSDKError) putInWaitingRoom: (NSUInteger) userId

Put the user to waiting room from meeting.

Returns
The result of this operation.
Warning
Only meeting host/co-host can run the function.

◆ renameUser:newUserName:

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

Change user's screen name in the waiting room.

Parameters
userIDTnto waiting room byhe ID of user who is put i host/co-host.
userNameThe new user name.
Returns
If the function succeeds, it will return MobileRTCSDKError_Success. Otherwise failed.

◆ requestCustomWaitingRoomData

- (MobileRTCSDKError) requestCustomWaitingRoomData

Get the WaitingRoom CustomizeData information in the waiting room.

Returns
If the function succeeds, the return value is MobileRTCSDKError_Success. Otherwise failed. To get extended error information, see [MobileRTCSDKError].

◆ waitingRoomList

- (nullable NSArray< NSNumber * > *) waitingRoomList

Get the waiting room user id list.

Returns
Waiting room user list.

◆ waitingRoomUserInfoByID:

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

Get the user detail information in waiting room.

Returns
Waiting room user information.

Property Documentation

◆ delegate

- (id<MobileRTCWaitingRoomServiceDelegate> _Nullable) delegate
readwritenonatomicweak

Waiting Room service delegate.

Definition at line 114 of file MobileRTCWaitingRoomService.h.