|
Meeting SDK for macOS API 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 |
| 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. | |
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.
| - (ZoomSDKError) addCustomImageTemplate: | (NSString *) | filePath | |
| template: | (ZoomSDKCustomImmersiveTemplate *_Nullable *_Nonnull) | immersiveTemplate |
Adds a template based on a custom image.
| filePath | The image file path. |
| immersiveTemplate | If the function succeeds, the object will be ZoomSDKCustomImmersiveTemplate, this function fails and returns nil. |
| - (ZoomSDKError) assignUser: | (unsigned int) | userID | |
| seatID: | (NSString *) | seatID |
Put the user in the seat.
| userID | The user ID. |
| seatID | The seat ID. |
| - (BOOL) canStartImmersiveView: | (ZoomSDKCustomImmersiveTemplate *) | immersiveTemplate |
Determines if the immersive template can be started.
| immersiveTemplate | The selected template in immersive view. |
| - (BOOL) canUserShowInImmersiveView: | (unsigned int) | userID |
Determines if the user can be shown in immersive view.
| userID | The user ID. |
| - (ZoomSDKError) changeTemplate: | (ZoomSDKCustomImmersiveTemplate *) | immersiveTemplate |
Change template in immersive view.
| immersiveTemplate | The selected template in immersive view. |
| - (ZoomSDKCustomImmersiveContainer *_Nullable) createImmersiveContainer: | (NSRect) | rect |
Creates the immersive container for customUI.
| rect | Specify the position of client area of the immersive container. |
| - (ZoomSDKError) destroyImmersiveContainer |
Destroy the immersive container. Once destroyed, the container can no longer be used.
References destroyImmersiveContainer.
Referenced by destroyImmersiveContainer.
| - (ZoomSDKError) downloadTemplate: | (ZoomSDKCustomImmersiveTemplate *) | immersiveTemplate |
Download complete template resource.
| immersiveTemplate | The template be downloaded. |
| - (ZoomSDKError) downloadTemplateThumbnails |
Download the template thumbnails. See ZoomSDKCustomImmersiveDelegate for updates on the download.
ZoomSDKError_Success. Otherwise, this function returns an error. References downloadTemplateThumbnails.
Referenced by downloadTemplateThumbnails.
| - (ZoomSDKError) endImmersiveView |
Exit immersive view.
References endImmersiveView.
Referenced by endImmersiveView.
| - (ZoomSDKCustomImmersiveTemplate *_Nullable) getCurrentTemplate |
Gets the current template.
References getCurrentTemplate.
Referenced by getCurrentTemplate.
| - (NSArray< ZoomSDKCustomImmersiveLayoutData * > *_Nullable) getLayoutData |
Gets the immersive seat layout data.
References getLayoutData.
Referenced by getLayoutData.
| - (NSArray< ZoomSDKCustomImmersiveTemplate * > *_Nullable) getTemplates |
Gets the list of templates.
References getTemplates.
Referenced by getTemplates.
| - (ZoomSDKError) getViewingShareSourceID: | (unsigned int *) | shareSourceID |
Query the share source ID when viewing share in immersive mode. Only available for host.
| shareSourceID | The specified source ID. |
| - (BOOL) isImmersiveViewOn |
Determines if immersive view is active.
References isImmersiveViewOn.
Referenced by isImmersiveViewOn.
| - (ZoomSDKError) isInImmersiveShareMode: | (BOOL *) | bInShare |
Determines if displaying sharing contents in immersive mode.
| bInShare | YES if displaying sharing contents in immersive mode, NO otherwise. |
| - (BOOL) isSupportImmersive |
Determines if immersive is supported.
References isSupportImmersive.
Referenced by isSupportImmersive.
| - (BOOL) isTemplateThumbnailsReady |
Determines if the thumbnails are ready.
References isTemplateThumbnailsReady.
Referenced by isTemplateThumbnailsReady.
| - (BOOL) isUserInImmersiveView: | (unsigned int) | userID |
Determines if the user is in immersive view.
| userID | The user ID. |
| - (ZoomSDKError) putUserToFreeSeat: | (unsigned int) | userID | |
| pos: | (NSRect) | pos |
Put the user in the free seat.
| userID | The user ID. |
| pos | The position. |
| - (ZoomSDKError) removeCustomImageTemplate: | (ZoomSDKCustomImmersiveTemplate *) | immersiveTemplate |
Removes custom immersive template.
| immersiveTemplate | The custom image template that want to remove. |
| - (ZoomSDKError) removeUser: | (unsigned int) | userID |
Removes user from immersive view.
| userID | The user ID. |
| - (ZoomSDKError) startImmersiveView: | (ZoomSDKCustomImmersiveTemplate *) | immersiveTemplate |
Starts immersive view.
| immersiveTemplate | The selected template in immersive view. |
| - (ZoomSDKError) updateLayoutData: | (NSArray< ZoomSDKCustomImmersiveLayoutData * > *) | dataArray |
Updates the layout data.
param dataArray An array of ZoomSDKCustomImmersiveLayoutData objects representing the new layout data.
| - (ZoomSDKError) viewShare: | (unsigned int) | shareSourceID |
Updates the share source ID to view share, available only for host.
| shareSourceID | The sepecified source ID. |
|
readwritenonatomicassign |
Delegate to receive callbacks related to immersive view events.
Definition at line 215 of file ZoomSDKCustomImmersiveController.h.