Meeting immersive controller interface. For more details on this feature, see https://support.zoom.us/hc/en-us/articles/360060220511-Immersive-View. More...

#include <ZoomSDKCustomImmersiveController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isImmersiveViewOn
	Determine if immersive view is active.

(ZoomSDKError)	- isInImmersiveShareMode:
	Determine if displaying sharing contents in immersive mode.

(ZoomSDKError)	- viewShare:
	Update the share source ID to view share, available only for host.

(ZoomSDKError)	- getViewingShareSourceID:
	Query the share source ID when viewing share in immersive mode. Only available for host.

(BOOL)	- isSupportImmersive
	Determine if immersive is supported.

(BOOL)	- isTemplateThumbnailsReady
	Determine if the thumbnails are ready.

(BOOL)	- canStartImmersiveView:
	Determine if the immersive template can be started.

(ZoomSDKError)	- startImmersiveView:
	Start immersive view.

(ZoomSDKError)	- changeTemplate:
	Change template in immersive view.

(ZoomSDKError)	- endImmersiveView
	Exit immersive view.

(BOOL)	- canUserShowInImmersiveView:
	Determine if the user can be shown in immersive view.

(NSArray< ZoomSDKCustomImmersiveLayoutData * > *_Nullable)	- getLayoutData
	Get the immersive seat layout data.

(ZoomSDKError)	- updateLayoutData:
	Update the layout data.

(ZoomSDKError)	- assignUser:seatID:
	Put the user in the seat.

(ZoomSDKError)	- putUserToFreeSeat:pos:
	Put the user in the free seat.

(ZoomSDKError)	- removeUser:
	Remove user from immersive view.

(BOOL)	- isUserInImmersiveView:
	Determine if the user is in immersive view.

(ZoomSDKError)	- downloadTemplateThumbnails
	Download the template thumbnails. See ZoomSDKCustomImmersiveDelegate for updates on the download.

(ZoomSDKError)	- downloadTemplate:
	Download complete template resource.

(ZoomSDKError)	- addCustomImageTemplate:template:
	Add a template based on a custom image.

(ZoomSDKError)	- removeCustomImageTemplate:
	Remove custom immersive template.

(ZoomSDKCustomImmersiveTemplate *_Nullable)	- getCurrentTemplate
	Get the current template.

(NSArray< ZoomSDKCustomImmersiveTemplate * > *_Nullable)	- getTemplates
	Get the list of templates.

(ZoomSDKCustomImmersiveContainer *_Nullable)	- createImmersiveContainer:
	Create the immersive container for customUI.

(ZoomSDKError)	- destroyImmersiveContainer
	Destroy the immersive container. Once destroyed, the container can no longer be used.

Properties
id< ZoomSDKCustomImmersiveDelegate >	delegate

Detailed Description

Meeting immersive controller interface. For more details on this feature, see https://support.zoom.us/hc/en-us/articles/360060220511-Immersive-View.

Definition at line 184 of file ZoomSDKCustomImmersiveController.h.

Method Documentation

◆ addCustomImageTemplate:template:

- (ZoomSDKError) addCustomImageTemplate:		(NSString *)	filePath
template:		(ZoomSDKCustomImmersiveTemplate _Nullable _Nonnull)	immersiveTemplate

Add a template based on a custom image.

Parameters

filePath	The image file path.
immersiveTemplate	If the function succeeds, the object will be ZoomSDKCustomImmersiveTemplate, otherwise nil.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ assignUser:seatID:

- (ZoomSDKError) assignUser:		(unsigned int)	userID
seatID:		(NSString *)	seatID

Put the user in the seat.

Parameters

userID	The user ID.
seatID	The seat ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ canStartImmersiveView:

- (BOOL) canStartImmersiveView: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Determine if the immersive template can be started.

Parameters

immersiveTemplate The selected template in immersive view. For more details, see ZoomSDKCustomImmersiveTemplate

Returns: YES means the immersive can be started, otherwise not.

◆ canUserShowInImmersiveView:

- (BOOL) canUserShowInImmersiveView: (unsigned int) userID

Determine if the user can be shown in immersive view.

Parameters

userID The user ID.

Returns: YES means the user can be shown in immersive view, NO if they cannot.

◆ changeTemplate:

- (ZoomSDKError) changeTemplate: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Change template in immersive view.

Parameters

immersiveTemplate The selected template in immersive view. For more details, see ZoomSDKCustomImmersiveTemplate

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ createImmersiveContainer:

- (ZoomSDKCustomImmersiveContainer *_Nullable) createImmersiveContainer: (NSRect) rect

Create the immersive container for customUI.

Parameters

rect	Specify the position of client area of the immersive container.

Returns: If the function succeeds, it will return the object of ZoomSDKCustomImmersiveContainer. Otherwise nil.

◆ destroyImmersiveContainer

- (ZoomSDKError) destroyImmersiveContainer

Destroy the immersive container. Once destroyed, the container can no longer be used.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ downloadTemplate:

- (ZoomSDKError) downloadTemplate: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Download complete template resource.

