Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
Instance Methods | Protected Attributes | Properties
ZoomSDKRecordSetting Class Reference

Interface for recording settings. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError) - setRecordingPath:
 Set the path for saving the meeting recording file.
 
(NSString *_Nullable) - getRecordingPath
 Get the path of the current recorded meeting.
 
(BOOL) - isEnableChooseRecordingPathWhenMeetingEnd
 Determine if choose recording path when meeting ended is enabled or not.
 
(ZoomSDKError) - chooseRecordingPathWhenMeetingEnd:
 Enable or disable choose recording path when meeting ended.
 
(BOOL) - isEnableRecordAudioForEveryAttendeeIndividually
 Determine if record audio for every attendee individually is enabled or not.
 
(ZoomSDKError) - recordAudioForEveryAttendeeIndividually:
 Enable or disable record audio for every attendee individually.
 
(BOOL) - isEnableOptimizeFor3PartyVideoEditor
 Determine if optimize for third party video editor is enabled or not.
 
(ZoomSDKError) - OptimizeFor3PartyVideoEditor:
 Enable or disable optimize for third party video editor.
 
(BOOL) - isEnableAddTimestampForRecording
 Determine if add timestamp for recording is enabled or not.
 
(ZoomSDKError) - addTimestampForRecording:
 Enable or disable add timestamp for recordin.
 
(BOOL) - isEnableRecordDuringScreenSharing
 Determine if recording during screen sharing is enabled or not.
 
(ZoomSDKError) - recordDuringScreenSharing:
 Enable or disable record during screen sharing .
 
(BOOL) - isEnableDisplayVideoNextToShareContentsInRecordingFile
 Determine if display video next to share contents in recording file is enabled or not.
 
(ZoomSDKError) - displayVideoNextToShareContentsInRecordingFile:
 Enable or disable display video next to share contents in recording file.
 
(BOOL) - canGetCloudRecordingStorageInfo
 Determine 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
 Determine 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:
 Set 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 1013 of file ZoomSDKSettingService.h.

Method Documentation

◆ addTimestampForRecording:

- (ZoomSDKError) addTimestampForRecording: (BOOL) enable

Enable or disable add timestamp for recordin.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ canGetCloudRecordingStorageInfo

- (BOOL) canGetCloudRecordingStorageInfo

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

Returns
YES means can get info, otherwise not.

◆ canGetRecordingManagementURL

- (BOOL) canGetRecordingManagementURL

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

Returns
YES means can get url, otherwise not.

◆ chooseRecordingPathWhenMeetingEnd:

- (ZoomSDKError) chooseRecordingPathWhenMeetingEnd: (BOOL) enable

Enable or disable choose recording path when meeting ended.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ displayVideoNextToShareContentsInRecordingFile:

- (ZoomSDKError) displayVideoNextToShareContentsInRecordingFile: (BOOL) enable

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

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ 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 will return the ZoomSDKError_Success, otherwise failed.
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 will return the cloud recording management URL, otherwise nil.

◆ getRecordingPath

- (NSString *_Nullable) getRecordingPath

Get the path of the current recorded meeting.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ isEnableAddTimestampForRecording

- (BOOL) isEnableAddTimestampForRecording

Determine if add timestamp for recording is enabled or not.

Returns
YES means enabled, otherwise not.

◆ isEnableChooseRecordingPathWhenMeetingEnd

- (BOOL) isEnableChooseRecordingPathWhenMeetingEnd

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

Returns
YES means enabled, otherwise not.

◆ isEnableDisplayVideoNextToShareContentsInRecordingFile

- (BOOL) isEnableDisplayVideoNextToShareContentsInRecordingFile

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

Returns
YES means enabled, otherwise not.

◆ isEnableOptimizeFor3PartyVideoEditor

- (BOOL) isEnableOptimizeFor3PartyVideoEditor

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

Returns
YES means enabled, otherwise not.

◆ isEnableRecordAudioForEveryAttendeeIndividually

- (BOOL) isEnableRecordAudioForEveryAttendeeIndividually

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

Returns
YES means enabled, otherwise not.

◆ isEnableRecordDuringScreenSharing

- (BOOL) isEnableRecordDuringScreenSharing

Determine if recording during screen sharing is enabled or not.

Returns
YES means enabled, otherwise not.

◆ OptimizeFor3PartyVideoEditor:

- (ZoomSDKError) OptimizeFor3PartyVideoEditor: (BOOL) enable

Enable or disable optimize for third party video editor.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ recordAudioForEveryAttendeeIndividually:

- (ZoomSDKError) recordAudioForEveryAttendeeIndividually: (BOOL) enable

Enable or disable record audio for every attendee individually.

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ recordDuringScreenSharing:

- (ZoomSDKError) recordDuringScreenSharing: (BOOL) enable

Enable or disable record during screen sharing .

Parameters
enableYES means enabled, NO disabled.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setCustomizedCloudRecordingMgrUrl:

- (ZoomSDKError) setCustomizedCloudRecordingMgrUrl: (NSString *) recordingMgrUrl

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

Parameters
recordingMgrUrlSpecify the cloud recording manage url in the recording setting page.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setRecordingPath:

- (ZoomSDKError) setRecordingPath: (NSString *) path

Set the path for saving the meeting recording file.

Parameters
pathThe path for saving the meeting recording file.
Returns
If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.
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 1015 of file ZoomSDKSettingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDKSettingRecordDelegate>) delegate
readwritenonatomicassign

Delegate object for receiving recording setting events.

Definition at line 1020 of file ZoomSDKSettingService.h.