CustomizedRecordingLayoutHelper Class Reference

Helper class to customize recording layout during meetings. More...

#include <ZoomSDKMeetingRecordController.h>

Inherits NSObject.

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

Detailed Description

Helper class to customize recording layout during meetings.

Definition at line 34 of file ZoomSDKMeetingRecordController.h.

Method Documentation

addVideoSourceToResArray:

- (ZoomSDKError) addVideoSourceToResArray:

(unsigned int)

userid

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

Parameters

userid

The 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.

getValidReceivedShareSource

- (NSArray *) getValidReceivedShareSource

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 the ZoomSDKError_Success, otherwise failed.

Note

It works only when RecordingLayoutMode is or RecordingLayoutMode_VideoShare.

selectRecordingLayoutMode:

- (ZoomSDKError) selectRecordingLayoutMode:

(RecordingLayoutMode)

mode

Select layout mode for recording.

Parameters

mode	The 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 the ZoomSDKError_Success, otherwise failed.

Note

It works only when RecordingLayoutMode is RecordingLayoutMode_OnlyShare.

selectShareSource:

- (ZoomSDKError) selectShareSource:

(unsigned int)

shareSourceID

Select the shared source of the specified user.

Parameters

shareSourceID

The share source ID of specified user.

Returns

If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.

Note

It works only when RecordingLayoutMode is RecordingLayoutMode_OnlyShare.