us.zoom.sdk.ZoomUIService Interface Reference

Service for users' to operate with Zoom UI. More...

Public Member Functions
void	switchToNextPage ()
	Switch to the next scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.
void	switchToPreviousPage ()
	Switch to the previous scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.
void	switchToActiveSpeaker ()
	Switch to the active scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.
void	switchToDriveScene ()
	Switch to the drive scene. This is not supported for tablet in the new meeting UI. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.
void	switchToVideoWall ()
	Switch to the gallery scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.
void	switchToSignLanguageView ()
	Switch to the sign language scene. It is only supported in the new meeting UI. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.
void	setHideMeetingInputUserInfoWindow (boolean hide)
	Set the meeting input user info dialog to hide or display.
boolean	isHideMeetingInputUserInfoWindow ()
	Get the meeting input user info dialog to hide or display.
void	prePopulateWebinarRegistrationInfo (String email, String username)
	Preset email and username for webinars which need registration to join, the email and username value will be input to the webinar registration dialog as default.
void	setHideRegisterWebinarInfoWindow (boolean hide)
	Set the webinar register information dialog to hide or display.
boolean	isHideRegisterWebinarInfoWindow ()
	Get the webinar register information dialog to hide or display.
void	setZoomUIDelegate (ZoomUIDelegate delegate)
	Set the zoom ui delegate. can handle the user click event.
void	hideReactionsOnMeetingUI (boolean hidden)
	Hide meeting reaction ui.
void	hideDisconnectAudio (boolean hidden)
	Hide disconnect audio button in meeting.
void	hiddenPromoToPanelist (boolean hidden)
	Hide promo to panelist in webinar.
void	hiddenChangeToAttendee (boolean hidden)
	Hide Change to attendee in webinar.
boolean	showMiniMeetingWindow ()
	Show minimized meeting window.
void	hideMiniMeetingWindow ()
void	setMiniMeetingViewSize (CustomizedMiniMeetingViewSize size)
	Set the customized minimize meeting view size.
void	enableMinimizeMeeting (boolean enable)
	Enable minimize meeting feature. This feature is disabled as default. If the minimize meeting feature is enabled, the pip mode is disabled. Notice: if set disablePIPMode(boolean) false, the minimize meeting feature is disabled.
void	disablePIPMode (boolean disable)
	Disable PIP mode feature. The PIP mode is enabled as default. If the PIP mode feature is enabled, the minimize meeting feature is disabled. Notice: if set enableMinimizeMeeting(boolean) true, the pip mode will be disabled.
void	disableFreeMeetingNeedAdminUpgradeTips (boolean disable)
	Disable free meeting upgrade tips for zoom ui.
void	enableJavaScriptForShareWebView (boolean enable)
	Enable webView javascript for share url. default is true.
void	hideMeetingInviteUrl (boolean hidden)
	hide meeting invite url
MobileRTCSDKError	setCustomizedInvitationDomain (String invitationDomain)
	Set the customized invitation domain.
MobileRTCSDKError	setCustomizedPollingUrl (String pollingURL, boolean bCreate)
	Allowing the developer to customize the URL of create/edit the polling.
void	setHideShareOptions (List< Integer > shareOptions)
	Hide specified share item list.
void	setCustomShareOptions (List< ICustomShareOptionItem > optionItemList)
	Add customized share item.
void	hideCloudWhiteboardFeedbackButton (boolean isHide)
	Hide feedback button on cloud whiteboard.
MobileRTCSDKError	setCloudWhiteboardFeedbackUrl (String url)
	Allowing the developer to customize the URL of feedback on cloud whiteboard.
void	hideCloudWhiteboardShareButton (boolean isHide)
	Hide share button on cloud whiteboard.
void	hideCloudWhiteboardAboutButton (boolean isHide)
	Hide about button on cloud whiteboard.
void	setNewMeetingUI (Class<? extends NewMeetingActivity > activity)
	set the meeting UI.
boolean	isTabletDevice ()
	Query if the current device is tablet device for zoom ui.
MobileRTCSDKError	enableHideSelfView (boolean bEnable)
	Enable or disable to hide the user self's view in gallery view.
boolean	isHideSelfViewEnabled ()
	Get the flag to enable/disable to hide user self's view in gallery view.
