Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
<ZoomSDKWaitingRoomDelegate> Protocol Reference

Protocol for receiving events related to the waiting room. More...

#include <ZoomSDKWaitingRoomController.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - onUserJoinWaitingRoom:
 Callback of that user joins waiting room.
 
(void) - onUserLeftWaitingRoom:
 Callback of that user leaves waiting room.
 
(void) - onWaitingRoomPresetAudioStatusChanged:
 During the waiting room, this callback event triggers when host change audio status.
 
(void) - onWaitingRoomPresetVideoStatusChanged:
 During the waiting room, this callback event triggers when host change video status.
 
(void) - onCustomWaitingRoomDataUpdated:handle:
 Callback of that customize data info updated.
 
(void) - onWaitingRoomUserNameChanged:userName:
 Callback indicating that the name of a user in the waiting room has changed.
 
(void) - onWaitingRoomEntranceEnabled:
 This callback event triggers when host or cohost enables or disables waiting room entrance.
 

Detailed Description

Protocol for receiving events related to the waiting room.

Definition at line 126 of file ZoomSDKWaitingRoomController.h.

Method Documentation

◆ onCustomWaitingRoomDataUpdated:handle:

- (void) onCustomWaitingRoomDataUpdated: (ZoomSDKCustomWaitingRoomData *_Nullable) bData
handle: (ZoomSDKWaitingRoomDataDownloadHandler *_Nullable) handle 

Callback of that customize data info updated.

Parameters
bDataThe object of ZoomSDKCustomWaitingRoomData.
handleThe object of ZoomSDKWaitingRoomDataDownloadHandler to handle download failed.

◆ onUserJoinWaitingRoom:

- (void) onUserJoinWaitingRoom: (unsigned int) userid

Callback of that user joins waiting room.

Parameters
useridThe ID of user who joins waiting room.

◆ onUserLeftWaitingRoom:

- (void) onUserLeftWaitingRoom: (unsigned int) userid

Callback of that user leaves waiting room.

Parameters
useridThe ID of user who leaves waiting room.

◆ onWaitingRoomEntranceEnabled:

- (void) onWaitingRoomEntranceEnabled: (BOOL) enabled

This callback event triggers when host or cohost enables or disables waiting room entrance.

Parameters
enabledYES to enable waiting room entrance, NO to disable waiting room entrance.

◆ onWaitingRoomPresetAudioStatusChanged:

- (void) onWaitingRoomPresetAudioStatusChanged: (BOOL) audioCanTurnOn

During the waiting room, this callback event triggers when host change audio status.

Parameters
audioCanTurnOnYES if audio can be turned on, NO otherwise.

◆ onWaitingRoomPresetVideoStatusChanged:

- (void) onWaitingRoomPresetVideoStatusChanged: (BOOL) videoCanTurnOn

During the waiting room, this callback event triggers when host change video status.

Parameters
videoCanTurnOnYES if video can be turned on, NO otherwise.

◆ onWaitingRoomUserNameChanged:userName:

- (void) onWaitingRoomUserNameChanged: (unsigned int) userID
userName: (NSString *) userName 

Callback indicating that the name of a user in the waiting room has changed.

Parameters
userIDThe user's ID whose user name has changed.
userNameThe new user name.