ICustomImmersiveTemplate Class Reference

Immersive template object interface. More...

#include <customized_immersive.h>

Public Member Functions
virtual const zchar_t *	getTemplateName ()=0
	Gets the name of this template.
virtual const void *	getThumbnailBitmap ()=0
	Gets the bitmap of the thumbnail.
virtual unsigned int	getCapacity ()=0
	Gets the capacity of this template.
virtual bool	isTemplateReady ()=0
	Determines if this template is ready.
virtual bool	isSupportFreeSeat ()=0
	Determines whether this template supports a free seat.
virtual CustomImmersiveTemplateType	getType ()=0
	Gets the type of this template.
virtual ICustomImmersiveTemplateData *	getShareTemplateData ()=0
	Gets the template data of immersive when in share mode.
virtual ICustomImmersiveTemplateData *	getVideoTemplateData ()=0
	Gets the template data of immersive when in default mode.
virtual	~ICustomImmersiveTemplate ()

Detailed Description

Immersive template object interface.

Definition at line 94 of file customized_immersive.h.

Constructor & Destructor Documentation

~ICustomImmersiveTemplate()

virtual ICustomImmersiveTemplate::~ICustomImmersiveTemplate ( )

inlinevirtual

Definition at line 145 of file customized_immersive.h.

{}

Member Function Documentation

getCapacity()

virtual unsigned int ICustomImmersiveTemplate::getCapacity ( )

pure virtual

Gets the capacity of this template.

Returns

If the function succeeds, it returns the seat capacity of this template.

getShareTemplateData()

virtual ICustomImmersiveTemplateData * ICustomImmersiveTemplate::getShareTemplateData ( )

pure virtual

Gets the template data of immersive when in share mode.

Returns

If the function succeeds, it returns the template data of immersive when in share mode. Otherwise, this function fails and returns nullptr.

getTemplateName()

virtual const zchar_t * ICustomImmersiveTemplate::getTemplateName ( )

pure virtual

Gets the name of this template.

Returns

If the function succeeds, it returns the name of this template. Otherwise, this function fails and returns nullptr.

getThumbnailBitmap()

virtual const void * ICustomImmersiveTemplate::getThumbnailBitmap ( )

pure virtual

Gets the bitmap of the thumbnail.

Returns

If the function succeeds, it returns the bitmap of this thumbnail. Otherwise, this function fails and returns nullptr.

getType()

virtual CustomImmersiveTemplateType ICustomImmersiveTemplate::getType ( )

pure virtual

Gets the type of this template.

Returns

If the function succeeds, it returns the type of this template.

getVideoTemplateData()

virtual ICustomImmersiveTemplateData * ICustomImmersiveTemplate::getVideoTemplateData ( )

pure virtual

Gets the template data of immersive when in default mode.

Returns

If the function succeeds, it returns the template data of immersive when in default mode. Otherwise, this function fails and returns nullptr.

isSupportFreeSeat()

virtual bool ICustomImmersiveTemplate::isSupportFreeSeat ( )

pure virtual

Determines whether this template supports a free seat.

Returns

true indicates that the user can be put to free seat in this template.

isTemplateReady()

virtual bool ICustomImmersiveTemplate::isTemplateReady ( )

pure virtual

Determines if this template is ready.

Returns

true indicates that this template is ready.