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

#include <customized_immersive.h>

Public Member Functions
virtual SDKError	SetEvent (ICustomImmersiveCtrlEvent *pEvent)=0
	Set immersive object callback event handler.

virtual SDKError	isSupportImmersive (bool &bSupport)=0
	Determine if immersive is supported.

virtual SDKError	isImmersiveViewOn (bool &bOn)=0
	Determine if immersive view is active.

virtual SDKError	downloadTemplateThumbnails ()=0
	Download the template thumbnails. See /link ICustomImmersiveCtrlEvent /endlink for updates on the download.

virtual SDKError	isTemplateThumbnailsReady (bool &bReady)=0
	Determine if the thumbnails are ready.

virtual IList< ICustomImmersiveTemplate * > *	getTemplates ()=0
	Get the list of templates.

virtual SDKError	downloadTemplate (ICustomImmersiveTemplate *immersiveTemplate)=0
	Download complete template resource.

virtual SDKError	canStartImmersiveView (ICustomImmersiveTemplate *immersiveTemplate, bool &bCan)=0
	Determine if the immersive template can be started.

virtual SDKError	startImmersiveView (ICustomImmersiveTemplate *immersiveTemplate)=0
	Start immersive view.

virtual SDKError	changeTemplate (ICustomImmersiveTemplate *immersiveTemplate)=0
	Change template in immersive view.

virtual SDKError	endImmersiveView ()=0
	Exit immersive view.

virtual ICustomImmersiveTemplate *	getCurrentTemplate ()=0
	Get the current template.

virtual SDKError	canUserShowInImmersiveView (unsigned int userID, bool &bCan)=0
	Determine if the user can be shown in immersive view.

virtual ICustomImmersivePreLayoutHelper *	getImmersivePreLayoutHelper ()=0
	Get the immersive pre-layout helper pointer.

virtual IList< CustomImmersiveLayoutData > *	getLayoutData ()=0
	Get the immersive seat layout data.

virtual SDKError	assignUser (unsigned int userID, unsigned int seatID)=0
	Put the user in the seat.

virtual SDKError	putUserToFreeSeat (unsigned int userID, RECT pos)=0
	Put the user in the free seat.

virtual SDKError	removeUser (unsigned int userID)=0
	Remove user from immersive view.

virtual SDKError	isUserInImmersiveView (unsigned int userID, bool &bIn)=0
	Determine if the user is in immersive view.

virtual SDKError	addCustomImageTemplate (const zchar_t filePath, ICustomImmersiveTemplate *immersiveTemplate)=0
	Add a template based on a custom image.

virtual SDKError	removeCustomImageTemplate (ICustomImmersiveTemplate *immersiveTemplate)=0
	Remove custom image template.

virtual SDKError	isInImmersiveShareMode (bool &bInShare)=0
	Determine if displaying sharing contents in immersive mode.

virtual SDKError	viewShare (unsigned int shareSourceID)=0
	Update the share source ID to view share, only available for host.

virtual SDKError	getViewingShareSourceID (unsigned int &shareSourceID)=0
	Query the share source ID when viewing share in immersive mode, only available for host.

virtual	~ICustomImmersiveController ()

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 193 of file customized_immersive.h.

Constructor & Destructor Documentation

◆ ~ICustomImmersiveController()

virtual ICustomImmersiveController::~ICustomImmersiveController ( )

inlinevirtual

Definition at line 337 of file customized_immersive.h.

337{}

Member Function Documentation

◆ addCustomImageTemplate()

virtual SDKError ICustomImmersiveController::addCustomImageTemplate	(	const zchar_t *	filePath,
		ICustomImmersiveTemplate **	immersiveTemplate )

pure virtual

Add a template based on a custom image.

Parameters

	filePath	The image file path.
[out]	immersiveTemplate	The object of custom template. For more details, see ICustomImmersiveTemplate.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ assignUser()

virtual SDKError ICustomImmersiveController::assignUser	(	unsigned int	userID,
		unsigned int	seatID )

pure virtual

Put the user in the seat.

Parameters

userID	The user ID.
seatID	The seat ID.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ canStartImmersiveView()

virtual SDKError ICustomImmersiveController::canStartImmersiveView	(	ICustomImmersiveTemplate *	immersiveTemplate,
		bool &	bCan )

pure virtual

Determine if the immersive template can be started.

Parameters

	immersiveTemplate	The selected template in immersive view. For more details, see ICustomImmersiveTemplate.
[out]	bCan	True means the immersive can be started, false not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ canUserShowInImmersiveView()

virtual SDKError ICustomImmersiveController::canUserShowInImmersiveView	(	unsigned int	userID,
		bool &	bCan )

pure virtual

Determine if the user can be shown in immersive view.

Parameters

	userID	The user ID.
[out]	bCan	True means the user can be shown in immersive view, false if they cannot.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ changeTemplate()

virtual SDKError ICustomImmersiveController::changeTemplate ( ICustomImmersiveTemplate * immersiveTemplate )

pure virtual

Change template in immersive view.

Parameters

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

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ downloadTemplate()

virtual SDKError ICustomImmersiveController::downloadTemplate ( ICustomImmersiveTemplate * immersiveTemplate )

pure virtual

Download complete template resource.

Parameters

immersiveTemplate The template to be downloaded. For more details, see ICustomImmersiveTemplate.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ downloadTemplateThumbnails()

