Interface for controlling the meeting immersive view feature. For more information 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
	Determines if immersive view is active.

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

(ZoomSDKError)	- viewShare:
	Updates 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
	Determines if immersive is supported.

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

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

(ZoomSDKError)	- startImmersiveView:
	Starts immersive view.

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

(ZoomSDKError)	- endImmersiveView
	Exit immersive view.

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

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

(ZoomSDKError)	- updateLayoutData:
	Updates the layout data.

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

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

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

(BOOL)	- isUserInImmersiveView:
	Determines 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:
	Adds a template based on a custom image.

(ZoomSDKError)	- removeCustomImageTemplate:
	Removes custom immersive template.

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

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

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

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

Properties
id< ZoomSDKCustomImmersiveDelegate >	delegate
	Delegate to receive callbacks related to immersive view events.

Detailed Description

Interface for controlling the meeting immersive view feature. For more information on this feature, see https://support.zoom.us/hc/en-us/articles/360060220511-Immersive-View.

Definition at line 211 of file ZoomSDKCustomImmersiveController.h.

Method Documentation

◆ addCustomImageTemplate:template:

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

Adds a template based on a custom image.

Parameters

filePath	The image file path.
immersiveTemplate	If the function succeeds, the object will be ZoomSDKCustomImmersiveTemplate, this function fails and returns nil.

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

◆ 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, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ canStartImmersiveView:

- (BOOL) canStartImmersiveView: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Determines if the immersive template can be started.

Parameters

immersiveTemplate The selected template in immersive view.

Returns: YES if the immersive can be started. Otherwise, NO.

◆ canUserShowInImmersiveView:

- (BOOL) canUserShowInImmersiveView: (unsigned int) userID

Determines if the user can be shown in immersive view.

Parameters

userID The user ID.

Returns: YES if the user can be shown in immersive view. Otherwise, NO.

◆ changeTemplate:

- (ZoomSDKError) changeTemplate: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Change template in immersive view.

Parameters

immersiveTemplate The selected template in immersive view.

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

◆ createImmersiveContainer:

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

Creates the immersive container for customUI.

Parameters

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

Returns: If the function succeeds, it returns the object of ZoomSDKCustomImmersiveContainer. Otherwise, this function fails and returns nil.

◆ destroyImmersiveContainer

- (ZoomSDKError) destroyImmersiveContainer

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

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

◆ downloadTemplate:

- (ZoomSDKError) downloadTemplate: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Download complete template resource.

Parameters

immersiveTemplate The template be downloaded.

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

◆ downloadTemplateThumbnails

- (ZoomSDKError) downloadTemplateThumbnails

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

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

◆ endImmersiveView

- (ZoomSDKError) endImmersiveView

Exit immersive view.

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

◆ getCurrentTemplate

- (ZoomSDKCustomImmersiveTemplate *_Nullable) getCurrentTemplate

Gets the current template.

Returns: If the function succeeds, it returns the current template. Otherwise, this function fails and returns nil.

◆ getLayoutData

- (NSArray< ZoomSDKCustomImmersiveLayoutData * > *_Nullable) getLayoutData

Gets the immersive seat layout data.

Returns: If the function succeeds, it returns the immersive seat layout data. Otherwise, this function fails and returns nil.

◆ getTemplates

- (NSArray< ZoomSDKCustomImmersiveTemplate * > *_Nullable) getTemplates

Gets the list of templates.

Returns: The list of templates. ZERO(0) indicates that there are no templates. Otherwise, this function fails and returns nil.

◆ 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, this function returns an error.

◆ isImmersiveViewOn

- (BOOL) isImmersiveViewOn

Determines if immersive view is active.

Returns: YES if the immersive view is active. Otherwise, NO.

◆ isInImmersiveShareMode:

- (ZoomSDKError) isInImmersiveShareMode: (BOOL *) bInShare

Determines if displaying sharing contents in immersive mode.

Parameters

bInShare YES if displaying sharing contents in immersive mode, NO otherwise.

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

◆ isSupportImmersive

- (BOOL) isSupportImmersive

Determines if immersive is supported.

Returns: YES if support immersive. Otherwise, NO.

◆ isTemplateThumbnailsReady

- (BOOL) isTemplateThumbnailsReady

Determines if the thumbnails are ready.

Returns: YES if the immersive thumbnails are ready. Otherwise, NO.

◆ isUserInImmersiveView:

- (BOOL) isUserInImmersiveView: (unsigned int) userID

Determines if the user is in immersive view.

Parameters

userID The user ID.

Returns: YES if the user is in immersive view. Otherwise, NO.

◆ 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, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ removeCustomImageTemplate:

- (ZoomSDKError) removeCustomImageTemplate: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Removes custom immersive template.

Parameters

immersiveTemplate The custom image template that want to remove.

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

◆ removeUser:

- (ZoomSDKError) removeUser: (unsigned int) userID

Removes user from immersive view.

Parameters

userID The user ID.

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

◆ startImmersiveView:

- (ZoomSDKError) startImmersiveView: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Starts immersive view.

Parameters

immersiveTemplate The selected template in immersive view.

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

◆ updateLayoutData:

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

Updates the layout data.

Parameters

param dataArray An array of ZoomSDKCustomImmersiveLayoutData objects representing the new layout data.

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

◆ viewShare:

- (ZoomSDKError) viewShare: (unsigned int) shareSourceID

Updates 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.

Property Documentation

◆ delegate

- (id<ZoomSDKCustomImmersiveDelegate>) delegate

readwritenonatomicassign

Delegate to receive callbacks related to immersive view events.

Definition at line 215 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