set video order helper interface. More...

Public Member Functions
virtual SDKError	SetVideoOrderTransactionBegin ()=0
	Prepares to make a new video order.

virtual bool	AddVideoToOrder (unsigned int userId, unsigned int position)=0
	Adds the assigned user into the prepared video order.

virtual SDKError	SetVideoOrderTransactionCommit ()=0
	Makes a new video order.

Detailed Description

set video order helper interface.

Definition at line 99 of file meeting_video_interface.h.

Member Function Documentation

virtual bool ISetVideoOrderHelper::AddVideoToOrder	(	unsigned int	userId,
		unsigned int	position )

pure virtual

Adds the assigned user into the prepared video order.

Parameters

userId	The user you want to add into the prepared video order.
position	The position you want to place in the prepared video order.

Returns: true if the user is added to the prepared video order successfully. Otherwise, false.

Note: The max number of the prepared video order is 49. If you assign many userId with the same order, only the last one will be applied.; SetVideoOrderTransactionBegin() must be called before this function is called. Otherwise, false will be returned.

virtual SDKError ISetVideoOrderHelper::SetVideoOrderTransactionBegin ( )

pure virtual

Prepares to make a new video order.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: If the function succeeds, the prepared video order you added by calling AddVideoToOrder will be cleared.

virtual SDKError ISetVideoOrderHelper::SetVideoOrderTransactionCommit ( )

pure virtual

Makes a new video order.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: SetVideoOrderTransactionBegin() must be called before this function is called. Otherwise, SDKERR_WRONG_USAGE will be returned.