ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
ICustomizedLocalRecordingLayoutHelper Class Referenceabstract

Public Member Functions

virtual int GetSupportLayout ()=0
 Get the layout mode supported by the current meeting. see RECORDING_LAYOUT_MODE enum. More...
 
virtual IList< unsigned int > * GetValidVideoSourceList ()=0
 Get the list of users whose video source is available. More...
 
virtual IList< unsigned int > * GetValidRecvSharingSourceList ()=0
 Get the available list of users who can receive the shared content. More...
 
virtual bool IsSendSharingSourceAvailable ()=0
 Determine if there exists user who is sharing the content. More...
 
virtual bool HasActiveVideoSource ()=0
 Determine if there exists the active video source. More...
 
virtual SDKError SelectRecordingLayoutMode (RECORDING_LAYOUT_MODE mode_)=0
 Set the specified recording layout mode. More...
 
virtual SDKError AddVideoSourceToRecList (unsigned int user_id)=0
 Add the video source of specified user to the list of videos recorded. More...
 
virtual SDKError SelectActiveVideoSource ()=0
 Choose the current active video source. More...
 
virtual SDKError SelectRecvSharingSource (unsigned int user_id)=0
 Choose the video source in the list of shared content via specified user ID. More...
 
virtual SDKError SelectSendSharingSource ()=0
 Mark the found video source that sends shared content. More...
 

Member Function Documentation

◆ AddVideoSourceToRecList()

virtual SDKError ICustomizedLocalRecordingLayoutHelper::AddVideoSourceToRecList ( unsigned int  user_id)
pure virtual

Add the video source of specified user to the list of videos recorded.

Parameters
user_idSpecify the user ID.
Returns
If the function succeeds, the return value is SDKErr_SUCCESS. If the specified user is out of the list of available video source, it returns SDKERR_INVALID_PARAMETER.

◆ GetSupportLayout()

virtual int ICustomizedLocalRecordingLayoutHelper::GetSupportLayout ( )
pure virtual

Get the layout mode supported by the current meeting. see RECORDING_LAYOUT_MODE enum.

Returns
If the function succeeds, the return value is the layout type supported by the current meeting. For more details, see RECORDING_LAYOUT_MODE enum.

◆ GetValidRecvSharingSourceList()

virtual IList<unsigned int >* ICustomizedLocalRecordingLayoutHelper::GetValidRecvSharingSourceList ( )
pure virtual

Get the available list of users who can receive the shared content.

Returns
The available list of users who can receive the shared content. ZERO(0) indicates that there is no available users.
Remarks
The value saved in the list is the user ID.

◆ GetValidVideoSourceList()

virtual IList<unsigned int >* ICustomizedLocalRecordingLayoutHelper::GetValidVideoSourceList ( )
pure virtual

Get the list of users whose video source is available.

Returns
The list of users. ZERO(0) indicates that there is no available video source of users.
Remarks
The value saved in the list is the user ID.

◆ HasActiveVideoSource()

virtual bool ICustomizedLocalRecordingLayoutHelper::HasActiveVideoSource ( )
pure virtual

Determine if there exists the active video source.

Returns
TRUE indicates that there is the active video source.

◆ IsSendSharingSourceAvailable()

virtual bool ICustomizedLocalRecordingLayoutHelper::IsSendSharingSourceAvailable ( )
pure virtual

Determine if there exists user who is sharing the content.

Returns
TRUE indicates that there is user who is sharing the content.

◆ SelectActiveVideoSource()

virtual SDKError ICustomizedLocalRecordingLayoutHelper::SelectActiveVideoSource ( )
pure virtual

Choose the current active video source.

Returns
If the function succeeds, the return value is SDKErr_SUCCESS. Otherwise returns the SDKERR_INVALID_PARAMETER.

◆ SelectRecordingLayoutMode()

virtual SDKError ICustomizedLocalRecordingLayoutHelper::SelectRecordingLayoutMode ( RECORDING_LAYOUT_MODE  mode_)
pure virtual

Set the specified recording layout mode.

Parameters
mode_Specify the recording layout mode that you want. For more details, see RECORDING_LAYOUT_MODE enum.
Returns
If the function succeeds, the return value is SDKErr_SUCCESS. Otherwise returns the RECORDING_LAYOUT_MODE.

◆ SelectRecvSharingSource()

virtual SDKError ICustomizedLocalRecordingLayoutHelper::SelectRecvSharingSource ( unsigned int  user_id)
pure virtual

Choose the video source in the list of shared content via specified user ID.

Parameters
user_idSpecify the user ID.
Returns
If the function succeeds, the return value is SDKErr_SUCCESS. If the specified user ID is out of the list to receive the shared content, it returns SDKERR_INVALID_PARAMETER.

◆ SelectSendSharingSource()

virtual SDKError ICustomizedLocalRecordingLayoutHelper::SelectSendSharingSource ( )
pure virtual

Mark the found video source that sends shared content.

Returns
If the function succeeds,the return value is SDKErr_SUCCESS. If there is no user who is sending the sharing, it returns SDKERR_WRONG_USEAGE.

The documentation for this class was generated from the following file: