ZoomSDKMeetingUIController Class Reference

Class to control and customize Zoom meeting UI components. More...

#include <ZoomSDKMeetingUIController.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- showMeetingComponent:window:show:InPanel:frame:
	Whether to show components in meeting and meeting controls.
(ZoomSDKError)	- enterFullScreen:firstMonitor:DualMonitor:
	Enter full screen mode.
(ZoomSDKError)	- switchToVideoWallView
	Switch to video wall view.
(ZoomSDKError)	- switchToActiveSpeakerView
	Switch to the mode of showing the current speaker.
(BOOL)	- isInMiniVideoMode
	Determines if the meeting is in minimize window mode.
(ZoomSDKError)	- switchMiniVideoModeUI
	Switch UI between mini video and mini bar(without video), it works only when isInMiniVideoMode = YES.
(ZoomSDKError)	- switchFloatVideoToMinimizeMode
	Switch float video display mode to minimize mode.
(ZoomSDKError)	- switchFloatVideoToWallMode
	Switch float video display mode to wall mode.
(ZoomSDKError)	- switchFloatVideoToActiveSpeakerMode
	Switch float video display mode to active speaker.
(ZoomSDKError)	- switchFloatVideoToGalleryMode
	Switch float video display mode to gallery view mode.
(ZoomSDKError)	- hideOrShowNoVideoUserOnVideoWall:
	Display or not the user who does not turn on the video in the video wall mode.
(ZoomSDKError)	- getWallViewPageInfo:TotalPageNum:
	Gets the page information in video wall mode.
(ZoomSDKError)	- showPreOrNextPageWallView:
	Display previous or following page of video wall in the meeting.
(ZoomSDKError)	- backToMeeting
	Active the principal window of meeting and place it on top.
(BOOL)	- showVideoPreviewWhenJoinMeeting
	Determines when join meeting the video preview is display.
(ZoomSDKError)	- isShowVideoPreviewWhenJoinMeeting:
	Display video preview when join meeting.
(ZoomSDKError)	- pagingToPreOrNextViewWhenSharing:
	Display previous or following page of video view when in sharing.
(ZoomSDKError)	- setCustomizedInvitationDomain:
	Sets the invitation domain.
(ZoomSDKError)	- setCustomizedPollingUrl:bCreate:
	Allowing the developer to customize the URL of create or edit the polling.
(ZoomSDKError)	- setCloudWhiteboardFeedbackUrl:
	Sets the feedback url in the white board page.
(void)	- hideRequestRecordPrivilegeDialog:
	Sets the visibility of request local recording privilege dialog when attendee request local recording privilege. Default is displaying.

Protected Attributes
id< ZoomSDKMeetingUIControllerDelegate >	_delegate

Properties
id< ZoomSDKMeetingUIControllerDelegate >	delegate
	Sets the delegate to receive meeting UI related events.

Detailed Description

Class to control and customize Zoom meeting UI components.

Definition at line 67 of file ZoomSDKMeetingUIController.h.

Method Documentation

backToMeeting

- (ZoomSDKError) backToMeeting

Active the principal window of meeting and place it on top.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

enterFullScreen:firstMonitor:DualMonitor:

- (ZoomSDKError) enterFullScreen:		(BOOL)	fullScreen
firstMonitor:		(BOOL)	firstView
DualMonitor:		(BOOL)	secondView

Enter full screen mode.

Parameters

fullScreen	YES to enter full screen, NO otherwise.
firstView	YES to enter full screen mode on the first view, NO otherwise.
secondView	YES to enter full screen mode on the second view, NO otherwise.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

getWallViewPageInfo:TotalPageNum:

- (ZoomSDKError) getWallViewPageInfo:		(int *)	currentPageNum
TotalPageNum:		(int *)	totalPageNum

Gets the page information in video wall mode.

Parameters

currentPageNum	The number of current page.
totalPageNum	The number of total pages.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

hideOrShowNoVideoUserOnVideoWall:

- (ZoomSDKError) hideOrShowNoVideoUserOnVideoWall:

(BOOL)

hide

Display or not the user who does not turn on the video in the video wall mode.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

hideRequestRecordPrivilegeDialog:

- (void) hideRequestRecordPrivilegeDialog:

(BOOL)

