Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKCustomImmersiveController Class Reference

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
 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< ZoomSDKCustomImmersiveDelegatedelegate
 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 

Add a template based on a custom image.

Parameters
filePathThe image file path.
immersiveTemplateIf the function succeeds, the object will be ZoomSDKCustomImmersiveTemplate, otherwise nil.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ assignUser:seatID:

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

Put the user in the seat.

Parameters
userIDThe user ID.
seatIDThe seat ID.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ canStartImmersiveView:

- (BOOL) canStartImmersiveView: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Determine if the immersive template can be started.

Parameters
immersiveTemplateThe selected template in immersive view.
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
userIDThe 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
immersiveTemplateThe selected template in immersive view.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ createImmersiveContainer:

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

Create the immersive container for customUI.

Parameters
rectSpecify 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
immersiveTemplateThe template be downloaded.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

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

◆ endImmersiveView

- (ZoomSDKError) endImmersiveView

Exit immersive view.

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

◆ getCurrentTemplate

- (ZoomSDKCustomImmersiveTemplate *_Nullable) getCurrentTemplate

Get the current template.

Returns
If the function succeeds, the return value is the current template.

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

◆ getViewingShareSourceID:

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

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

Parameters
shareSourceIDThe specified source ID.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise failed.

◆ 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
bInShareYES means displaying sharing contents in immersive mode. Otherwise NO.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ 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
userIDThe 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
userIDThe user ID.
posThe position.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ removeCustomImageTemplate:

- (ZoomSDKError) removeCustomImageTemplate: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Remove custom immersive template.

Parameters
immersiveTemplateThe custom image template that want to remove.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ removeUser:

- (ZoomSDKError) removeUser: (unsigned int) userID

Remove user from immersive view.

Parameters
userIDThe user ID.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ startImmersiveView:

- (ZoomSDKError) startImmersiveView: (ZoomSDKCustomImmersiveTemplate *) immersiveTemplate

Start immersive view.

Parameters
immersiveTemplateThe selected template in immersive view.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ updateLayoutData:

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

Update the layout data.

Parameters

param dataArray An array of ZoomSDKCustomImmersiveLayoutData objects representing the new 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
shareSourceIDThe 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.