Mac SDK
Instance Methods | List of all members
CustomizedRecordingLayoutHelper Class Reference
Inheritance diagram for CustomizedRecordingLayoutHelper:

Instance Methods

(int) - getSupportLayoutMode
 Get the layout mode supported by the current meeting. More...
 
(NSArray *) - getValidVideoSource
 Get the list of users whose video source is available. More...
 
(NSArray *) - getValidRecivedShareSource
 Get available shared source received by users. More...
 
(BOOL) - isSendingShareSourceAvailable
 Query if sending shared source is available. More...
 
(BOOL) - haveActiveVideoSource
 Determine if there exists the active video source. More...
 
(ZoomSDKError) - selectRecordingLayoutMode:
 Select layout mode for recording. More...
 
(ZoomSDKError) - addVideoSourceToResArray:
 Add the video source of specified user to the list of recorded videos. More...
 
(ZoomSDKError) - selectActiveVideoSource
 Add active video source to the array. More...
 
(ZoomSDKError) - selectShareSource:
 Select shared source of the specified user. More...
 
(ZoomSDKError) - selectSendShareSource
 Select shared source of the current user. More...
 

Method Documentation

◆ addVideoSourceToResArray:

- (ZoomSDKError) addVideoSourceToResArray: (unsigned int)  userid

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

Parameters
useridThe ID of specified user.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise not.

◆ getSupportLayoutMode

- (int) getSupportLayoutMode

Get the layout mode supported by the current meeting.

Returns
If the function succeeds, it will return the layout mode. The value is the 'bitwise OR' of each supported layout mode.

◆ getValidRecivedShareSource

- (NSArray*) getValidRecivedShareSource

Get available shared source received by users.

Returns
If the function succeeds, it will return a NSArray including all valid shared source received by users.

◆ getValidVideoSource

- (NSArray*) getValidVideoSource

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.

◆ haveActiveVideoSource

- (BOOL) haveActiveVideoSource

Determine if there exists the active video source.

Returns
YES means existing, otherwise not.

◆ isSendingShareSourceAvailable

- (BOOL) isSendingShareSourceAvailable

Query if sending shared source is available.

Returns
YES means available, otherwise not.

◆ selectActiveVideoSource

- (ZoomSDKError) selectActiveVideoSource

Add active video source to the array.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise not.
Note
It works only when RecordingLayoutMode is RecordingLayoutMode_VideoWall or RecordingLayoutMode_VideoShare.

◆ selectRecordingLayoutMode:

- (ZoomSDKError) selectRecordingLayoutMode: (RecordingLayoutMode)  mode

Select layout mode for recording.

Parameters
modeThe layout mode for recording.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise not.

◆ selectSendShareSource

- (ZoomSDKError) selectSendShareSource

Select shared source of the current user.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise not.
Note
It works only when RecordingLayoutMode is RecordingLayoutMode_OnlyShare.

◆ selectShareSource:

- (ZoomSDKError) selectShareSource: (unsigned int)  userid

Select shared source of the specified user.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise not.
Note
It works only when RecordingLayoutMode is RecordingLayoutMode_OnlyShare.

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