Zoom Meeting UI Ctrl
- Description:
- Zoom Meeting UI Ctrl
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onInvitebuttonclickedcb |
function | Callback event to click the INVITE button. |
onStartShareBtnClicked |
function | Callback event for clicking START SHARE button. |
onEndMeetingBtnClicked |
function | Callback event of clicking the END MEETING button. |
onParticipantListBtnClicked |
function | Callback event of clicking PRTICIPANT LIST button. |
onCustomLiveStreamMenuClicked |
function | Callback event of clicking CUSTOME LIVE STREAM menu. |
onZoomInviteDialogFailed |
function | Notification occurs only when the SDK fails to display the default Zoom INVITE dialog. |
onCCBTNClicked |
function | Callback event of clicking CC menu. |
onAudioBtnClicked |
function | Callback event for clicking Audio button in the meeting. |
onAudioMenuBtnClicked |
function | Callback event for clicking Audio Menu button in the meeting. |
Returns:
- Type
- ZoomMeetingUICtrl
- Description:
- Zoom Meeting UI Ctrl
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onInvitebuttonclickedcb |
function | Callback event to click the INVITE button. |
onStartShareBtnClicked |
function | Callback event for clicking START SHARE button. |
onEndMeetingBtnClicked |
function | Callback event of clicking the END MEETING button. |
onParticipantListBtnClicked |
function | Callback event of clicking PRTICIPANT LIST button. |
onCustomLiveStreamMenuClicked |
function | Callback event of clicking CUSTOME LIVE STREAM menu. |
onZoomInviteDialogFailed |
function | Notification occurs only when the SDK fails to display the default Zoom INVITE dialog. |
onCCBTNClicked |
function | Callback event of clicking CC menu. |
onAudioBtnClicked |
function | Callback event for clicking Audio button in the meeting. |
onAudioMenuBtnClicked |
function | Callback event for clicking Audio Menu button in the meeting. |
Returns:
- Type
- ZoomMeetingUICtrl
Methods
(inner) MeetingUI_BackToMeeting() → {Number}
- Description:
- Active the principal window of meeting and place it on top.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
If the function fails, the return value is not SDKERR_SUCCESS. To get extended error information, refer to SDKError enum.
- Type
- Number
(inner) MeetingUI_BackToMeeting() → {Number}
- Description:
- Active the principal window of meeting and place it on top.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
If the function fails, the return value is not SDKERR_SUCCESS. To get extended error information, refer to SDKError enum.
- Type
- Number
(inner) MeetingUI_CanSwapToShowShareViewOrVideo() → {Number}
- Description:
- Determine if the user can swap to show sharing screen or video now.
- Source:
Returns:
0 means Can, otherwise not
- Type
- Number
(inner) MeetingUI_CanSwapToShowShareViewOrVideo() → {Number}
- Description:
- Determine if the user can swap to show sharing screen or video now.
- Source:
Returns:
0 means Can, otherwise not
- Type
- Number
(inner) MeetingUI_ChangeFloatToActiveSpkVideoSize(floatvideotype) → {Number}
- Description:
- Change float active speaker window type and size
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
floatvideotype |
String | the type of float active speaker window, ZoomMeetingUIFloatVideoType |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ChangeFloatToActiveSpkVideoSize(floatvideotype) → {Number}
- Description:
- Change float active speaker window type and size
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
floatvideotype |
String | the type of float active speaker window, ZoomMeetingUIFloatVideoType |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_EnterFullScreen(viewtype:) → {Number}
- Description:
- Enter full screen display mode.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype: |
String | view type of the meeting ui, Defined in: ZoomMeetingUIViewType |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_EnterFullScreen(viewtype:) → {Number}
- Description:
- Enter full screen display mode.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype: |
String | view type of the meeting ui, Defined in: ZoomMeetingUIViewType |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ExitFullScreen(viewtype:) → {Number}
- Description:
- Exit the full screen display mode.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype: |
String | view type of the meeting ui, Defined in: ZoomMeetingUIViewType |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ExitFullScreen(viewtype:) → {Number}
- Description:
- Exit the full screen display mode.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
viewtype: |
String | view type of the meeting ui, Defined in: ZoomMeetingUIViewType |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_GetCurrentSplitScreenModeInfo() → {Number}
- Description:
- Get the information whether the current view supports split screen mode or not. If supports, check it if it is already in the split screen mode.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_GetCurrentSplitScreenModeInfo() → {Number}
- Description:
- Get the information whether the current view supports split screen mode or not. If supports, check it if it is already in the split screen mode.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_GetMeetingUIWnd() → {Number}
- Description:
- Get the window handle of the meeting user interface. This interface is only valid on Windows
- Source:
Returns:
If the function succeed, "hFirstView" the window handle(hex) of the meeting user interface displayed by the first view,
and "hSecondView" the window handle(hex) of the meeting user interface displayed by the second view
- Type
- Number
(inner) MeetingUI_GetMeetingUIWnd() → {Number}
- Description:
- Get the window handle of the meeting user interface. This interface is only valid on Windows
- Source:
Returns:
If the function succeed, "hFirstView" the window handle(hex) of the meeting user interface displayed by the first view,
and "hSecondView" the window handle(hex) of the meeting user interface displayed by the second view
- Type
- Number
(inner) MeetingUI_GetWallViewPageInfo(currentPage, totalPages) → {Number}
- Description:
- Get the information in video wall mode.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
currentPage |
String | |
totalPages |
String |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_GetWallViewPageInfo(currentPage, totalPages) → {Number}
- Description:
- Get the information in video wall mode.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
currentPage |
String | |
totalPages |
String |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_HideChatDlg() → {Number}
- Description:
- Hide the chat dialog during the meeting.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_HideChatDlg() → {Number}
- Description:
- Hide the chat dialog during the meeting.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_HideJoinAudioDlg() → {Number}
- Description:
- Hide the dialog to choose the audio to join the meeting.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_HideJoinAudioDlg() → {Number}
- Description:
- Hide the dialog to choose the audio to join the meeting.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_IsDisplayingShareViewOrVideo() → {Number}
- Description:
- Determine if the meeting is displaying the sharing screen now.
- Source:
Returns:
0 means is showing sharing screen, otherwise means is showing video
- Type
- Number
(inner) MeetingUI_IsDisplayingShareViewOrVideo() → {Number}
- Description:
- Determine if the meeting is displaying the sharing screen now.
- Source:
Returns:
0 means is showing sharing screen, otherwise means is showing video
- Type
- Number
(inner) MeetingUI_IsMinimizeModeOfFirstScreenMeetingUIWnd() → {Number}
- Description:
- Determines the minimize state of the first view.
- Source:
Returns:
If the function succeed, the return value is a object which includes "bIsMinimizMode", TRUE indicates the minimize state, FALSE not
- Type
- Number
(inner) MeetingUI_IsMinimizeModeOfFirstScreenMeetingUIWnd() → {Number}
- Description:
- Determines the minimize state of the first view.
- Source:
Returns:
If the function succeed, the return value is a object which includes "bIsMinimizMode", TRUE indicates the minimize state, FALSE not
- Type
- Number
(inner) MeetingUI_MoveFloatVideoWnd(left, top) → {Number}
- Description:
- Move the floating video window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
left |
String | Sets the left margin edge for the floating video window. Please use the coordinate of the screen. |
top |
String | Sets the top margin edge for the floating video window. Please use the coordinate of the screen. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_MoveFloatVideoWnd(left, top) → {Number}
- Description:
- Move the floating video window.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
left |
String | Sets the left margin edge for the floating video window. Please use the coordinate of the screen. |
top |
String | Sets the top margin edge for the floating video window. Please use the coordinate of the screen. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SetCustomizedCloudRecordingMgrUrl(crmURL) → {Number}
- Description:
- Set the cloud recording manage url in the recording setting page.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
crmURL |
String | Specify the cloud recording manage url in the recording setting page. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SetCustomizedCloudRecordingMgrUrl(crmURL) → {Number}
- Description:
- Set the cloud recording manage url in the recording setting page.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
crmURL |
String | Specify the cloud recording manage url in the recording setting page. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SetCustomizedInvitationDomain(invitationDomain) → {Number}
- Description:
- Set the customized invitation domain, this method can only be called after auth ready and before the join/start meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
invitationDomain |
Boolean | specify the customized invitation domain. eg: abc.com, http://abc.com, https://abc.com. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SetCustomizedInvitationDomain(invitationDomain) → {Number}
- Description:
- Set the customized invitation domain, this method can only be called after auth ready and before the join/start meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
invitationDomain |
Boolean | specify the customized invitation domain. eg: abc.com, http://abc.com, https://abc.com. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SetCustomizedPollingUrl(pollingURL, bCreate) → {Number}
- Description:
- Allowing the developer to customize the URL of create/edit the polling.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
pollingURL |
String | customized URL. |
bCreate |
Boolean | When bCreate is true, it changes the URL of creating a polling. Otherwise, it changes the URL of editing a polling. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SetCustomizedPollingUrl(pollingURL, bCreate) → {Number}
- Description:
- Allowing the developer to customize the URL of create/edit the polling.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
pollingURL |
String | customized URL. |
bCreate |
Boolean | When bCreate is true, it changes the URL of creating a polling. Otherwise, it changes the URL of editing a polling. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SetInviteButtonClickedCB(onInviteBtnClicked) → {Boolean}
- Description:
- Set on invite button clicked callback function.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onInviteBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetInviteButtonClickedCB(onInviteBtnClicked) → {Boolean}
- Description:
- Set on invite button clicked callback function.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onInviteBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetMeetingTopic(meetingTopic) → {Number}
- Description:
- Set the meeting topic in the meeting information page.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
meetingTopic |
String | Specify the meeting topic in the meeting information page. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SetMeetingTopic(meetingTopic) → {Number}
- Description:
- Set the meeting topic in the meeting information page.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
meetingTopic |
String | Specify the meeting topic in the meeting information page. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SetonAudioBTNClickedCB(onAudioBtnClicked) → {Boolean}
- Description:
- Set on Audio BTN Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAudioBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonAudioBTNClickedCB(onAudioBtnClicked) → {Boolean}
- Description:
- Set on Audio BTN Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAudioBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonAudioMenuBTNClickedCB(onAudioMenuBtnClicked) → {Boolean}
- Description:
- Set on Audio BTN Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAudioMenuBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonAudioMenuBTNClickedCB(onAudioMenuBtnClicked) → {Boolean}
- Description:
- Set on Audio BTN Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onAudioMenuBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonCCBTNClickedCB(onCCBTNClicked) → {Boolean}
- Description:
- Set on CCBTN Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onCCBTNClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonCCBTNClickedCB(onCCBTNClicked) → {Boolean}
- Description:
- Set on CCBTN Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onCCBTNClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonCustomLiveStreamMenuClickedCB(onCustomLiveStreamMenuClicked) → {Boolean}
- Description:
- Set on Custom Live Stream Menu Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onCustomLiveStreamMenuClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonCustomLiveStreamMenuClickedCB(onCustomLiveStreamMenuClicked) → {Boolean}
- Description:
- Set on Custom Live Stream Menu Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onCustomLiveStreamMenuClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonEndMeetingBtnClickedCB(onEndMeetingBtnClicked) → {Boolean}
- Description:
- Set on End Meeting Btn Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onEndMeetingBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonEndMeetingBtnClickedCB(onEndMeetingBtnClicked) → {Boolean}
- Description:
- Set on End Meeting Btn Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onEndMeetingBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonParticipantListBtnClickedCB(onParticipantListBtnClicked) → {Boolean}
- Description:
- Set on Participant List Btn Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onParticipantListBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonParticipantListBtnClickedCB(onParticipantListBtnClicked) → {Boolean}
- Description:
- Set on Participant List Btn Clicked Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onParticipantListBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonStartShareBtnClickedCB(onStartShareBtnClicked) → {Boolean}
- Description:
- Determine if the user can swap to show sharing screen or video now.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onStartShareBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonStartShareBtnClickedCB(onStartShareBtnClicked) → {Boolean}
- Description:
- Determine if the user can swap to show sharing screen or video now.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onStartShareBtnClicked |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonZoomInviteDialogFailedCB(onZoomInviteDialogFailed) → {Boolean}
- Description:
- Set on Zoom Invite Dialog Failed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onZoomInviteDialogFailed |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_SetonZoomInviteDialogFailedCB(onZoomInviteDialogFailed) → {Boolean}
- Description:
- Set on Zoom Invite Dialog Failed Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onZoomInviteDialogFailed |
function |
Returns:
- Type
- Boolean
(inner) MeetingUI_ShowBottomFloatToolbarWnd(show) → {Number}
- Description:
- Display/hide the toolbar at the bottom of the meeting window. This function does not work if the user sets to hide the toolbar via SetBottomFloatToolbarWndVisibility().
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
Boolean | TRUE indicates to display the toolbar. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowBottomFloatToolbarWnd(show) → {Number}
- Description:
- Display/hide the toolbar at the bottom of the meeting window. This function does not work if the user sets to hide the toolbar via SetBottomFloatToolbarWndVisibility().
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
Boolean | TRUE indicates to display the toolbar. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowChatDlg(hParent, left, top, right, bottom) → {Number}
- Description:
- Show the chat dialog during the meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
hParent |
String | parent window handle (require hexadecimal) |
left |
String | chat window left pos |
top |
String | chat window top pos |
right |
String | chat window right pos |
bottom |
String | chat window bottom pos |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowChatDlg(hParent, left, top, right, bottom) → {Number}
- Description:
- Show the chat dialog during the meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
hParent |
String | parent window handle (require hexadecimal) |
left |
String | chat window left pos |
top |
String | chat window top pos |
right |
String | chat window right pos |
bottom |
String | chat window bottom pos |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowJoinAudioDlg() → {Number}
- Description:
- Display the dialog to choose the audio to join the meeting.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowJoinAudioDlg() → {Number}
- Description:
- Display the dialog to choose the audio to join the meeting.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowParticipantsListWnd(show) → {Number}
- Description:
- Display/hide the window which is used to display the list of the participants.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
Boolean | TRUE indicates to display the list of the participants. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowParticipantsListWnd(show) → {Number}
- Description:
- Display/hide the window which is used to display the list of the participants.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
Boolean | TRUE indicates to display the list of the participants. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowPreOrNextPageVideo(show) → {Number}
- Description:
- Show the video users on previous page or next page in video wall mode. The function does not work if the window shows the first or last page. The return value is SDKERR_SUCCESS in this case.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
Boolean | TRUE indicates to show the video users on previous page, FALSE next page. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowPreOrNextPageVideo(show) → {Number}
- Description:
- Show the video users on previous page or next page in video wall mode. The function does not work if the window shows the first or last page. The return value is SDKERR_SUCCESS in this case.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
Boolean | TRUE indicates to show the video users on previous page, FALSE next page. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowSharingFrameWindows(show) → {Number}
- Description:
- Set the visibility of the green frame when sharing the desktop.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
Boolean | TRUE indicates to display the frame. FALSE hide. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowSharingFrameWindows(show) → {Number}
- Description:
- Set the visibility of the green frame when sharing the desktop.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
Boolean | TRUE indicates to display the frame. FALSE hide. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowSharingToolbar(show) → {Number}
- Description:
- Enable or disable to display the floating sharing toolbar. This function works only in the share mode.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
Boolean | TRUE indicates to display the floating toolbar. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_ShowSharingToolbar(show) → {Number}
- Description:
- Enable or disable to display the floating sharing toolbar. This function works only in the share mode.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
show |
Boolean | TRUE indicates to display the floating toolbar. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwapToShowShareViewOrVideo(mode) → {Number}
- Description:
- when someone else shares, and meeting window is not full screen. you can call the api to switch video & share display postion
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
mode |
Boolean | 0 means to display share, otherwise video |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwapToShowShareViewOrVideo(mode) → {Number}
- Description:
- when someone else shares, and meeting window is not full screen. you can call the api to switch video & share display postion
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
mode |
Boolean | 0 means to display share, otherwise video |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchFloatVideoToActiveSpkMod() → {Number}
- Description:
- Switch to current speaker mode on the floating window.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchFloatVideoToActiveSpkMod() → {Number}
- Description:
- Switch to current speaker mode on the floating window.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchFloatVideoToGalleryMod() → {Number}
- Description:
- Switch to gallery view mode on the floating window.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchFloatVideoToGalleryMod() → {Number}
- Description:
- Switch to gallery view mode on the floating window.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchMinimizeUIMode4FirstScreenMeetingUIWnd(mode) → {Number}
- Description:
- Change the display mode of the minimized meeting window for the first view.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
mode |
Number | mode(number) Specifies the minimized mode. For more details, see SDKMinimizeUIMode |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchMinimizeUIMode4FirstScreenMeetingUIWnd(mode) → {Number}
- Description:
- Change the display mode of the minimized meeting window for the first view.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
mode |
Number | mode(number) Specifies the minimized mode. For more details, see SDKMinimizeUIMode |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchSplitScreenMode(isSwitch) → {Number}
- Description:
- Switch to the split screen mode or cancel. TRUE does not work if it is in the split screen mode. FALSE does not work if it is not the split screen mode.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
isSwitch |
Boolean | TRUE indicates to switch to the split screen mode. FALSE cancel. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchSplitScreenMode(isSwitch) → {Number}
- Description:
- Switch to the split screen mode or cancel. TRUE does not work if it is in the split screen mode. FALSE does not work if it is not the split screen mode.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
isSwitch |
Boolean | TRUE indicates to switch to the split screen mode. FALSE cancel. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchToActiveSpeaker() → {Number}
- Description:
- Switch to the mode of showing the current speaker.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchToActiveSpeaker() → {Number}
- Description:
- Switch to the mode of showing the current speaker.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchToVideoWall() → {Number}
- Description:
- Switch to video wall mode.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
(inner) MeetingUI_SwitchToVideoWall() → {Number}
- Description:
- Switch to video wall mode.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in: ZoomSDKError
- Type
- Number
Events
onAudioBtnClicked
- Description:
- Callback event for clicking Audio button in the meeting. The user won't receive this callback event unless he sets to redirect the process of clicking the Audio button in the meeting.
- Source:
onAudioBtnClicked
- Description:
- Callback event for clicking Audio button in the meeting. The user won't receive this callback event unless he sets to redirect the process of clicking the Audio button in the meeting.
- Source:
onAudioMenuBtnClicked
- Description:
- Callback event for clicking Audio Menu button in the meeting. The user won't receive this callback event unless he sets to redirect the process of clicking the Audio Menu button in the meeting.
- Source:
onAudioMenuBtnClicked
- Description:
- Callback event for clicking Audio Menu button in the meeting. The user won't receive this callback event unless he sets to redirect the process of clicking the Audio Menu button in the meeting.
- Source:
onCCBTNClicked
- Description:
- Callback event of clicking CC menu. The user won't receive this callback event unless he redirects the process of clicking the CUSTOME LIVE STREAM menu.
- Source:
onCCBTNClicked
- Description:
- Callback event of clicking CC menu. The user won't receive this callback event unless he redirects the process of clicking the CUSTOME LIVE STREAM menu.
- Source:
onCustomLiveStreamMenuClicked
- Description:
- Callback event of clicking CUSTOME LIVE STREAM menu. The user won't receive this callback event unless he sets to redirect the process of clicking the CUSTOME LIVE STREAM menu.
- Source:
onCustomLiveStreamMenuClicked
- Description:
- Callback event of clicking CUSTOME LIVE STREAM menu. The user won't receive this callback event unless he sets to redirect the process of clicking the CUSTOME LIVE STREAM menu.
- Source:
onEndMeetingBtnClicked
- Description:
- Callback event of clicking the END MEETING button. The user won't receive this callback event unless he sets to redirect the process of clicking the END MEETING button.
- Source:
onEndMeetingBtnClicked
- Description:
- Callback event of clicking the END MEETING button. The user won't receive this callback event unless he sets to redirect the process of clicking the END MEETING button.
- Source:
onInviteBtnClicked
- Description:
- Callback event to click the INVITE button. If the value of bHandled is not set to TRUE, the default interface will pop up.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
result |
String |
onInviteBtnClicked
- Description:
- Callback event to click the INVITE button. If the value of bHandled is not set to TRUE, the default interface will pop up.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
result |
String |
onParticipantListBtnClicked
- Description:
- Callback event of clicking PRTICIPANT LIST button. The user won't receive this callback event unless he sets to redirect the process of clicking the PARTICIPANT LIST button.
- Source:
onParticipantListBtnClicked
- Description:
- Callback event of clicking PRTICIPANT LIST button. The user won't receive this callback event unless he sets to redirect the process of clicking the PARTICIPANT LIST button.
- Source:
onStartShareBtnClicked
- Description:
- Callback event for clicking START SHARE button. The user won't receive this callback event unless he sets to redirect the process of clicking the SHARE button.
- Source:
onStartShareBtnClicked
- Description:
- Callback event for clicking START SHARE button. The user won't receive this callback event unless he sets to redirect the process of clicking the SHARE button.
- Source:
onZoomInviteDialogFailed
- Description:
- Notification occurs only when the SDK fails to display the default Zoom INVITE dialog.
- Source:
onZoomInviteDialogFailed
- Description:
- Notification occurs only when the SDK fails to display the default Zoom INVITE dialog.
- Source: