Module: zoom_meeting_ui_ctrl

Methods

(inner) getInstance() → {ZoomMeetingUICtrl}

mode: Get Zoom SDK Meeting Service Module
Source:
Returns:
Type
ZoomMeetingUICtrl

(inner) MeetingUI_BackToMeeting() → {ZoomSDKError}

mode: Active the principal window of meeting and place it on top
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_CanSwapToShowShareViewOrVideo() → {ZoomSDKError}

mode: Determine if the user can swap to show sharing screen or video now
Source:
Returns:
0 means Can, otherwise not
Type
ZoomSDKError

(inner) MeetingUI_ChangeFloatoActiveSpkVideoSize(floatvideotype) → {ZoomSDKError}

mode: Change float active speaker window type and size
Parameters:
Name Type Description
floatvideotype String the type of float active speaker window, define at ZoomMeetingUIFloatVideoType
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_EnterFullScreen(viewtype:) → {ZoomSDKError}

mode: Enter full screen mode
Parameters:
Name Type Description
viewtype: String view type of the meeting ui, define at ZoomMeetingUIViewType
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_ExitFullScreen(viewtype:) → {ZoomSDKError}

mode: Exit full screen mode
Parameters:
Name Type Description
viewtype: String view type of the meeting ui, define at ZoomMeetingUIViewType
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_GetCurrentSplitScreenModeInfo() → {ZoomSDKError}

mode: Get Current Split ScreenMode Info
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_GetMeetingUIWnd() → {ZoomSDKError}

mode: Get the window handle of the meeting user interface. This interface is only valid on Windows
Source:
Returns:
If the function succeeds, "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
ZoomSDKError

(inner) MeetingUI_GetWallViewPageInfo() → {ZoomSDKError}

mode: Get Wall View Page Info
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_HideChatDlg() → {ZoomSDKError}

mode: Hide inmeeting chat window
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_HideJoinAudioDlg() → {ZoomSDKError}

mode: Hide join audio dialog
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_IsDisplayingShareViewOrVideo() → {ZoomSDKError}

mode: Determine if the meeting is displaying the sharing screen now
Source:
Returns:
0 means is showing sharing screen, otherwise means is showing video
Type
ZoomSDKError

(inner) MeetingUI_IsMinimizeModeOfFristScreenMeetingUIWnd() → {ZoomSDKError}

mode: Determines the minimize state of the first view
Source:
Returns:
If the function succeeds, the return value is a object which includes "bIsMinimizMode", TRUE indicates the minimize state, FALSE not
Type
ZoomSDKError

(inner) MeetingUI_MoveFloatVideoWnd(left, top) → {ZoomSDKError}

mode: Move float video window
Parameters:
Name Type Description
left String chat window left pos
top String chat window top pos
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_SetInviteButtonClickedCB(onInviteBtnClicked) → {Boolean}

mode: Set Invite Button Clicked CB
Parameters:
Name Type Description
onInviteBtnClicked function
Source:
Returns:
Type
Boolean

(inner) MeetingUI_SetonAudioBTNClickedCB(onAudioBtnClicked) → {Boolean}

mode: Set on Audio BTN Clicked CB
Parameters:
Name Type Description
onAudioBtnClicked function
Source:
Returns:
Type
Boolean

(inner) MeetingUI_SetonAudioMenuBTNClickedCB(onAudioMenuBtnClicked) → {Boolean}

mode: Set on Audio BTN Clicked CB
Parameters:
Name Type Description
onAudioMenuBtnClicked function
Source:
Returns:
Type
Boolean

(inner) MeetingUI_SetonCCBTNClickedCB(onCCBTNClicked) → {Boolean}

mode: Set on CCBTN Clicked CB
Parameters:
Name Type Description
onCCBTNClicked function
Source:
Returns:
Type
Boolean

(inner) MeetingUI_SetonCustomLiveStreamMenuClickedCB(onCustomLiveStreamMenuClicked) → {ZoomSDKError}

mode: Set on Custom Live Stream Menu Clicked CB
Parameters:
Name Type Description
onCustomLiveStreamMenuClicked function
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_SetonEndMeetingBtnClickedCB(onEndMeetingBtnClicked) → {Boolean}

mode: Set on End Meeting Btn Clicked CB
Parameters:
Name Type Description
onEndMeetingBtnClicked function
Source:
Returns:
Type
Boolean

(inner) MeetingUI_SetonParticipantListBtnClickedCB(onParticipantListBtnClicked) → {Boolean}

mode: Set on Participant List Btn Clicked CB
Parameters:
Name Type Description
onParticipantListBtnClicked function
Source:
Returns:
Type
Boolean

(inner) MeetingUI_SetonStartShareBtnClickedCB(onStartShareBtnClicked) → {Boolean}

mode: Set on Start Share Btn Clicked CB
Parameters:
Name Type Description
onStartShareBtnClicked function
Source:
Returns:
Type
Boolean

(inner) MeetingUI_SetonZoomInviteDialogFailedCB(onZoomInviteDialogFailed) → {Boolean}

mode: Set on Zoom Invite Dialog Failed CB
Parameters:
Name Type Description
onZoomInviteDialogFailed function
Source:
Returns:
Type
Boolean

(inner) MeetingUI_ShowBottomFloatToolbarWnd(show) → {ZoomSDKError}

mode: Show or hide the window of bottom float tool bar
Parameters:
Name Type Description
show String show or not
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_ShowChatDlg(hParent, left, top, right, bottom) → {ZoomSDKError}

mode: Show inmeeting chat window
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
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_ShowJoinAudioDlg() → {ZoomSDKError}

mode: Show join audio dialog
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_ShowParticipantsListWnd(show) → {ZoomSDKError}

mode: Show or hide the window of participants list
Parameters:
Name Type Description
show String show or not
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_ShowPreOrNextPageVideo(show:) → {ZoomSDKError}

mode: Show Pre Or Next Page Video
Parameters:
Name Type Description
show: Boolean show or not
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_ShowSharingFrameWindows(show:) → {ZoomSDKError}

mode: Show Sharing Frame Windows
Parameters:
Name Type Description
show: Boolean show or not
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_ShowSharingToolbar(show:) → {ZoomSDKError}

mode: Show or hide the toolbar of sharing
Parameters:
Name Type Description
show: Boolean show or not
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_SwapToShowShareViewOrVideo(mode) → {ZoomSDKError}

mode: when someone else shares, and meeting window is not full screen. you can call the api to switch video & share display postion
Parameters:
Name Type Description
mode Boolean 0 means to display share, otherwise video
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_SwitchFloatVideoToActiveSpkMod() → {ZoomSDKError}

mode: Switch float video to active speaker mode
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_SwitchFloatVideoToGalleryMod() → {ZoomSDKError}

mode: Switch float video to gallery mode
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_SwitchMinimizeUIMode4FristScreenMeetingUIWnd(mode) → {ZoomSDKError}

mode: Change the display mode of the minimized meeting window for the first view
Parameters:
Name Type Description
mode Number mode(number) Specifies the minimized mode. For more details, see ZNSDKMinimizeUIMode
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_SwitchSplitScreenMode(isSwitch:) → {ZoomSDKError}

mode: Switch Split Screen Mode
Parameters:
Name Type Description
isSwitch: Boolean switch or not
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_SwitchToVideoWall() → {ZoomSDKError}

mode: Switch to video wall mode
Source:
Returns:
Type
ZoomSDKError

(inner) MeetingUI_SwtichToAcitveSpeaker() → {ZoomSDKError}

mode: Switch to active speaker mode
Source:
Returns:
Type
ZoomSDKError