void	hideRequestRecordPrivilegeDialog (boolean bHide)
	Set the visibility of request local recording privilege dialog when attendee request local recording privilege. Default is displaying.
void	hideJoinMeetingNamePasswordDialog (boolean bHide)
	Whether to hide the name and password dialog when the meeting requires a name and password dialog. Show name and password dialog by default.
void	setHideWebinarNameInputWindow (boolean hide)
	Set the webinar username input dialog to hide or display. if hide webinar user name input dialog, should handle InMeetingServiceListener#onWebinarNeedInputScreenName(InMeetingEventHandler)} InMeetingEventHandler#inputName(String).
boolean	isHideWebinarNameInputWindow ()
	Get the webinar username input dialog to hide or display.
void	setHideConfirmStartArchiveDialog (boolean hide)
	Set the confirm start archive dialog to hide or display. if hide confirm start archive dialog when join meeting, should handle InMeetingServiceListener#onUserConfirmToStartArchive(IMeetingArchiveConfirmHandler).
boolean	isHideConfirmStartArchiveDialog ()
	Get the confirm start archive dialog whether hide or display.
void	setHideRecoverMeetingDialog (boolean hide)
	for hide confirm start archive dialog
boolean	isHideRecoverMeetingDialog ()
	Get the recover meeting dialog whether hide or display.

Detailed Description

Service for users' to operate with Zoom UI.

Definition at line 11 of file ZoomUIService.java.

Member Function Documentation

disableFreeMeetingNeedAdminUpgradeTips()

void us.zoom.sdk.ZoomUIService.disableFreeMeetingNeedAdminUpgradeTips

(

boolean

disable

)

Disable free meeting upgrade tips for zoom ui.

Parameters

disable

true: disable; false: enable; default is false.

disablePIPMode()

void us.zoom.sdk.ZoomUIService.disablePIPMode

(

boolean

disable

)

Disable PIP mode feature. The PIP mode is enabled as default. If the PIP mode feature is enabled, the minimize meeting feature is disabled. Notice: if set enableMinimizeMeeting(boolean) true, the pip mode will be disabled.

Parameters

disable

true: disable the pip mode; false: enable the pip mode.

enableHideSelfView()

MobileRTCSDKError us.zoom.sdk.ZoomUIService.enableHideSelfView

(

boolean

bEnable

)

Enable or disable to hide the user self's view in gallery view.

Parameters

bEnable

true indicates to enable to hide the user self's view.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

enableJavaScriptForShareWebView()

void us.zoom.sdk.ZoomUIService.enableJavaScriptForShareWebView

(

boolean

enable

)

Enable webView javascript for share url. default is true.

Parameters

enable

true/false

enableMinimizeMeeting()

void us.zoom.sdk.ZoomUIService.enableMinimizeMeeting

(

boolean

enable

)

Enable minimize meeting feature. This feature is disabled as default. If the minimize meeting feature is enabled, the pip mode is disabled. Notice: if set disablePIPMode(boolean) false, the minimize meeting feature is disabled.

Parameters

enable

true: enable; false: disable;

hiddenChangeToAttendee()

void us.zoom.sdk.ZoomUIService.hiddenChangeToAttendee

(

boolean

hidden

)

Hide Change to attendee in webinar.

Parameters

hidden

true: hide; false:show

hiddenPromoToPanelist()

void us.zoom.sdk.ZoomUIService.hiddenPromoToPanelist

(

boolean

hidden

)

Hide promo to panelist in webinar.

Parameters

hidden

true: hide; false:show

hideCloudWhiteboardAboutButton()

void us.zoom.sdk.ZoomUIService.hideCloudWhiteboardAboutButton

(

boolean

isHide

)

Hide about button on cloud whiteboard.

Parameters

isHide

hide if True, else show

hideCloudWhiteboardFeedbackButton()

void us.zoom.sdk.ZoomUIService.hideCloudWhiteboardFeedbackButton

(

boolean

isHide

)

Hide feedback button on cloud whiteboard.

Parameters

isHide

hide if True, else show

hideCloudWhiteboardShareButton()

void us.zoom.sdk.ZoomUIService.hideCloudWhiteboardShareButton

(

boolean

isHide

)

Hide share button on cloud whiteboard.

Parameters

isHide

hide if True, else show

