CustomizedRecordingLayoutHelper Class Reference

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

#include <ZoomSDKMeetingRecordController.h>

Inherits NSObject.

Instance Methods
(int)	- getSupportLayoutMode
	Gets the layout mode supported by the current meeting.
(NSArray *)	- getValidVideoSource
	Gets the list of users whose video source is available.
(NSArray *)	- getValidReceivedShareSource
	Gets available shared source received by users.
(BOOL)	- isSendingShareSourceAvailable
	Query if sending shared source is available.
(BOOL)	- haveActiveVideoSource
	Determines if there exists the active video source.
(ZoomSDKError)	- selectRecordingLayoutMode:
	Select layout mode for recording.
(ZoomSDKError)	- addVideoSourceToResArray:
	Adds the video source of specified user to the list of recorded videos.
(ZoomSDKError)	- selectActiveVideoSource
	Adds active video source to the array.
(ZoomSDKError)	- selectShareSource:
	Select the specified's shared source 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

Adds 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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

getSupportLayoutMode

- (int) getSupportLayoutMode

Gets the layout mode supported by the current meeting.

Returns

If the function succeeds, it returns the layout mode. The value is the 'bitwise OR' of each supported layout mode. Otherwise, returns 0.

getValidReceivedShareSource

- (NSArray *) getValidReceivedShareSource

Gets available shared source received by users.

Returns

If the function succeeds, it returns a NSArray including all valid shared source received by users. Otherwise, this function fails and returns nil.

getValidVideoSource

- (NSArray *) getValidVideoSource

Gets 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. Otherwise, this function fails and returns nil.

haveActiveVideoSource

- (BOOL) haveActiveVideoSource

Determines if there exists the active video source.

Returns

YES if existing. Otherwise, NO.

isSendingShareSourceAvailable

- (BOOL) isSendingShareSourceAvailable

Query if sending shared source is available.

Returns

YES if available. Otherwise, NO.

selectActiveVideoSource

- (ZoomSDKError) selectActiveVideoSource

Adds active video source to the array.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

selectSendShareSource

- (ZoomSDKError) selectSendShareSource

Select shared source of the current user.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

Note

It works only when RecordingLayoutMode is RecordingLayoutMode_OnlyShare.

selectShareSource:

- (ZoomSDKError) selectShareSource:

(unsigned int)

shareSourceID

Select the specified's shared source user.

Parameters

shareSourceID

The share source ID of specified user.

Returns

If the function succeeds, it returns the ZoomSDKError_Success. Otherwise, this function returns an error.

Note

It works only when RecordingLayoutMode is RecordingLayoutMode_OnlyShare.