Zoom Meeting Waiting Room
- Description:
- Zoom Meeting Waiting Room
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomUserJoin |
function | Callback event of notification that user joins the waiting room. |
onWaitingRoomUserLeft |
function | Callback event of notification that user leaves the waiting room. |
onWaitingRoomPresetAudioStatusChanged |
function | During the waiting room, this callback event will be triggered when host change audio status. |
onWaitingRoomPresetVideoStatusChanged |
function | During the waiting room, this callback event will be triggered when host change video status. |
onCustomWaitingRoomDataUpdated |
function | During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called. |
onWaitingRoomUserNameChanged |
function | Callback indicating that the name of a user in the waiting room has changed. |
onWaitingRoomEntranceEnabled |
function | This callback event will be triggered when host or cohost enables or disables waiting room entrance. |
Returns:
- Type
- ZoomMeetingWaitingRoom
- Description:
- Zoom Meeting Waiting Room
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomUserJoin |
function | Callback event of notification that user joins the waiting room. |
onWaitingRoomUserLeft |
function | Callback event of notification that user leaves the waiting room. |
onWaitingRoomPresetAudioStatusChanged |
function | During the waiting room, this callback event will be triggered when host change audio status. |
onWaitingRoomPresetVideoStatusChanged |
function | During the waiting room, this callback event will be triggered when host change video status. |
onCustomWaitingRoomDataUpdated |
function | During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called. |
onWaitingRoomUserNameChanged |
function | Callback indicating that the name of a user in the waiting room has changed. |
onWaitingRoomEntranceEnabled |
function | This callback event will be triggered when host or cohost enables or disables waiting room entrance. |
Returns:
- Type
- ZoomMeetingWaitingRoom
Methods
(inner) AdmitAllToMeeting() → {Number}
- Description:
- Permit all of the users currently in the waiting room to join the meeting.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) AdmitAllToMeeting() → {Number}
- Description:
- Permit all of the users currently in the waiting room to join the meeting.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) AdmitToMeeting(userid) → {Number}
- Description:
- Permit the specified user to join the meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
Number | Specifies the user ID. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) AdmitToMeeting(userid) → {Number}
- Description:
- Permit the specified user to join the meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
Number | Specifies the user ID. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) CanExpelUser() → {Boolean}
- Description:
- Determine if a host or cohost can expel user(s) in the waiting room.
- Source:
Returns:
True means that a host or cohost can expel user(s) in the waiting room. Otherwise they may not
- Type
- Boolean
(inner) CanExpelUser() → {Boolean}
- Description:
- Determine if a host or cohost can expel user(s) in the waiting room.
- Source:
Returns:
True means that a host or cohost can expel user(s) in the waiting room. Otherwise they may not
- Type
- Boolean
(inner) CanRenameUser() → {Boolean}
- Description:
- Determine if the host or cohost can rename users in the waiting room.
- Source:
Returns:
True means the host or cohost can rename users in the waiting room. Otherwise they can't.
- Type
- Boolean
(inner) CanRenameUser() → {Boolean}
- Description:
- Determine if the host or cohost can rename users in the waiting room.
- Source:
Returns:
True means the host or cohost can rename users in the waiting room. Otherwise they can't.
- Type
- Boolean
(inner) EnableWaitingRoomOnEntry(bEnable) → {Number}
- Description:
- Set to enable the attendee to enter the waiting room when joining the meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Number | True indicates to enable to enter. False not. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) EnableWaitingRoomOnEntry(bEnable) → {Number}
- Description:
- Set to enable the attendee to enter the waiting room when joining the meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Number | True indicates to enable to enter. False not. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) ExpelUser(userid) → {Number}
- Description:
- Remove a specified user from the waiting room.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
Number | The ID of the user removed from the waiting room by a host or cohost. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) ExpelUser(userid) → {Number}
- Description:
- Remove a specified user from the waiting room.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
Number | The ID of the user removed from the waiting room by a host or cohost. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) GetWaitingRoomList() → {Array}
- Description:
- Get the list of attendees who are in the waiting room.
- Source:
Returns:
If the function succeeds, the return value is the list of attendees. Otherwise failed, the return is null.
- Type
- Array
(inner) GetWaitingRoomList() → {Array}
- Description:
- Get the list of attendees who are in the waiting room.
- Source:
Returns:
If the function succeeds, the return value is the list of attendees. Otherwise failed, the return is null.
- Type
- Array
(inner) GetWaitingRoomUserInfoByID(userid) → {Object}
- Description:
- Get the attendee information in the waiting room via user ID.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
Number | Specifies the user ID. |
Returns:
If the function succeeds, the return value is an object with the following IUserInfo properties:
- userName: The username matched with the current user information.
- isHost: Whether the member corresponding with the current information is the host or not.
- userID: The user ID matched with the current user information.
- avatarPath: The avatar file path matched with the current user information.
- persistentId: The user persistent id matched with the current user information.
- customerKey: The customer_key matched with the current user information.
- isVideoOn: Whether the video status of the user specified by the current information is turned on.
- isAudioMuted: Whether the audio status of the user specified by the current information is muted.
- audioJoinType: The type of audio when the user joins the meeting.
- isMySelf: Whether the current information corresponds to the user himself or not.
- isInWaitingRoom: Whether the user specified by the current information is in the waiting room or not.
- isRaiseHand: Whether the user specified by the current information raises hand or not.
- userRole: The type of role of the user specified by the current information.
- isPurePhoneUser: Whether the user corresponding to the current information joins the meeting by telephone or not.
- audioVoiceLevel: The mic level of the user corresponding to the current information.
- isClosedCaptionSender: Whether the user corresponding to the current information is the sender of Closed Caption or not.
- isTalking: Whether the user specified by the current information is talking or not.
- isH323User: Whether the user specified by the current information is H323 user or not.
- webinarAttendeeStatus: The webinar status of the user specified by the current information.
- isInterpreter: Whether the user specified by the current information is a interpreter or not, otherwise not.
- isSignLanguageInterpreter: Whether the user specified by the current information is a sign language interpreter or not, otherwise false.
- interpreterActiveLanguage: The active language, if the user is a interpreter.
- emojiFeedbackType: The emoji feedback type of the user.
- isCompanionModeUser: Whether the user specified by the current information in companion mode or not.
- localRecordingStatus: The status of the local recording status.
- isRawLiveStreaming: Whether the user has started a raw live stream, otherwise false.
- hasRawLiveStreamPrivilege: Whether the user has raw live stream privilege, otherwise false.
- Type
- Object
(inner) GetWaitingRoomUserInfoByID(userid) → {Object}
- Description:
- Get the attendee information in the waiting room via user ID.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
Number | Specifies the user ID. |
Returns:
If the function succeeds, the return value is an object with the following IUserInfo properties:
- userName: The username matched with the current user information.
- isHost: Whether the member corresponding with the current information is the host or not.
- userID: The user ID matched with the current user information.
- avatarPath: The avatar file path matched with the current user information.
- persistentId: The user persistent id matched with the current user information.
- customerKey: The customer_key matched with the current user information.
- isVideoOn: Whether the video status of the user specified by the current information is turned on.
- isAudioMuted: Whether the audio status of the user specified by the current information is muted.
- audioJoinType: The type of audio when the user joins the meeting.
- isMySelf: Whether the current information corresponds to the user himself or not.
- isInWaitingRoom: Whether the user specified by the current information is in the waiting room or not.
- isRaiseHand: Whether the user specified by the current information raises hand or not.
- userRole: The type of role of the user specified by the current information.
- isPurePhoneUser: Whether the user corresponding to the current information joins the meeting by telephone or not.
- audioVoiceLevel: The mic level of the user corresponding to the current information.
- isClosedCaptionSender: Whether the user corresponding to the current information is the sender of Closed Caption or not.
- isTalking: Whether the user specified by the current information is talking or not.
- isH323User: Whether the user specified by the current information is H323 user or not.
- webinarAttendeeStatus: The webinar status of the user specified by the current information.
- isInterpreter: Whether the user specified by the current information is a interpreter or not, otherwise not.
- isSignLanguageInterpreter: Whether the user specified by the current information is a sign language interpreter or not, otherwise false.
- interpreterActiveLanguage: The active language, if the user is a interpreter.
- emojiFeedbackType: The emoji feedback type of the user.
- isCompanionModeUser: Whether the user specified by the current information in companion mode or not.
- localRecordingStatus: The status of the local recording status.
- isRawLiveStreaming: Whether the user has started a raw live stream, otherwise false.
- hasRawLiveStreamPrivilege: Whether the user has raw live stream privilege, otherwise false.
- Type
- Object
(inner) Ignore() → {Number}
- Description:
- Ignore to Download the WaitingRoom CustomizeData information in the waiting room.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Ignore() → {Number}
- Description:
- Ignore to Download the WaitingRoom CustomizeData information in the waiting room.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) IsAudioEnabledInWaitingRoom() → {Boolean}
- Description:
- Determine if the attendee is enabled to turn on audio when joining the meeting.
- Source:
Returns:
True indicates to enable to turn on.
- Type
- Boolean
(inner) IsAudioEnabledInWaitingRoom() → {Boolean}
- Description:
- Determine if the attendee is enabled to turn on audio when joining the meeting.
- Source:
Returns:
True indicates to enable to turn on.
- Type
- Boolean
(inner) IsSupportWaitingRoom() → {Boolean}
- Description:
- Determine whether the current meeting supports the waiting room or not.
- Source:
Returns:
True indicates to support.
- Type
- Boolean
(inner) IsSupportWaitingRoom() → {Boolean}
- Description:
- Determine whether the current meeting supports the waiting room or not.
- Source:
Returns:
True indicates to support.
- Type
- Boolean
(inner) IsVideoEnabledInWaitingRoom() → {Boolean}
- Description:
- Determine if the attendee is enabled to turn on video when joining the meeting.
- Source:
Returns:
True indicates to enable to turn on.
- Type
- Boolean
(inner) IsVideoEnabledInWaitingRoom() → {Boolean}
- Description:
- Determine if the attendee is enabled to turn on video when joining the meeting.
- Source:
Returns:
True indicates to enable to turn on.
- Type
- Boolean
(inner) IsWaitingRoomOnEntryFlagOn() → {Boolean}
- Description:
- Determine if the attendee is enabled to enter the waiting room when joining the meeting.
- Source:
Returns:
True indicates to enable to enter.
- Type
- Boolean
(inner) IsWaitingRoomOnEntryFlagOn() → {Boolean}
- Description:
- Determine if the attendee is enabled to enter the waiting room when joining the meeting.
- Source:
Returns:
True indicates to enable to enter.
- Type
- Boolean
(inner) PutInWaitingRoom(userid) → {Number}
- Description:
- Enable the specified user to enter the waiting room.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
Number | Specifies the user ID. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) PutInWaitingRoom(userid) → {Number}
- Description:
- Enable the specified user to enter the waiting room.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
Number | Specifies the user ID. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) RenameUser(userid, newName) → {Number}
- Description:
- Change a user's screen name in the waiting room.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
Number | The ID of users put into the waiting room by a host or cohost. |
newName |
String | The new user name. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) RenameUser(userid, newName) → {Number}
- Description:
- Change a user's screen name in the waiting room.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
Number | The ID of users put into the waiting room by a host or cohost. |
newName |
String | The new user name. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) RequestCustomWaitingRoomData() → {Number}
- Description:
- Get the WaitingRoom CustomizeData information in the waiting room.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) RequestCustomWaitingRoomData() → {Number}
- Description:
- Get the WaitingRoom CustomizeData information in the waiting room.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Retry() → {Number}
- Description:
- Retry to Download the WaitingRoom CustomizeData information in the waiting room.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Retry() → {Number}
- Description:
- Retry to Download the WaitingRoom CustomizeData information in the waiting room.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetOnCustomWaitingRoomDataUpdatedCB(onCustomWaitingRoomDataUpdated) → {Boolean}
- Description:
- Set onCustomWaitingRoomDataUpdated callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onCustomWaitingRoomDataUpdated |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnCustomWaitingRoomDataUpdatedCB(onCustomWaitingRoomDataUpdated) → {Boolean}
- Description:
- Set onCustomWaitingRoomDataUpdated callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onCustomWaitingRoomDataUpdated |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomEntranceEnabledCB(onWaitingRoomEntranceEnabled) → {Boolean}
- Description:
- Set onWaitingRoomEntranceEnabled callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomEntranceEnabled |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomEntranceEnabledCB(onWaitingRoomEntranceEnabled) → {Boolean}
- Description:
- Set onWaitingRoomEntranceEnabled callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomEntranceEnabled |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomPresetAudioStatusChangedCB(onWaitingRoomPresetAudioStatusChanged) → {Boolean}
- Description:
- Set onWaitingRoomPresetAudioStatusChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomPresetAudioStatusChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomPresetAudioStatusChangedCB(onWaitingRoomPresetAudioStatusChanged) → {Boolean}
- Description:
- Set onWaitingRoomPresetAudioStatusChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomPresetAudioStatusChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomPresetVideoStatusChangedCB(onWaitingRoomPresetVideoStatusChanged) → {Boolean}
- Description:
- Set onWaitingRoomPresetVideoStatusChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomPresetVideoStatusChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomPresetVideoStatusChangedCB(onWaitingRoomPresetVideoStatusChanged) → {Boolean}
- Description:
- Set onWaitingRoomPresetVideoStatusChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomPresetVideoStatusChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomUserJoinCB(onWaitingRoomUserJoin) → {Boolean}
- Description:
- Set onWaitingRoomUserJoin callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomUserJoin |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomUserJoinCB(onWaitingRoomUserJoin) → {Boolean}
- Description:
- Set onWaitingRoomUserJoin callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomUserJoin |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomUserLeftCB(onWaitingRoomUserLeft) → {Boolean}
- Description:
- Set onWaitingRoomUserLeft callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomUserLeft |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomUserLeftCB(onWaitingRoomUserLeft) → {Boolean}
- Description:
- Set onWaitingRoomUserLeft callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomUserLeft |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomUserNameChangedCB(onWaitingRoomUserNameChanged) → {Boolean}
- Description:
- Set onWaitingRoomUserNameChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomUserNameChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnWaitingRoomUserNameChangedCB(onWaitingRoomUserNameChanged) → {Boolean}
- Description:
- Set onWaitingRoomUserNameChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onWaitingRoomUserNameChanged |
function |
Returns:
true or false
- Type
- Boolean
Events
onCustomWaitingRoomDataUpdated
- Description:
- During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bData |
Object | The WaitingRoom Customize Data Info with the following properties: - title - description - logo_path - video_path - image_path - type: 0: Default; 1: Logo; 2: Video - status: 0: Init; 1: Downloading; 2: Download_OK; 3: Download_Failed - page_color - text_color - button_color |
onCustomWaitingRoomDataUpdated
- Description:
- During the waiting room, this callback event will be triggered when RequestCustomWaitingRoomData called.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bData |
Object | The WaitingRoom Customize Data Info with the following properties: - title - description - logo_path - video_path - image_path - type: 0: Default; 1: Logo; 2: Video - status: 0: Init; 1: Downloading; 2: Download_OK; 3: Download_Failed - page_color - text_color - button_color |
onWaitingRoomEntranceEnabled
- Description:
- This callback event will be triggered when host or cohost enables or disables waiting room entrance.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bIsEnabled |
Boolean | True enables waiting room entrance, false means disables waiting room entrance. |
onWaitingRoomEntranceEnabled
- Description:
- This callback event will be triggered when host or cohost enables or disables waiting room entrance.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bIsEnabled |
Boolean | True enables waiting room entrance, false means disables waiting room entrance. |
onWaitingRoomPresetAudioStatusChanged
- Description:
- During the waiting room, this callback event will be triggered when host change audio status.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bAudioCanTurnOn |
Boolean | TRUE means audio can be turned on. Otherwise not. |
onWaitingRoomPresetAudioStatusChanged
- Description:
- During the waiting room, this callback event will be triggered when host change audio status.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bAudioCanTurnOn |
Boolean | TRUE means audio can be turned on. Otherwise not. |
onWaitingRoomPresetVideoStatusChanged
- Description:
- During the waiting room, this callback event will be triggered when host change video status.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bVideoCanTurnOn |
Boolean | TRUE means video can be turned on. Otherwise not. |
onWaitingRoomPresetVideoStatusChanged
- Description:
- During the waiting room, this callback event will be triggered when host change video status.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bVideoCanTurnOn |
Boolean | TRUE means video can be turned on. Otherwise not. |
onWaitingRoomUserJoin
- Description:
- Callback event of notification that user joins the waiting room.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
Number | The ID of user who joins the waiting room. |
onWaitingRoomUserJoin
- Description:
- Callback event of notification that user joins the waiting room.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
Number | The ID of user who joins the waiting room. |
onWaitingRoomUserLeft
- Description:
- Callback event of notification that user leaves the waiting room.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
Number | The ID of user who leaves the waiting room. |
onWaitingRoomUserLeft
- Description:
- Callback event of notification that user leaves the waiting room.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
Number | The ID of user who leaves the waiting room. |
onWaitingRoomUserNameChanged
- Description:
- Callback indicating that the name of a user in the waiting room has changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
Number | The ID of the user whose user name have has changed. |
userName |
String | The new user name. |
onWaitingRoomUserNameChanged
- Description:
- Callback indicating that the name of a user in the waiting room has changed.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
userID |
Number | The ID of the user whose user name have has changed. |
userName |
String | The new user name. |