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 meeetings 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 the function fails. To get extended error information, Defined in:
ZoomSDKError
-
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 meeetings 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 the function fails. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) CanEnableParticipantRequestCloudRecording() → {Boolean}
- Description:
- Determine if the current user can enable participant request clould recording.
- Source:
Returns:
True means the current user can enable participant request clould recording.
-
Type
-
Boolean
(inner) CanEnableParticipantRequestCloudRecording() → {Boolean}
- Description:
- Determine if the current user can enable participant request clould recording.
- Source:
Returns:
True means the current user can enable participant request clould 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 failed, 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 failed, 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 succeed, the return value is an object which includes the user's infomation.
Otherwise failed, the return value is an empty object.
-
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 succeed, the return value is an object which includes the user's infomation.
Otherwise failed, the return value is an empty object.
-
Type
-
Object
(inner) GetParticipantsList() → {Array}
- Description:
- Get the list of all the panelists in the meeting.
- Source:
Returns:
If the function succeed, the return value is the list of the panelists in the meeting.
Otherwise failed, 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 succeed, the return value is the list of the panelists in the meeting.
Otherwise failed, 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 succeed, the return value is an object which includes the user's infomation.
Otherwise failed, the return value is an empty object.
-
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 succeed, the return value is an object which includes the user's infomation.
Otherwise failed, the return value is an empty object.
-
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 meeetings 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 meeetings and webinar(no breakout rooms).
- Source:
Returns:
If allows participants to send request, the return value is true.
-
Type
-
Boolean
(inner) SetMeetingHostChangeCB(onHostChangeNotification) → {Boolean}
- Description:
- Set callback function of notification of the new host.
- Source:
Parameters:
| Name |
Type |
Description |
onHostChangeNotification |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetMeetingHostChangeCB(onHostChangeNotification) → {Boolean}
- Description:
- Set callback function of notification of the new host.
- Source:
Parameters:
| Name |
Type |
Description |
onHostChangeNotification |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetMeetingUserJoinCB(meetinguserjoincb) → {Boolean}
- Description:
- Set callback function of notification of users who are in the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
meetinguserjoincb |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetMeetingUserJoinCB(meetinguserjoincb) → {Boolean}
- Description:
- Set callback function of notification of users who are in the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
meetinguserjoincb |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetMeetingUserLeftCB(meetinguserleftcb) → {Boolean}
- Description:
- Set callback function of notification of users who leave the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
meetinguserleftcb |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetMeetingUserLeftCB(meetinguserleftcb) → {Boolean}
- Description:
- Set callback function of notification of users who leave the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
meetinguserleftcb |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnAllowParticipantsRequestCloudRecordingCB(onAllowParticipantsRequestCloudRecording) → {Boolean}
- Description:
- Set callback event that lets participants request host to start cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
onAllowParticipantsRequestCloudRecording |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnAllowParticipantsRequestCloudRecordingCB(onAllowParticipantsRequestCloudRecording) → {Boolean}
- Description:
- Set callback event that lets participants request host to start cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
onAllowParticipantsRequestCloudRecording |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnBotAuthorizerRelationChangedCB(onBotAuthorizerRelationChanged) → {Boolean}
- Description:
- Set callback event that the bot relationship changed in the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
onBotAuthorizerRelationChanged |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetOnBotAuthorizerRelationChangedCB(onBotAuthorizerRelationChanged) → {Boolean}
- Description:
- Set callback event that the bot relationship changed in the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
onBotAuthorizerRelationChanged |
function
|
|
Returns:
-
Type
-
Boolean
Events
meetinghostchangecb
- Description:
- Callback event of notification of the new host.
- Source:
Parameters:
| Name |
Type |
Description |
userId |
Number
|
Specify the ID of the new host. |
meetinghostchangecb
- Description:
- Callback event of notification of the new host.
- Source:
Parameters:
| Name |
Type |
Description |
userId |
Number
|
Specify the ID of the new host. |
meetinguserjoincb
- Description:
- Callback event of notification of users who are in the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
lstUserID |
String
|
List of the user ID. |
strUserList |
Array
|
List of user in json format. This function is currently invalid, hereby only for reservations. |
meetinguserjoincb
- Description:
- Callback event of notification of users who are in the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
lstUserID |
String
|
List of the user ID. |
strUserList |
Array
|
List of user in json format. This function is currently invalid, hereby only for reservations. |
meetinguserleftcb
- Description:
- Callback event of notification of user who leaves the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
lstUserID |
String
|
List of the user ID who leaves the meeting. |
strUserList |
Array
|
List of the user in json format. This function is currently invalid, hereby only for reservations. |
meetinguserleftcb
- Description:
- Callback event of notification of user who leaves the meeting.
- Source:
Parameters:
| Name |
Type |
Description |
lstUserID |
String
|
List of the user ID who leaves the meeting. |
strUserList |
Array
|
List of the user in json format. This function is currently invalid, hereby only for reservations. |
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. |