ZoomSDKRecordSetting Class Reference

Interface for recording settings. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- setRecordingPath:
	Sets the path for saving the meeting recording file.
(NSString *_Nullable)	- getRecordingPath
	Gets the current meeting's recorded path.
(BOOL)	- isEnableChooseRecordingPathWhenMeetingEnd
	Determines if choose recording path when meeting ended is enabled or not.
(ZoomSDKError)	- chooseRecordingPathWhenMeetingEnd:
	Enables or disable choose recording path when meeting ended.
(BOOL)	- isEnableRecordAudioForEveryAttendeeIndividually
	Determines if record audio for every attendee individually is enabled or not.
(ZoomSDKError)	- recordAudioForEveryAttendeeIndividually:
	Enables or disable record audio for every attendee individually.
(BOOL)	- isEnableOptimizeFor3PartyVideoEditor
	Determines if optimize for third party video editor is enabled or not.
(ZoomSDKError)	- OptimizeFor3PartyVideoEditor:
	Enables or disable optimize for third party video editor.
(BOOL)	- isEnableAddTimestampForRecording
	Determines if add timestamp for recording is enabled or not.
(ZoomSDKError)	- addTimestampForRecording:
	Enables or disable add timestamp for recordin.
(BOOL)	- isEnableRecordDuringScreenSharing
	Determines if recording during screen sharing is enabled or not.
(ZoomSDKError)	- recordDuringScreenSharing:
	Enables or disable record during screen sharing .
(BOOL)	- isEnableDisplayVideoNextToShareContentsInRecordingFile
	Determines if display video next to share contents in recording file is enabled or not.
(ZoomSDKError)	- displayVideoNextToShareContentsInRecordingFile:
	Enables or disable display video next to share contents in recording file.
(BOOL)	- canGetCloudRecordingStorageInfo
	Determines if the user have privilege to get cloud recording storage info.
(ZoomSDKError)	- getCloudRecordingStorageInfo
	Call to get cloud recording storage info if the user has the privilege to get cloud recording storage info.
(BOOL)	- canGetRecordingManagementURL
	Determines if the user have privilege to get cloud recording management URL.
(NSString *_Nullable)	- getRecordingManagementURL
	Call to get cloud recording management URL if the user has the privilege to get cloud recording management URL.
(ZoomSDKError)	- setCustomizedCloudRecordingMgrUrl:
	Sets the cloud recording manage url in the recording setting page.

Protected Attributes
id< ZoomSDKSettingRecordDelegate >	_delegate

Properties
id< ZoomSDKSettingRecordDelegate >	delegate
	Delegate object for receiving recording setting events.

Detailed Description

Interface for recording settings.

Definition at line 1134 of file ZoomSDKSettingService.h.

Method Documentation

addTimestampForRecording:

- (ZoomSDKError) addTimestampForRecording:

(BOOL)

enable

Enables or disable add timestamp for recordin.

Parameters

enable

YES if enabled, NO if disabled.

Returns

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

canGetCloudRecordingStorageInfo

- (BOOL) canGetCloudRecordingStorageInfo

Determines if the user have privilege to get cloud recording storage info.

Returns

YES if can get info. Otherwise, NO.

canGetRecordingManagementURL

- (BOOL) canGetRecordingManagementURL

Determines if the user have privilege to get cloud recording management URL.

Returns

YES if can get url. Otherwise, NO.

chooseRecordingPathWhenMeetingEnd:

- (ZoomSDKError) chooseRecordingPathWhenMeetingEnd:

(BOOL)

enable

Enables or disable choose recording path when meeting ended.

Parameters

enable

YES if enabled, NO if disabled.

Returns

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

displayVideoNextToShareContentsInRecordingFile:

- (ZoomSDKError) displayVideoNextToShareContentsInRecordingFile:

(BOOL)

enable

Enables or disable display video next to share contents in recording file.

Parameters

enable

YES if enabled, NO if disabled.

Returns

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

getCloudRecordingStorageInfo

