Zoom Recording Setting
- Description:
- Zoom Recording Setting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onCloudRecordingStorageInfo |
function | Notification of the current cloud recording storage information. |
Returns:
- Type
- ZoomRecordingSetting
- Description:
- Zoom Recording Setting
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onCloudRecordingStorageInfo |
function | Notification of the current cloud recording storage information. |
Returns:
- Type
- ZoomRecordingSetting
Methods
(inner) Getting_GetCloudRecordingStorageInfo() → {Number}
- Description:
- Get the storage information of cloud recording.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Getting_GetCloudRecordingStorageInfo() → {Number}
- Description:
- Get the storage information of cloud recording.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Getting_GetRecordingManagementURL() → {String}
- Description:
- Get the recording management URL. It returns the real url only after you retrieve the callback IRecordingSettingContextEvent.onCloudRecordingStorageInfo().
- Source:
Returns:
The recording management URL.
- Type
- String
(inner) Getting_GetRecordingManagementURL() → {String}
- Description:
- Get the recording management URL. It returns the real url only after you retrieve the callback IRecordingSettingContextEvent.onCloudRecordingStorageInfo().
- Source:
Returns:
The recording management URL.
- Type
- String
(inner) Getting_GetRecordingPath() → {String}
- Description:
- Get the path to save the recording file.
- Source:
Returns:
The path to save the recording file.
- Type
- String
(inner) Getting_GetRecordingPath() → {String}
- Description:
- Get the path to save the recording file.
- Source:
Returns:
The path to save the recording file.
- Type
- String
(inner) Setting_CanGetCloudRecordingStorageInfo() → {Boolean}
- Description:
- Check if the user has the privilege to get the storage information for cloud recording.
- Source:
Returns:
true means the user has the privilege.
- Type
- Boolean
(inner) Setting_CanGetCloudRecordingStorageInfo() → {Boolean}
- Description:
- Check if the user has the privilege to get the storage information for cloud recording.
- Source:
Returns:
true means the user has the privilege.
- Type
- Boolean
(inner) Setting_CanGetRecordingManagementURL() → {Object}
- Description:
- Set if it is able to get recording management URL.
- Source:
Returns:
If the function succeeds, the return value is an object with properties:
- err: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- bCan: true means the recording management URL can be retrieved. FALSE not.
- Type
- Object
(inner) Setting_CanGetRecordingManagementURL() → {Object}
- Description:
- Set if it is able to get recording management URL.
- Source:
Returns:
If the function succeeds, the return value is an object with properties:
- err: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- bCan: true means the recording management URL can be retrieved. FALSE not.
- Type
- Object
(inner) Setting_EnableAddTimestampWatermark(bEnable) → {Number}
- Description:
- Enable/Disable watermark of timestamp.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means enabled. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnableAddTimestampWatermark(bEnable) → {Number}
- Description:
- Enable/Disable watermark of timestamp.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means enabled. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnableMultiAudioStreamRecord(bEnable) → {Number}
- Description:
- Enable/Disable multi-audio stream recording.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means enabled. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnableMultiAudioStreamRecord(bEnable) → {Number}
- Description:
- Enable/Disable multi-audio stream recording.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means enabled. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnableOptimizeFor3rdPartyVideoEditor(bEnable) → {Number}
- Description:
- Enable/Disable the optimization for the third party video editor.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means enabled. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnableOptimizeFor3rdPartyVideoEditor(bEnable) → {Number}
- Description:
- Enable/Disable the optimization for the third party video editor.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means enabled. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnablePlaceVideoNextToShareInRecord(bEnable) → {Number}
- Description:
- Enable/Disable placing the video layout next to the shared content in recording file.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means enabled. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnablePlaceVideoNextToShareInRecord(bEnable) → {Number}
- Description:
- Enable/Disable placing the video layout next to the shared content in recording file.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means enabled. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnableSelectRecordFileLocationAfterMeeting(bEnable) → {Number}
- Description:
- Set whether to enable the function of selecting the path to save the recording file after meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means to enable. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnableSelectRecordFileLocationAfterMeeting(bEnable) → {Number}
- Description:
- Set whether to enable the function of selecting the path to save the recording file after meeting.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means to enable. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnableShowVideoThumbnailWhenShare(bEnable) → {Number}
- Description:
- Enable/Disable showing the video thumbnail when sharing.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means enabled. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_EnableShowVideoThumbnailWhenShare(bEnable) → {Number}
- Description:
- Enable/Disable showing the video thumbnail when sharing.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bEnable |
Boolean | true means enabled. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_IsAddTimestampWatermarkEnabled() → {Boolean}
- Description:
- Determine if the watermark of timestamps is enabled.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsAddTimestampWatermarkEnabled() → {Boolean}
- Description:
- Determine if the watermark of timestamps is enabled.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsMultiAudioStreamRecordEnabled() → {Boolean}
- Description:
- Determine if multi-audio stream recording is enabled.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsMultiAudioStreamRecordEnabled() → {Boolean}
- Description:
- Determine if multi-audio stream recording is enabled.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsOptimizeFor3rdPartyVideoEditorEnabled() → {Boolean}
- Description:
- Determine if the third party video editor is enabled.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsOptimizeFor3rdPartyVideoEditorEnabled() → {Boolean}
- Description:
- Determine if the third party video editor is enabled.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsPlaceVideoNextToShareInRecordEnabled() → {Boolean}
- Description:
- Determine if placing video next to the shared content in recording file is enabled.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsPlaceVideoNextToShareInRecordEnabled() → {Boolean}
- Description:
- Determine if placing video next to the shared content in recording file is enabled.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsSelectRecordFileLocationAfterMeetingEnabled() → {Boolean}
- Description:
- Check if the function of selecting storage path for recording file is enabled.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsSelectRecordFileLocationAfterMeetingEnabled() → {Boolean}
- Description:
- Check if the function of selecting storage path for recording file is enabled.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsShowVideoThumbnailWhenShareEnabled() → {Boolean}
- Description:
- Determine if video thumbnail is enabled when sharing.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_IsShowVideoThumbnailWhenShareEnabled() → {Boolean}
- Description:
- Determine if video thumbnail is enabled when sharing.
- Source:
Returns:
true means enabled.
- Type
- Boolean
(inner) Setting_SetRecordingPath(zn_szPath) → {Number}
- Description:
- Set the path to save the recording file.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_szPath |
String | Specify the path to save the recording file. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_SetRecordingPath(zn_szPath) → {Number}
- Description:
- Set the path to save the recording file.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
zn_szPath |
String | Specify the path to save the recording file. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Setting_SetonCloudRecordingStorageInfoCB(onCloudRecordingStorageInfo) → {Boolean}
- Description:
- Set onCloudRecordingStorageInfo callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onCloudRecordingStorageInfo |
function | The event of recording settings. |
Returns:
true or false
- Type
- Boolean
(inner) Setting_SetonCloudRecordingStorageInfoCB(onCloudRecordingStorageInfo) → {Boolean}
- Description:
- Set onCloudRecordingStorageInfo callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onCloudRecordingStorageInfo |
function | The event of recording settings. |
Returns:
true or false
- Type
- Boolean
Events
onCloudRecordingStorageInfo
- Description:
- Notification of the current cloud recording storage information.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
storage_total_size |
String | Specify the total storage space. |
storage_used_size |
String | Specify the used storage space. |
allow_exceed_storage |
String | Specify whether the used space can overflow the total space. |
onCloudRecordingStorageInfo
- Description:
- Notification of the current cloud recording storage information.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
storage_total_size |
String | Specify the total storage space. |
storage_used_size |
String | Specify the used storage space. |
allow_exceed_storage |
String | Specify whether the used space can overflow the total space. |