ZoomSDKWaitingRoomController Class Reference

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

#include <ZoomSDKWaitingRoomController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportWaitingRoom
	Query if the meeting supports waiting room.
(BOOL)	- isWaitingRoomOnEntryLocked
	Query if ZoomSDKWaitingRoomController::enableWaitingRoomOnEntry: feature locked.
(BOOL)	- isEnableWaitingRoomOnEntry
	Query if waiting room is enabled in current meeting.
(ZoomSDKError)	- enableWaitingRoomOnEntry:
	Set to enable/disable waiting room.
(NSArray *_Nullable)	- getWaitRoomUserList
	Get the list of users in the waiting room.
(ZoomSDKUserInfo *_Nullable)	- getWaitingRoomUserInfo:
	Get the information of users in the waiting room.
(ZoomSDKError)	- admitToMeeting:
	Admit user to join meeting.
(ZoomSDKError)	- admitAllToMeeting
	Permit all of the users currently in the waiting room to join the meeting.
(ZoomSDKError)	- putIntoWaitingRoom:
	Put user into waiting room.
(BOOL)	- isAudioEnabledInWaitingRoom
	Determine if the attendee is enabled to turn on audio when joining the meeting.
(ZoomSDKError)	- presetAudioInWaitingRoom:
	Pre-set audio mute or unmute status in waiting room.
(BOOL)	- isPresetAudioUnmuteInWaitingRoom
	Get the audio pre-set mute or unmute status in waiting room.
(BOOL)	- isVideoEnabledInWaitingRoom
	Determine if the attendee is enabled to turn on video when joining the meeting.
(ZoomSDKError)	- presetVideoInWaitingRoom:
	Pre-set video mute or unmute status in waiting room.
(BOOL)	- isPresetVideoUnmuteInWaitingRoom
	Get the video pre-set mute or unmute status in waiting room.
(ZoomSDKError)	- requestCustomWaitingRoomData
	Get the WaitingRoom CustomizeData information in the waiting room.
(BOOL)	- canRenameUser
	Determine if the host or cohost can rename users in the waiting room.
(ZoomSDKError)	- renameUser:newUserName:
	Change a user's screen name in the waiting room.
(BOOL)	- canExpelUser
	Determine if a host or cohost can expel users in the waiting room.
(ZoomSDKError)	- expelUser:
	Remove a specified user from the waiting room.

Protected Attributes
id< ZoomSDKWaitingRoomDelegate >	_delegate

Properties
id< ZoomSDKWaitingRoomDelegate >	delegate
	Set the delegate to receive waiting room events.

Detailed Description

Interface for managing the waiting room during a meeting.

Definition at line 176 of file ZoomSDKWaitingRoomController.h.

Method Documentation

admitAllToMeeting

- (ZoomSDKError) admitAllToMeeting

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

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

admitToMeeting:

- (ZoomSDKError) admitToMeeting:

(unsigned int)

userid

Admit user to join meeting.

Parameters

userid

The ID of user who joins meeting.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

canExpelUser

- (BOOL) canExpelUser

Determine if a host or cohost can expel users in the waiting room.

Returns

YES means that a host or cohost can expel users in the waiting room. Otherwise they may not.

canRenameUser

- (BOOL) canRenameUser

Determine if the host or cohost can rename users in the waiting room.

Returns

YES means the host or cohost can rename users in the waiting room. Otherwise they can’t.

enableWaitingRoomOnEntry:

- (ZoomSDKError) enableWaitingRoomOnEntry:

(BOOL)

enable

Set to enable/disable waiting room.

Parameters

enable

YES means enabled, NO disabled.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

expelUser:

- (ZoomSDKError) expelUser:

(unsigned int)

userID

Remove a specified user from the waiting room.

Parameters

userID

The ID of the user removed from the waiting room by a host or cohost.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

getWaitingRoomUserInfo:

- (ZoomSDKUserInfo *_Nullable) getWaitingRoomUserInfo:

(unsigned int)

userid

Get the information of users in the waiting room.

Parameters

userid

The ID of user who is in the waiting room.

Returns

If the function succeeds, it will return the object of ZoomSDKUserInfo for the specified user.

getWaitRoomUserList

- (NSArray *_Nullable) getWaitRoomUserList

Get the list of users in the waiting room.

Returns

If the function succeeds, it will return a NSArray.

isAudioEnabledInWaitingRoom

- (BOOL) isAudioEnabledInWaitingRoom

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

Returns

True indicates to enable to turn on.

isEnableWaitingRoomOnEntry

- (BOOL) isEnableWaitingRoomOnEntry

Query if waiting room is enabled in current meeting.

Returns

YES means enabled, otherwise not.

isPresetAudioUnmuteInWaitingRoom

- (BOOL) isPresetAudioUnmuteInWaitingRoom

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

Returns

YES means pre-set unmute, NO means pre-set mute.

Warning

Only worked out of meeting.

isPresetVideoUnmuteInWaitingRoom

- (BOOL) isPresetVideoUnmuteInWaitingRoom

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

Returns

YES means pre-set unmute, NO means pre-set mute.

Warning

Only worked out of meeting.

isSupportWaitingRoom

- (BOOL) isSupportWaitingRoom

Query if the meeting supports waiting room.

Returns

YES means supported, otherwise not.

isVideoEnabledInWaitingRoom

- (BOOL) isVideoEnabledInWaitingRoom

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

Returns

True indicates to enable to turn on.

isWaitingRoomOnEntryLocked

- (BOOL) isWaitingRoomOnEntryLocked

Query if ZoomSDKWaitingRoomController::enableWaitingRoomOnEntry: feature locked.

Returns

YES means enabled, otherwise not.

presetAudioInWaitingRoom:

- (ZoomSDKError) presetAudioInWaitingRoom:

(BOOL)

muteAudio

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

Parameters

muteAudio

Pre-set audio mute or unmute status.

Returns

ZoomSDKError_Success means the pre-set success, otherwise failed.

Warning

Only worked out of meeting.

presetVideoInWaitingRoom:

- (ZoomSDKError) presetVideoInWaitingRoom:

(BOOL)

muteVideo

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

Parameters

muteVideo

Pre-set video mute or unmute status.

Returns

ZoomSDKError_Success means the pre-set succeeded, otherwise failed.

Warning

Only worked out of meeting.

putIntoWaitingRoom:

- (ZoomSDKError) putIntoWaitingRoom:

(unsigned int)

userid

Put user into waiting room.

Parameters

userid

The ID of user who is put into waiting room by host/co-host.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

renameUser:newUserName:

- (ZoomSDKError) renameUser:		(unsigned int)	userID
newUserName:		(NSString *)	userName

Change a user's screen name in the waiting room.

Parameters

userID	The ID of users put into the waiting room by a host or cohost.
userName	The new user name.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

requestCustomWaitingRoomData

- (ZoomSDKError) requestCustomWaitingRoomData

Get the WaitingRoom CustomizeData information in the waiting room.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

Field Documentation

_delegate

- (id<ZoomSDKWaitingRoomDelegate>) _delegate

protected

Definition at line 178 of file ZoomSDKWaitingRoomController.h.

Property Documentation

delegate

- (id<ZoomSDKWaitingRoomDelegate>) delegate

readwritenonatomicassign

Set the delegate to receive waiting room events.

Definition at line 183 of file ZoomSDKWaitingRoomController.h.