- (ZoomSDKError) getCloudRecordingStorageInfo

Call to get cloud recording storage info if the user has the privilege to get cloud recording storage info.

Returns

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

Note

The cloud recording storage info will be notified to user through delegate ZoomSDKSettingRecordDelegate when you have call this api successfully.

getRecordingManagementURL

- (NSString *_Nullable) getRecordingManagementURL

Call to get cloud recording management URL if the user has the privilege to get cloud recording management URL.

Returns

If the function succeeds, it returns the cloud recording management URL. Otherwise, this function fails and returns nil.

getRecordingPath

- (NSString *_Nullable) getRecordingPath

Gets the current meeting's recorded path.

Returns

If the function succeeds, it returns the recording path. Otherwise, this function fails and returns nil.

isEnableAddTimestampForRecording

- (BOOL) isEnableAddTimestampForRecording

Determines if add timestamp for recording is enabled or not.

Returns

YES if enabled. Otherwise, NO.

isEnableChooseRecordingPathWhenMeetingEnd

- (BOOL) isEnableChooseRecordingPathWhenMeetingEnd

Determines if choose recording path when meeting ended is enabled or not.

Returns

YES if enabled. Otherwise, NO.

isEnableDisplayVideoNextToShareContentsInRecordingFile

- (BOOL) isEnableDisplayVideoNextToShareContentsInRecordingFile

Determines if display video next to share contents in recording file is enabled or not.

Returns

YES if enabled. Otherwise, NO.

isEnableOptimizeFor3PartyVideoEditor

- (BOOL) isEnableOptimizeFor3PartyVideoEditor

Determines if optimize for third party video editor is enabled or not.

Returns

YES if enabled. Otherwise, NO.

isEnableRecordAudioForEveryAttendeeIndividually

- (BOOL) isEnableRecordAudioForEveryAttendeeIndividually

Determines if record audio for every attendee individually is enabled or not.

Returns

YES if enabled. Otherwise, NO.

isEnableRecordDuringScreenSharing

- (BOOL) isEnableRecordDuringScreenSharing

Determines if recording during screen sharing is enabled or not.

Returns

YES if enabled. Otherwise, NO.

OptimizeFor3PartyVideoEditor:

- (ZoomSDKError) OptimizeFor3PartyVideoEditor:

(BOOL)

enable

Enables or disable optimize for third party video editor.

Parameters

enable

YES if enabled, NO if disabled.

Returns

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

recordAudioForEveryAttendeeIndividually:

- (ZoomSDKError) recordAudioForEveryAttendeeIndividually:

(BOOL)

enable

Enables or disable record audio for every attendee individually.

Parameters

enable

YES if enabled, NO if disabled.

Returns

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

recordDuringScreenSharing:

- (ZoomSDKError) recordDuringScreenSharing:

(BOOL)

enable

Enables or disable record during screen sharing .

Parameters

enable

YES if enabled, NO if disabled.

Returns

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

setCustomizedCloudRecordingMgrUrl:

- (ZoomSDKError) setCustomizedCloudRecordingMgrUrl:

(NSString *)

recordingMgrUrl

Sets the cloud recording manage url in the recording setting page.

Parameters

recordingMgrUrl

Specify the cloud recording manage url in the recording setting page.

Returns

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

setRecordingPath:

- (ZoomSDKError) setRecordingPath:

(NSString *)

path

Sets the path for saving the meeting recording file.

Parameters

path	The path for saving the meeting recording file.

Returns

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

Note

The parameter 'path' must already be present, or the path cannot be set successfully.

Field Documentation

_delegate

- (id<ZoomSDKSettingRecordDelegate>) _delegate

protected

Definition at line 1136 of file ZoomSDKSettingService.h.

Property Documentation

delegate

- (id<ZoomSDKSettingRecordDelegate>) delegate

readwritenonatomicassign

Delegate object for receiving recording setting events.

Definition at line 1141 of file ZoomSDKSettingService.h.