Parameters

immersiveTemplate The template be downloaded. For more details, see \link ZoomSDKCustomImmersiveTemplate .

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ downloadTemplateThumbnails

- (ZoomSDKError) downloadTemplateThumbnails

Download the template thumbnails. See ZoomSDKCustomImmersiveDelegate for updates on the download.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.To get extended error information, see ZoomSDKError.

◆ endImmersiveView

- (ZoomSDKError) endImmersiveView

Exit immersive view.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ getCurrentTemplate

- (ZoomSDKCustomImmersiveTemplate *_Nullable) getCurrentTemplate

Get the current template.

Returns: If the function succeeds, the return value is the current template. For more details, see ZoomSDKCustomImmersiveTemplate.

◆ getLayoutData

- (NSArray< ZoomSDKCustomImmersiveLayoutData * > *_Nullable) getLayoutData

Get the immersive seat layout data.

Returns: If the function succeeds, it will return the immersive seat layout data. Otherwise the function returns nil.

◆ getTemplates

- (NSArray< ZoomSDKCustomImmersiveTemplate * > *_Nullable) getTemplates

Get the list of templates.

Returns: The list of templates. ZERO(0) indicates that there are no templates. For more details, see ZoomSDKCustomImmersiveTemplate.

◆ getViewingShareSourceID:

- (ZoomSDKError) getViewingShareSourceID: (unsigned int *) shareSourceID

Query the share source ID when viewing share in immersive mode. Only available for host.

Parameters

shareSourceID The specified source ID.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ isImmersiveViewOn

- (BOOL) isImmersiveViewOn

Determine if immersive view is active.

Returns: YES means the immersive view is active. Otherwise NO.

◆ isInImmersiveShareMode:

- (ZoomSDKError) isInImmersiveShareMode: (BOOL *) bInShare

Determine if displaying sharing contents in immersive mode.

Parameters

bInShare YES means displaying sharing contents in immersive mode. Otherwise NO.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ isSupportImmersive

- (BOOL) isSupportImmersive

Determine if immersive is supported.

Returns: YES means support immersive. Otherwise NO.

◆ isTemplateThumbnailsReady

- (BOOL) isTemplateThumbnailsReady

Determine if the thumbnails are ready.

Returns: YES means the immersive thumbnails are ready, NO not.

◆ isUserInImmersiveView:

- (BOOL) isUserInImmersiveView: (unsigned int) userID

Determine if the user is in immersive view.

Parameters

userID The user ID.

Returns: YES means the user is in immersive view, NO means that they are not.

◆ putUserToFreeSeat:pos:

- (ZoomSDKError) putUserToFreeSeat:		(unsigned int)	userID
pos:		(NSRect)	pos

Put the user in the free seat.

Parameters

userID	The user ID.
pos	The position.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ removeCustomImageTemplate:

- (ZoomSDKError) removeCustomImageTemplate: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Remove custom immersive template.

Parameters

immersiveTemplate The custom image template that want to remove. For more details, see ZoomSDKCustomImmersiveTemplate.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ removeUser:

- (ZoomSDKError) removeUser: (unsigned int) userID

Remove user from immersive view.

Parameters

userID The user ID.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ startImmersiveView:

- (ZoomSDKError) startImmersiveView: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Start immersive view.

Parameters

immersiveTemplate The selected template in immersive view. For more details, see ZoomSDKCustomImmersiveTemplate.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

◆ updateLayoutData:

- (ZoomSDKError) updateLayoutData: (NSArray< ZoomSDKCustomImmersiveLayoutData * > *) dataArray

Update the layout data.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function returns an error.

◆ viewShare:

- (ZoomSDKError) viewShare: (unsigned int) shareSourceID

Update the share source ID to view share, available only for host.

Parameters

shareSourceID The sepecified source ID.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise fails. To get extended error information, see ZoomSDKError.

Property Documentation

◆ delegate

- (id<ZoomSDKCustomImmersiveDelegate>) delegate

readwritenonatomicassign

Definition at line 185 of file ZoomSDKCustomImmersiveController.h.

Instance Methods

Properties

Detailed Description

Method Documentation

◆ addCustomImageTemplate:template:

◆ assignUser:seatID:

◆ canStartImmersiveView:

◆ canUserShowInImmersiveView:

◆ changeTemplate:

◆ createImmersiveContainer:

◆ destroyImmersiveContainer

◆ downloadTemplate:

◆ downloadTemplateThumbnails

◆ endImmersiveView

◆ getCurrentTemplate

◆ getLayoutData

◆ getTemplates

◆ getViewingShareSourceID:

◆ isImmersiveViewOn

◆ isInImmersiveShareMode:

◆ isSupportImmersive

◆ isTemplateThumbnailsReady

◆ isUserInImmersiveView:

◆ putUserToFreeSeat:pos:

◆ removeCustomImageTemplate:

◆ removeUser:

◆ startImmersiveView:

◆ updateLayoutData:

◆ viewShare:

Property Documentation

◆ delegate