Zoom Meeting Participants Ctrl
- Description:
- Zoom Meeting Participants Ctrl
- Source:
Parameters:
| Name |
Type |
Description |
meetinguserjoincb |
function
|
Callback event of notification of users who are in the meeting. |
meetinguserleftcb |
function
|
Callback event of notification of user who leaves the meeting. |
meetinghostchangecb |
function
|
Callback event of notification of the new host. |
onAllowParticipantsRequestCloudRecording |
function
|
Callback event that lets participants request that the host starts cloud recording. |
onBotAuthorizerRelationChanged |
function
|
Callback event that the bot relationship changed in the meeting. |
Returns:
-
Type
-
ZoomMeetingParticipantsCtrl
- Description:
- Zoom Meeting Participants Ctrl
- Source:
Parameters:
| Name |
Type |
Description |
meetinguserjoincb |
function
|
Callback event of notification of users who are in the meeting. |
meetinguserleftcb |
function
|
Callback event of notification of user who leaves the meeting. |
meetinghostchangecb |
function
|
Callback event of notification of the new host. |
onAllowParticipantsRequestCloudRecording |
function
|
Callback event that lets participants request that the host starts cloud recording. |
onBotAuthorizerRelationChanged |
function
|
Callback event that the bot relationship changed in the meeting. |
Returns:
-
Type
-
ZoomMeetingParticipantsCtrl
Methods
(inner) AllowParticipantsToRequestCloudRecording(bAllow) → {Number}
- Description:
- Toggle whether attendees can requests for the host to start a cloud recording. This can only be used in regular meetings and webinar(no breakout rooms).
- Source:
Parameters:
| Name |
Type |
Description |
bAllow |
Boolean
|
TRUE indicates that participants are allowed to send cloud recording privilege requests. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
-
Type
-
Number
(inner) AllowParticipantsToRequestCloudRecording(bAllow) → {Number}
- Description:
- Toggle whether attendees can requests for the host to start a cloud recording. This can only be used in regular meetings and webinar(no breakout rooms).
- Source:
Parameters:
| Name |
Type |
Description |
bAllow |
Boolean
|
TRUE indicates that participants are allowed to send cloud recording privilege requests. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
-
Type
-
Number
(inner) CanEnableParticipantRequestCloudRecording() → {Boolean}
- Description:
- Determine if the current user can enable participant request cloud recording.
- Source:
Returns:
True means the current user can enable participant request cloud recording.
-
Type
-
Boolean
(inner) CanEnableParticipantRequestCloudRecording() → {Boolean}
- Description:
- Determine if the current user can enable participant request cloud recording.
- Source:
Returns:
True means the current user can enable participant request cloud recording.
-
Type
-
Boolean
(inner) GetAuthorizedBotListByUserID(userid) → {Array}
- Description:
- Get the authorizer's bot list.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specify the user ID for which to get the information. |
Returns:
If the function succeeds, the return value is the authorizer's bot list in the meeting. Otherwise the function fails and the return value is an empty list.
-
Type
-
Array
(inner) GetAuthorizedBotListByUserID(userid) → {Array}
- Description:
- Get the authorizer's bot list.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specify the user ID for which to get the information. |
Returns:
If the function succeeds, the return value is the authorizer's bot list in the meeting. Otherwise the function fails and the return value is an empty list.
-
Type
-
Array
(inner) GetBotAuthorizedUserInfoByUserID(userid) → {Object}
- Description:
- Get the information about the bot's authorized user.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specify the user ID for which to get the information. |
Returns:
If the function succeeds, the return value is an object which includes the user's information with the following properties:
- userName: The username matched with the current user information
- isHost: Whether the member corresponding with the current information is the host
- 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 is turned on
- isAudioMuted: Whether the audio status of the user is muted
- audioJoinType: The type of audio when the user joins the meeting
- isMySelf: Whether the current information corresponds to the user himself
- isInWaitingRoom: Whether the user is in the waiting room
- isRaiseHand: Whether the user raises hand
- userRole: The type of role of the user
- isPurePhoneUser: Whether the user joins the meeting by telephone
- audioVoiceLevel: The mic level of the user
- isClosedCaptionSender: Whether the user is the sender of Closed Caption
- isTalking: Whether the user is talking
- isH323User: Whether the user is H323 user
- webinarAttendeeStatus: The webinar status of the user
- isInterpreter: Whether the user is a interpreter (Windows only)
- isSignLanguageInterpreter: Whether the user is a sign language interpreter (Windows only)
- interpreterActiveLanguage: The active language if the user is a interpreter (Windows only)
- emojiFeedbackType: The emoji feedback type of the user (Windows only)
- isCompanionModeUser: Whether the user is in companion mode (Windows only)
- localRecordingStatus: The status of the local recording status
- isRawLiveStreaming: Whether the user has started a raw live stream
- hasRawLiveStreamPrivilege: Whether the user has raw live stream privilege
- hasCamera: Whether the participant has a camera
- isProductionStudioUser: Whether the user is production studio user
- isInWebinarBackstage: Whether the user is in the webinar backstage
- productionStudioParent: The parent user ID of the production studio user
- isBotUser: Whether the user is bot user
- botAppName: The bot app name
- isVirtualNameTagEnabled: Whether the participant enabled virtual name tag
- virtualNameTagList: The list of user's virtual name tag roster info
-
Type
-
Object
(inner) GetBotAuthorizedUserInfoByUserID(userid) → {Object}
- Description:
- Get the information about the bot's authorized user.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specify the user ID for which to get the information. |
Returns:
If the function succeeds, the return value is an object which includes the user's information with the following properties:
- userName: The username matched with the current user information
- isHost: Whether the member corresponding with the current information is the host
- 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 is turned on
- isAudioMuted: Whether the audio status of the user is muted
- audioJoinType: The type of audio when the user joins the meeting
- isMySelf: Whether the current information corresponds to the user himself
- isInWaitingRoom: Whether the user is in the waiting room
- isRaiseHand: Whether the user raises hand
- userRole: The type of role of the user
- isPurePhoneUser: Whether the user joins the meeting by telephone
- audioVoiceLevel: The mic level of the user
- isClosedCaptionSender: Whether the user is the sender of Closed Caption
- isTalking: Whether the user is talking
- isH323User: Whether the user is H323 user
- webinarAttendeeStatus: The webinar status of the user
- isInterpreter: Whether the user is a interpreter (Windows only)
- isSignLanguageInterpreter: Whether the user is a sign language interpreter (Windows only)
- interpreterActiveLanguage: The active language if the user is a interpreter (Windows only)
- emojiFeedbackType: The emoji feedback type of the user (Windows only)
- isCompanionModeUser: Whether the user is in companion mode (Windows only)
- localRecordingStatus: The status of the local recording status
- isRawLiveStreaming: Whether the user has started a raw live stream
- hasRawLiveStreamPrivilege: Whether the user has raw live stream privilege
- hasCamera: Whether the participant has a camera
- isProductionStudioUser: Whether the user is production studio user
- isInWebinarBackstage: Whether the user is in the webinar backstage
- productionStudioParent: The parent user ID of the production studio user
- isBotUser: Whether the user is bot user
- botAppName: The bot app name
- isVirtualNameTagEnabled: Whether the participant enabled virtual name tag
- virtualNameTagList: The list of user's virtual name tag roster info
-
Type
-
Object
(inner) GetParticipantsList() → {Array}
- Description:
- Get the list of all the panelists in the meeting.
- Source:
Returns:
If the function succeeds, the return value is the list of the panelists in the meeting. Otherwise the function fails and the return value is null.
-
Type
-
Array
(inner) GetParticipantsList() → {Array}
- Description:
- Get the list of all the panelists in the meeting.
- Source:
Returns:
If the function succeeds, the return value is the list of the panelists in the meeting. Otherwise the function fails and the return value is null.
-
Type
-
Array
(inner) GetUserInfoByUserID(userid) → {Object}
- Description:
- Get the information of specified user.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specify the user ID for which you want to get the information. Zero(0) indicates to get the information of the current user. |
Returns:
If the function succeeds, the return value is an object which includes the user's information with the following properties:
- userName: The username matched with the current user information
- isHost: Whether the member corresponding with the current information is the host
- 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 is turned on
- isAudioMuted: Whether the audio status of the user is muted
- audioJoinType: The type of audio when the user joins the meeting
- isMySelf: Whether the current information corresponds to the user himself
- isInWaitingRoom: Whether the user is in the waiting room
- isRaiseHand: Whether the user raises hand
- userRole: The type of role of the user
- isPurePhoneUser: Whether the user joins the meeting by telephone
- audioVoiceLevel: The mic level of the user
- isClosedCaptionSender: Whether the user is the sender of Closed Caption
- isTalking: Whether the user is talking
- isH323User: Whether the user is H323 user
- webinarAttendeeStatus: The webinar status of the user
- isInterpreter: Whether the user is a interpreter (Windows only)
- isSignLanguageInterpreter: Whether the user is a sign language interpreter (Windows only)
- interpreterActiveLanguage: The active language if the user is a interpreter (Windows only)
- emojiFeedbackType: The emoji feedback type of the user (Windows only)
- isCompanionModeUser: Whether the user is in companion mode (Windows only)
- localRecordingStatus: The status of the local recording status
- isRawLiveStreaming: Whether the user has started a raw live stream
- hasRawLiveStreamPrivilege: Whether the user has raw live stream privilege
- hasCamera: Whether the participant has a camera
- isProductionStudioUser: Whether the user is production studio user
- isInWebinarBackstage: Whether the user is in the webinar backstage
- productionStudioParent: The parent user ID of the production studio user
- isBotUser: Whether the user is bot user
- botAppName: The bot app name
- isVirtualNameTagEnabled: Whether the participant enabled virtual name tag
- virtualNameTagList: The list of user's virtual name tag roster info
-
Type
-
Object
(inner) GetUserInfoByUserID(userid) → {Object}
- Description:
- Get the information of specified user.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specify the user ID for which you want to get the information. Zero(0) indicates to get the information of the current user. |
Returns:
If the function succeeds, the return value is an object which includes the user's information with the following properties:
- userName: The username matched with the current user information
- isHost: Whether the member corresponding with the current information is the host
- 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 is turned on
- isAudioMuted: Whether the audio status of the user is muted
- audioJoinType: The type of audio when the user joins the meeting
- isMySelf: Whether the current information corresponds to the user himself
- isInWaitingRoom: Whether the user is in the waiting room
- isRaiseHand: Whether the user raises hand
- userRole: The type of role of the user
- isPurePhoneUser: Whether the user joins the meeting by telephone
- audioVoiceLevel: The mic level of the user
- isClosedCaptionSender: Whether the user is the sender of Closed Caption
- isTalking: Whether the user is talking
- isH323User: Whether the user is H323 user
- webinarAttendeeStatus: The webinar status of the user
- isInterpreter: Whether the user is a interpreter (Windows only)
- isSignLanguageInterpreter: Whether the user is a sign language interpreter (Windows only)
- interpreterActiveLanguage: The active language if the user is a interpreter (Windows only)
- emojiFeedbackType: The emoji feedback type of the user (Windows only)
- isCompanionModeUser: Whether the user is in companion mode (Windows only)
- localRecordingStatus: The status of the local recording status
- isRawLiveStreaming: Whether the user has started a raw live stream
- hasRawLiveStreamPrivilege: Whether the user has raw live stream privilege
- hasCamera: Whether the participant has a camera
- isProductionStudioUser: Whether the user is production studio user
- isInWebinarBackstage: Whether the user is in the webinar backstage
- productionStudioParent: The parent user ID of the production studio user
- isBotUser: Whether the user is bot user
- botAppName: The bot app name
- isVirtualNameTagEnabled: Whether the participant enabled virtual name tag
- virtualNameTagList: The list of user's virtual name tag roster info
-
Type
-
Object
(inner) IsParticipantRequestCloudRecordingAllowed() → {Boolean}
- Description:
- Check whether the current meeting allows participants to send cloud recording privilege request, This can only be used in regular meetings and webinar(no breakout rooms).
- Source:
Returns:
If allows participants to send request, the return value is true.
-
Type
-
Boolean
(inner) IsParticipantRequestCloudRecordingAllowed() → {Boolean}
- Description:
- Check whether the current meeting allows participants to send cloud recording privilege request, This can only be used in regular meetings and webinar(no breakout rooms).
- Source:
Returns:
If allows participants to send request, the return value is true.
-
Type
-
Boolean
(inner) SetMeetingHostChangeCB(meetinghostchangecb) → {Boolean}
- Description:
- Set meetinghostchangecb callback.
- Source:
Parameters:
| Name |
Type |
Description |
meetinghostchangecb |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetMeetingHostChangeCB(meetinghostchangecb) → {Boolean}
- Description:
- Set meetinghostchangecb callback.
- Source:
Parameters:
| Name |
Type |
Description |
meetinghostchangecb |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetMeetingUserJoinCB(meetinguserjoincb) → {Boolean}
- Description:
- Set meetinguserjoincb callback.
- Source:
Parameters:
| Name |
Type |
Description |
meetinguserjoincb |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetMeetingUserJoinCB(meetinguserjoincb) → {Boolean}
- Description:
- Set meetinguserjoincb callback.
- Source:
Parameters:
| Name |
Type |
Description |
meetinguserjoincb |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetMeetingUserLeftCB(meetinguserleftcb) → {Boolean}
- Description:
- Set meetinguserleftcb callback.
- Source:
Parameters:
| Name |
Type |
Description |
meetinguserleftcb |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetMeetingUserLeftCB(meetinguserleftcb) → {Boolean}
- Description:
- Set meetinguserleftcb callback.
- Source:
Parameters:
| Name |
Type |
Description |
meetinguserleftcb |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnAllowParticipantsRequestCloudRecordingCB(onAllowParticipantsRequestCloudRecording) → {Boolean}
- Description:
- Set onAllowParticipantsRequestCloudRecording callback.
- Source:
Parameters:
| Name |
Type |
Description |
onAllowParticipantsRequestCloudRecording |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnAllowParticipantsRequestCloudRecordingCB(onAllowParticipantsRequestCloudRecording) → {Boolean}
- Description:
- Set onAllowParticipantsRequestCloudRecording callback.
- Source:
Parameters:
| Name |
Type |
Description |
onAllowParticipantsRequestCloudRecording |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnBotAuthorizerRelationChangedCB(onBotAuthorizerRelationChanged) → {Boolean}
- Description:
- Set onBotAuthorizerRelationChanged callback.
- Source:
Parameters:
| Name |
Type |
Description |
onBotAuthorizerRelationChanged |
function
|
|
Returns:
true or false
-
Type
-
Boolean
(inner) SetOnBotAuthorizerRelationChangedCB(onBotAuthorizerRelationChanged) → {Boolean}
- Description:
- Set onBotAuthorizerRelationChanged callback.
- Source:
Parameters:
| Name |
Type |
Description |
onBotAuthorizerRelationChanged |
function
|
|
Returns:
true or false
-
Type
-
Boolean
Events
onAllowParticipantsRequestCloudRecording
- Description:
- Callback event that lets participants request that the host starts cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
bAllow |
Boolean
|
True allow. If false, disallow. |
onAllowParticipantsRequestCloudRecording
- Description:
- Callback event that lets participants request that the host starts cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
bAllow |
Boolean
|
True allow. If false, disallow. |
onBotAuthorizerRelationChanged
- Description:
- Callback event that the bot relationship changed in the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
authorizeUserID |
Number
|
Specify the authorizer user ID. |
onBotAuthorizerRelationChanged
- Description:
- Callback event that the bot relationship changed in the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
authorizeUserID |
Number
|
Specify the authorizer user ID. |
onHostChangeNotification
- Description:
- Callback event of notification of the new host.
- Source:
Parameters:
| Name |
Type |
Description |
userId |
Number
|
Specify the ID of the new host. |
onHostChangeNotification
- Description:
- Callback event of notification of the new host.
- Source:
Parameters:
| Name |
Type |
Description |
userId |
Number
|
Specify the ID of the new host. |
onUserJoin
- Description:
- Callback event of notification of users who are in the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
lstUserID |
Array
|
List of user IDs. |
strUserList |
String
|
List of users in JSON format. This function is currently invalid, hereby only for reservations. |
onUserJoin
- Description:
- Callback event of notification of users who are in the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
lstUserID |
Array
|
List of user IDs. |
strUserList |
String
|
List of users in JSON format. This function is currently invalid, hereby only for reservations. |
onUserLeft
- Description:
- Callback event of notification of user who leaves the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
lstUserID |
Array
|
List of the user ID who leaves the meeting. |
strUserList |
String
|
List of the users in JSON format. This function is currently invalid, hereby only for reservations. |
onUserLeft
- Description:
- Callback event of notification of user who leaves the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
lstUserID |
Array
|
List of the user ID who leaves the meeting. |
strUserList |
String
|
List of the users in JSON format. This function is currently invalid, hereby only for reservations. |