bHide

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

Parameters

bHide

YES indicates to hide the tab, NO to display the dialog.

isInMiniVideoMode

- (BOOL) isInMiniVideoMode

Determines if the meeting is in minimize window mode.

Returns

YES if it is in minimize window mode. Otherwise, NO.

isShowVideoPreviewWhenJoinMeeting:

- (ZoomSDKError) isShowVideoPreviewWhenJoinMeeting:

(BOOL)

isShow

Display video preview when join meeting.

Parameters

isShow

YES to display video preview, NO otherwise.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

pagingToPreOrNextViewWhenSharing:

- (ZoomSDKError) pagingToPreOrNextViewWhenSharing:

(BOOL)

nextPage

Display previous or following page of video view when in sharing.

Parameters

nextPage

Set it to YES to display following page of video view, NO to display previous page.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

setCloudWhiteboardFeedbackUrl:

- (ZoomSDKError) setCloudWhiteboardFeedbackUrl:

(NSString *)

feedbackUrl

Sets the feedback url in the white board page.

Parameters

feedbackUrl

Specify the feedback url in the the white board page.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

setCustomizedInvitationDomain:

- (ZoomSDKError) setCustomizedInvitationDomain:

(NSString *)

invitationDomain

Sets the invitation domain.

Parameters

invitationDomain

Specify the invitation domain.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

setCustomizedPollingUrl:bCreate:

- (ZoomSDKError) setCustomizedPollingUrl:		(NSString *)	urlString
bCreate:		(BOOL)	bCreate

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

Parameters

urlString	Customized URL.
bCreate	YES to change the URL of creating a polling, NO to change the URL of editing a polling.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

showMeetingComponent:window:show:InPanel:frame:

- (ZoomSDKError) showMeetingComponent:		(MeetingComponent)	component
window:		(NSWindow *_Nullable *_Nullable)	window
show:		(BOOL)	show
InPanel:		(BOOL)	inPanel
frame:		(NSRect)	componentFrame

Whether to show components in meeting and meeting controls.

Parameters

component	The enum of meeting components.
window	The pointer to the window. When the function calls successfully, the 'window' will be the meeting component window.
show	YES to show the components, NO to hide
inPanel	YES to show the components in panel, NO otherwise.
componentFrame	The meeting component's frame.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

showPreOrNextPageWallView:

- (ZoomSDKError) showPreOrNextPageWallView:

(BOOL)

nextPage

Display previous or following page of video wall in the meeting.

Parameters

nextPage

Set it to YES to display following page of video wall, NO to display previous page.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

showVideoPreviewWhenJoinMeeting

- (BOOL) showVideoPreviewWhenJoinMeeting

Determines when join meeting the video preview is display.

Returns

YES if it is display video preview. Otherwise, NO.

switchFloatVideoToActiveSpeakerMode

- (ZoomSDKError) switchFloatVideoToActiveSpeakerMode

Switch float video display mode to active speaker.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

switchFloatVideoToGalleryMode

- (ZoomSDKError) switchFloatVideoToGalleryMode

Switch float video display mode to gallery view mode.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

switchFloatVideoToMinimizeMode

- (ZoomSDKError) switchFloatVideoToMinimizeMode

Switch float video display mode to minimize mode.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

switchFloatVideoToWallMode

- (ZoomSDKError) switchFloatVideoToWallMode

Switch float video display mode to wall mode.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

switchMiniVideoModeUI

- (ZoomSDKError) switchMiniVideoModeUI

Switch UI between mini video and mini bar(without video), it works only when isInMiniVideoMode = YES.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

switchToActiveSpeakerView

- (ZoomSDKError) switchToActiveSpeakerView

Switch to the mode of showing the current speaker.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

switchToVideoWallView

- (ZoomSDKError) switchToVideoWallView

Switch to video wall view.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Field Documentation

_delegate

- (id<ZoomSDKMeetingUIControllerDelegate>) _delegate

protected

Definition at line 69 of file ZoomSDKMeetingUIController.h.

Property Documentation

delegate

- (id<ZoomSDKMeetingUIControllerDelegate>) delegate

readwritenonatomicassign

Sets the delegate to receive meeting UI related events.

Definition at line 74 of file ZoomSDKMeetingUIController.h.