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:
	Sets to enable or disable waiting room.
(NSArray *_Nullable)	- getWaitRoomUserList
	Gets the list of users in the waiting room.
(ZoomSDKUserInfo *_Nullable)	- getWaitingRoomUserInfo:
	Gets 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
	Determines 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
	Gets the audio pre-set mute or unmute status in waiting room.
(BOOL)	- isVideoEnabledInWaitingRoom
	Determines 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
	Gets the video pre-set mute or unmute status in waiting room.
(ZoomSDKError)	- requestCustomWaitingRoomData
	Gets the WaitingRoom CustomizeData information in the waiting room.
(BOOL)	- canRenameUser
	Determines if the host or cohost can rename users in the waiting room.
(ZoomSDKError)	- renameUser:newUserName:
	Change a screen name of the user in the waiting room.
(BOOL)	- canExpelUser
	Determines if a host or cohost can expel users in the waiting room.
(ZoomSDKError)	- expelUser:
	Removes a specified user from the waiting room.

Protected Attributes
id< ZoomSDKWaitingRoomDelegate >	_delegate

Properties
id< ZoomSDKWaitingRoomDelegate >	delegate
	Sets 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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

canExpelUser

- (BOOL) canExpelUser

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

Returns

YES if that a host or cohost can expel users in the waiting room. Otherwise, NO.

canRenameUser

- (BOOL) canRenameUser

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

Returns

YES if the host or cohost can rename users in the waiting room. Otherwise, NO.

enableWaitingRoomOnEntry:

- (ZoomSDKError) enableWaitingRoomOnEntry:

(BOOL)

enable

Sets to enable or disable waiting room.

Parameters

enable

YES if enabled, NO otherwise.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

expelUser:

- (ZoomSDKError) expelUser:

(unsigned int)

userID

Removes a specified user from the waiting room.

Parameters

userID

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

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

getWaitingRoomUserInfo:

- (ZoomSDKUserInfo *_Nullable) getWaitingRoomUserInfo:

(unsigned int)

userid

Gets 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 returns the object of ZoomSDKUserInfo for the specified user. Otherwise, this function fails and returns nil.

getWaitRoomUserList

- (NSArray *_Nullable) getWaitRoomUserList

Gets the list of users in the waiting room.

Returns

If the function succeeds, it returns a NSArray. Otherwise, this function fails and returns nil.

isAudioEnabledInWaitingRoom

- (BOOL) isAudioEnabledInWaitingRoom

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

Returns

YES if enable to turn on. Otherwise, NO.

isEnableWaitingRoomOnEntry

- (BOOL) isEnableWaitingRoomOnEntry

Query if waiting room is enabled in current meeting.

Returns

YES if enabled. Otherwise, NO.

isPresetAudioUnmuteInWaitingRoom

- (BOOL) isPresetAudioUnmuteInWaitingRoom

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

Returns

YES if pre-set unmute. Otherwise, NO.

Warning

Only worked out of meeting.

isPresetVideoUnmuteInWaitingRoom

- (BOOL) isPresetVideoUnmuteInWaitingRoom

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

Returns

YES if pre-set unmute. Otherwise, NO.

Warning

Only worked out of meeting.

isSupportWaitingRoom

- (BOOL) isSupportWaitingRoom

Query if the meeting supports waiting room.

Returns

YES if supported. Otherwise, NO.

isVideoEnabledInWaitingRoom

- (BOOL) isVideoEnabledInWaitingRoom

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

Returns

YES if enable to turn on. Otherwise, NO.

isWaitingRoomOnEntryLocked

- (BOOL) isWaitingRoomOnEntryLocked

Query if ZoomSDKWaitingRoomController::enableWaitingRoomOnEntry: feature locked.

Returns

YES if enabled. Otherwise, NO.

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, this function returns an error.

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, this function returns an error.

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 or co-host.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

renameUser:newUserName:

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

Change a screen name of the user 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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

requestCustomWaitingRoomData

- (ZoomSDKError) requestCustomWaitingRoomData

Gets the WaitingRoom CustomizeData information in the waiting room.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Field Documentation

_delegate

- (id<ZoomSDKWaitingRoomDelegate>) _delegate

protected

Definition at line 178 of file ZoomSDKWaitingRoomController.h.

Property Documentation

delegate

- (id<ZoomSDKWaitingRoomDelegate>) delegate

readwritenonatomicassign

Sets the delegate to receive waiting room events.

Definition at line 183 of file ZoomSDKWaitingRoomController.h.