virtual SDKError ICustomImmersiveController::downloadTemplateThumbnails ( )

pure virtual

Download the template thumbnails. See /link ICustomImmersiveCtrlEvent /endlink for updates on the download.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ endImmersiveView()

virtual SDKError ICustomImmersiveController::endImmersiveView ( )

pure virtual

Exit immersive view.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ getCurrentTemplate()

virtual ICustomImmersiveTemplate * ICustomImmersiveController::getCurrentTemplate ( )

pure virtual

Get the current template.

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

◆ getImmersivePreLayoutHelper()

virtual ICustomImmersivePreLayoutHelper * ICustomImmersiveController::getImmersivePreLayoutHelper ( )

pure virtual

Get the immersive pre-layout helper pointer.

Returns: If the function succeeds, the return value is the immersive layout helper pointer. For more details, see ICustomImmersiveLayoutHelper.

◆ getLayoutData()

virtual IList< CustomImmersiveLayoutData > * ICustomImmersiveController::getLayoutData ( )

pure virtual

Get the immersive seat layout data.

Returns: The immersive seat layout data. ZERO(0) indicates that there are no users in the immersive view. For more details, see CustomImmersiveLayoutData.

◆ getTemplates()

virtual IList< ICustomImmersiveTemplate * > * ICustomImmersiveController::getTemplates ( )

pure virtual

Get the list of templates.

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

◆ getViewingShareSourceID()

virtual SDKError ICustomImmersiveController::getViewingShareSourceID ( unsigned int & shareSourceID )

pure virtual

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

Parameters

[out] shareSourceID The sepecified share source ID.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ isImmersiveViewOn()

virtual SDKError ICustomImmersiveController::isImmersiveViewOn ( bool & bOn )

pure virtual

Determine if immersive view is active.

Parameters

[out] bOn True means the immersive view is active. Otherwise, false.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ isInImmersiveShareMode()

virtual SDKError ICustomImmersiveController::isInImmersiveShareMode ( bool & bInShare )

pure virtual

Determine if displaying sharing contents in immersive mode.

Parameters

[out] bInShare True means displaying sharing contents in immersive mode, false means that they are not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ isSupportImmersive()

virtual SDKError ICustomImmersiveController::isSupportImmersive ( bool & bSupport )

pure virtual

Determine if immersive is supported.

Parameters

[out] bSupport True means support immersive. Otherwise, false.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ isTemplateThumbnailsReady()

virtual SDKError ICustomImmersiveController::isTemplateThumbnailsReady ( bool & bReady )

pure virtual

Determine if the thumbnails are ready.

Parameters

[out] bReady True means the immersive thumbnails is ready, false not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ isUserInImmersiveView()

virtual SDKError ICustomImmersiveController::isUserInImmersiveView	(	unsigned int	userID,
		bool &	bIn )

pure virtual

Determine if the user is in immersive view.

Parameters

	userID	The user ID.
[out]	bIn	True means the user is in immersive view, false means that they are not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ putUserToFreeSeat()

virtual SDKError ICustomImmersiveController::putUserToFreeSeat	(	unsigned int	userID,
		RECT	pos )

pure virtual

Put the user in the free seat.

Parameters

userID	The user ID.
pos	The position.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ removeCustomImageTemplate()

virtual SDKError ICustomImmersiveController::removeCustomImageTemplate ( ICustomImmersiveTemplate * immersiveTemplate )

pure virtual

Remove custom image template.

Parameters

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

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ removeUser()

virtual SDKError ICustomImmersiveController::removeUser ( unsigned int userID )

pure virtual

Remove user from immersive view.

Parameters

userID The user ID.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual SDKError ICustomImmersiveController::SetEvent ( ICustomImmersiveCtrlEvent * pEvent )

pure virtual

Set immersive object callback event handler.

Parameters

pEvent A pointer to the ICustomImmersiveCtrlEvent that receives the immersive object events. For more details, see ICustomImmersiveCtrlEvent.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.

◆ startImmersiveView()

virtual SDKError ICustomImmersiveController::startImmersiveView ( ICustomImmersiveTemplate * immersiveTemplate )

pure virtual

Start immersive view.

Parameters

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

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. remarks For the host, it must be started after the immersive container is created. Otherwise, failed. To get extended error information, see SDKError enum.

◆ viewShare()

virtual SDKError ICustomImmersiveController::viewShare ( unsigned int shareSourceID )

pure virtual

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

Parameters

shareSourceID The sepecified share source ID.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, failed. To get extended error information, see SDKError enum.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ICustomImmersiveController()

Member Function Documentation

◆ addCustomImageTemplate()

◆ assignUser()

◆ canStartImmersiveView()

◆ canUserShowInImmersiveView()

◆ changeTemplate()

◆ downloadTemplate()

◆ downloadTemplateThumbnails()

◆ endImmersiveView()

◆ getCurrentTemplate()

◆ getImmersivePreLayoutHelper()

◆ getLayoutData()

◆ getTemplates()

◆ getViewingShareSourceID()

◆ isImmersiveViewOn()

◆ isInImmersiveShareMode()

◆ isSupportImmersive()

◆ isTemplateThumbnailsReady()

◆ isUserInImmersiveView()

◆ putUserToFreeSeat()

◆ removeCustomImageTemplate()

◆ removeUser()

◆ SetEvent()

◆ startImmersiveView()

◆ viewShare()