hideDisconnectAudio()

void us.zoom.sdk.ZoomUIService.hideDisconnectAudio

(

boolean

hidden

)

Hide disconnect audio button in meeting.

Parameters

hidden

true: hide; false: show

hideJoinMeetingNamePasswordDialog()

void us.zoom.sdk.ZoomUIService.hideJoinMeetingNamePasswordDialog

(

boolean

bHide

)

Whether to hide the name and password dialog when the meeting requires a name and password dialog. Show name and password dialog by default.

Parameters

bHide

true means to hide the name and password dialog

hideMeetingInviteUrl()

void us.zoom.sdk.ZoomUIService.hideMeetingInviteUrl

(

boolean

hidden

)

hide meeting invite url

Parameters

hidden

true: hide; false: show

hideMiniMeetingWindow()

void us.zoom.sdk.ZoomUIService.hideMiniMeetingWindow

(

)

hideReactionsOnMeetingUI()

void us.zoom.sdk.ZoomUIService.hideReactionsOnMeetingUI

(

boolean

hidden

)

Hide meeting reaction ui.

Parameters

hidden

true:hide ui

hideRequestRecordPrivilegeDialog()

void us.zoom.sdk.ZoomUIService.hideRequestRecordPrivilegeDialog

(

boolean

bHide

)

Set the visibility of request local recording privilege dialog when attendee request local recording privilege. Default is displaying.

Parameters

bHide

TRUE indicates to hide the tab. FALSE not.

isHideConfirmStartArchiveDialog()

boolean us.zoom.sdk.ZoomUIService.isHideConfirmStartArchiveDialog

(

)

Get the confirm start archive dialog whether hide or display.

Returns

true means hide, false means display.

isHideMeetingInputUserInfoWindow()

boolean us.zoom.sdk.ZoomUIService.isHideMeetingInputUserInfoWindow

(

)

Get the meeting input user info dialog to hide or display.

Returns

value of the setting value.

isHideRecoverMeetingDialog()

boolean us.zoom.sdk.ZoomUIService.isHideRecoverMeetingDialog

(

)

Get the recover meeting dialog whether hide or display.

Returns

true means hide, false means display.

isHideRegisterWebinarInfoWindow()

boolean us.zoom.sdk.ZoomUIService.isHideRegisterWebinarInfoWindow

(

)

Get the webinar register information dialog to hide or display.

Returns

value of the setting value.

isHideSelfViewEnabled()

boolean us.zoom.sdk.ZoomUIService.isHideSelfViewEnabled

(

)

Get the flag to enable/disable to hide user self's view in gallery view.

Returns

Enabled or disabled.

isHideWebinarNameInputWindow()

boolean us.zoom.sdk.ZoomUIService.isHideWebinarNameInputWindow

(

)

Get the webinar username input dialog to hide or display.

Returns

value of the setting value.

isTabletDevice()

boolean us.zoom.sdk.ZoomUIService.isTabletDevice

(

)

Query if the current device is tablet device for zoom ui.

Returns

true means the current device is tablet device for zoom ui, false means not.

prePopulateWebinarRegistrationInfo()

void us.zoom.sdk.ZoomUIService.prePopulateWebinarRegistrationInfo	(	String	email,
		String	username )

Preset email and username for webinars which need registration to join, the email and username value will be input to the webinar registration dialog as default.

Parameters

email	preset email
username	preset username

setCloudWhiteboardFeedbackUrl()

MobileRTCSDKError us.zoom.sdk.ZoomUIService.setCloudWhiteboardFeedbackUrl

(

String

url

)

Allowing the developer to customize the URL of feedback on cloud whiteboard.

Parameters

url	Specify the feedback url in the the white board page.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setCustomizedInvitationDomain()

MobileRTCSDKError us.zoom.sdk.ZoomUIService.setCustomizedInvitationDomain

(

String

invitationDomain

)

Set the customized invitation domain.

Parameters

invitationDomain

Specify the customized invitation domain. eg: https://abc.com.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setCustomizedPollingUrl()

MobileRTCSDKError us.zoom.sdk.ZoomUIService.setCustomizedPollingUrl	(	String	pollingURL,
		boolean	bCreate )

Allowing the developer to customize the URL of create/edit the polling.

Parameters

