ICustomImmersivePreLayoutHelper Class Reference

Immersive pre-layout helper interface to update immersive view layout at once. More...

#include <customized_immersive.h>

Public Member Functions
virtual SDKError	addUser (unsigned int userID, unsigned int seatID)=0
	Add a user to the pre-layout with a seat ID.
virtual SDKError	addUser (unsigned int userID, RECT pos)=0
	Add a user to the pre-layout with a position.
virtual SDKError	removeUser (unsigned int userID)=0
	Remove a user from the pre-layout.
virtual SDKError	removeAllUsers ()=0
	Remove all users from the pre-layout.
virtual IList< CustomImmersiveLayoutData > *	getPreLayoutData ()=0
	Get the pre-layout data.
virtual SDKError	commit ()=0
	Commit pre-layout data to immersive view. This only works just after the immersive view starts.
virtual	~ICustomImmersivePreLayoutHelper ()

Detailed Description

Immersive pre-layout helper interface to update immersive view layout at once.

Definition at line 117 of file customized_immersive.h.

Constructor & Destructor Documentation

~ICustomImmersivePreLayoutHelper()

virtual ICustomImmersivePreLayoutHelper::~ICustomImmersivePreLayoutHelper ( )

inlinevirtual

Definition at line 154 of file customized_immersive.h.

{}

Member Function Documentation

addUser() [1/2]

virtual SDKError ICustomImmersivePreLayoutHelper::addUser ( unsigned int userID, RECT pos )

pure virtual

Add a user to the pre-layout with a position.

Parameters

userID	The user ID.
pos	The position.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, the function returns an error. To get extended error information, see SDKError enum.

addUser() [2/2]

virtual SDKError ICustomImmersivePreLayoutHelper::addUser ( unsigned int userID, unsigned int seatID )

pure virtual

Add a user to the pre-layout with a seat ID.

Parameters

userID	The user ID.
seatID	The seat ID.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, the function returns an error. To get extended error information, see SDKError enum.

commit()

virtual SDKError ICustomImmersivePreLayoutHelper::commit ( )

pure virtual

Commit pre-layout data to immersive view. This only works just after the immersive view starts.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS and the user list will be cleaned up. Otherwise, the function returns an error. To get extended error information, see SDKError enum.

getPreLayoutData()

virtual IList< CustomImmersiveLayoutData > * ICustomImmersivePreLayoutHelper::getPreLayoutData ( )

pure virtual

Get the pre-layout data.

Returns

The pre-layout data. ZERO(0) indicates that there are no user in the pre-layout. For more details, see CustomImmersiveLayoutData.

removeAllUsers()

virtual SDKError ICustomImmersivePreLayoutHelper::removeAllUsers ( )

pure virtual

Remove all users from the pre-layout.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, the function returns an error. To get extended error information, see SDKError enum.

removeUser()

virtual SDKError ICustomImmersivePreLayoutHelper::removeUser ( unsigned int userID )

pure virtual

Remove a user from the pre-layout.

Parameters

userID

The user ID.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, the function returns an error. To get extended error information, see SDKError enum.