Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ISetVideoOrderHelper Class Referenceabstract

set video order helper interface. More...

#include <meeting_video_interface.h>

Public Member Functions

virtual SDKError SetVideoOrderTransactionBegin ()=0
 Prepare to make a new video order.
 
virtual bool AddVideoToOrder (unsigned int userId, unsigned int position)=0
 Add the assigned user into the prepared video order.
 
virtual SDKError SetVideoOrderTransactionCommit ()=0
 make a new video order.
 

Detailed Description

set video order helper interface.

Definition at line 82 of file meeting_video_interface.h.

Member Function Documentation

◆ AddVideoToOrder()

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

Add the assigned user into the prepared video order.

Parameters
userId,theuser you want to add into the prepared video order.
position,theposition you want to place in the prepared video order.
Returns
true if user is added to the prepared video order successfully.
Remarks
The max number of the prepared video order is 49. If you assign many userId with a same order, only the last one will be applied. \Remark SetVideoOrderTransactionBegin() must be called before this function is called. Otherwise false will be returned.

◆ SetVideoOrderTransactionBegin()

virtual SDKError ISetVideoOrderHelper::SetVideoOrderTransactionBegin ( )
pure virtual

Prepare to make a new video order.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum
Remarks
If the function succeeds, the prepared video order you added by calling AddVideoToOrder will be cleared.

◆ SetVideoOrderTransactionCommit()

virtual SDKError ISetVideoOrderHelper::SetVideoOrderTransactionCommit ( )
pure virtual

make a new video order.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum \Remarks SetVideoOrderTransactionBegin() must be called before this function is called. Otherwise SDKErr_WRONG_USAGE will be returned.