pollingURL	customized URL.
bCreate	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 succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setCustomShareOptions()

void us.zoom.sdk.ZoomUIService.setCustomShareOptions

(

List< ICustomShareOptionItem >

optionItemList

)

Add customized share item.

Parameters

optionItemList

ICustomShareOptionItem

setHideConfirmStartArchiveDialog()

void us.zoom.sdk.ZoomUIService.setHideConfirmStartArchiveDialog

(

boolean

hide

)

Set the confirm start archive dialog to hide or display. if hide confirm start archive dialog when join meeting, should handle InMeetingServiceListener#onUserConfirmToStartArchive(IMeetingArchiveConfirmHandler).

Parameters

hide	true means hide the dialog. Otherwise, do not hide the dialog.

setHideMeetingInputUserInfoWindow()

void us.zoom.sdk.ZoomUIService.setHideMeetingInputUserInfoWindow

(

boolean

hide

)

Set the meeting input user info dialog to hide or display.

Parameters

hide	true means hide the dialog. Otherwise, do not hide the dialog.

setHideRecoverMeetingDialog()

void us.zoom.sdk.ZoomUIService.setHideRecoverMeetingDialog

(

boolean

hide

)

for hide confirm start archive dialog

Parameters

hide	true means hide the dialog. Otherwise, do not hide the dialog.

setHideRegisterWebinarInfoWindow()

void us.zoom.sdk.ZoomUIService.setHideRegisterWebinarInfoWindow

(

boolean

hide

)

Set the webinar register information dialog to hide or display.

Parameters

hide	true means hide the dialog. Otherwise, do not hide the dialog.

setHideShareOptions()

void us.zoom.sdk.ZoomUIService.setHideShareOptions

(

List< Integer >

shareOptions

)

Hide specified share item list.

Parameters

shareOptions

ShareOptions

setHideWebinarNameInputWindow()

void us.zoom.sdk.ZoomUIService.setHideWebinarNameInputWindow

(

boolean

hide

)

Set the webinar username input dialog to hide or display. if hide webinar user name input dialog, should handle InMeetingServiceListener#onWebinarNeedInputScreenName(InMeetingEventHandler)} InMeetingEventHandler#inputName(String).

Parameters

hide	true means hide the dialog. Otherwise, do not hide the dialog.

setMiniMeetingViewSize()

void us.zoom.sdk.ZoomUIService.setMiniMeetingViewSize

(

CustomizedMiniMeetingViewSize

size

)

Set the customized minimize meeting view size.

Parameters

size

size

setNewMeetingUI()

void us.zoom.sdk.ZoomUIService.setNewMeetingUI

(

Class<? extends NewMeetingActivity >

activity

)

set the meeting UI.

Parameters

activity

the new meeting UI activity class. Null means use the default new meeting UI activity

setZoomUIDelegate()

void us.zoom.sdk.ZoomUIService.setZoomUIDelegate

(

ZoomUIDelegate

delegate

)

Set the zoom ui delegate. can handle the user click event.

when conference end user should set the delegate null.

Parameters

delegate

ZoomUIDelegate

showMiniMeetingWindow()

boolean us.zoom.sdk.ZoomUIService.showMiniMeetingWindow

(

)

Show minimized meeting window.

Returns

true if show successfully

switchToActiveSpeaker()

void us.zoom.sdk.ZoomUIService.switchToActiveSpeaker

(

)

Switch to the active scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

switchToDriveScene()

void us.zoom.sdk.ZoomUIService.switchToDriveScene

(

)

Switch to the drive scene. This is not supported for tablet in the new meeting UI. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

switchToNextPage()

void us.zoom.sdk.ZoomUIService.switchToNextPage

(

)

Switch to the next scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

switchToPreviousPage()

void us.zoom.sdk.ZoomUIService.switchToPreviousPage

(

)

Switch to the previous scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

switchToSignLanguageView()

void us.zoom.sdk.ZoomUIService.switchToSignLanguageView

(

)

Switch to the sign language scene. It is only supported in the new meeting UI. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.

switchToVideoWall()

void us.zoom.sdk.ZoomUIService.switchToVideoWall

(

)

Switch to the gallery scene. For a new meeting UI, the video frames' sequence is { drive scene(if has), active scene, sign language scene(if has), gallery scene(if has) }.