Zoom Meeting Recording
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
onRecording2MP4Done |
function
|
Callback event of ending the conversion to MP4 format. |
onRecording2MP4Processing |
function
|
Callback event of the process of the conversion to MP4 format. |
onRecordingStatus |
function
|
Callback event that the status of local recording changes, Defined in: RecordingStatus |
onCloudRecordingStatus |
function
|
Callback event that the status of cloud recording changes, Defined in: RecordingStatus |
onRecordPrivilegeChanged |
function
|
Callback event that the recording authority changes. |
onCloudRecordingStorageFull |
function
|
Callback event that the cloud recording storage is full. |
onRequestCloudRecordingResponse |
function
|
Callback event for when the host responds to a cloud recording permission request, Defined in: RequestStartCloudRecordingStatus |
onStartCloudRecordingRequested |
function
|
Callback event received only by the host when a user requests to start cloud recording. |
onEnableAndStartSmartRecordingRequested |
function
|
Callback event received only by the host when a user requests to enable and start smart cloud recording. |
onSmartRecordingEnableActionCallback |
function
|
Callback event received when you call EnableSmartRecording. You can use the handler to confirm or cancel to enable the smart recording. |
Returns:
-
Type
-
ZoomMeetingRecording
- Description:
- Source:
Parameters:
| Name |
Type |
Description |
onRecording2MP4Done |
function
|
Callback event of ending the conversion to MP4 format. |
onRecording2MP4Processing |
function
|
Callback event of the process of the conversion to MP4 format. |
onRecordingStatus |
function
|
Callback event that the status of local recording changes, Defined in: RecordingStatus |
onCloudRecordingStatus |
function
|
Callback event that the status of cloud recording changes, Defined in: RecordingStatus |
onRecordPrivilegeChanged |
function
|
Callback event that the recording authority changes. |
onCloudRecordingStorageFull |
function
|
Callback event that the cloud recording storage is full. |
onRequestCloudRecordingResponse |
function
|
Callback event for when the host responds to a cloud recording permission request, Defined in: RequestStartCloudRecordingStatus |
onStartCloudRecordingRequested |
function
|
Callback event received only by the host when a user requests to start cloud recording. |
onEnableAndStartSmartRecordingRequested |
function
|
Callback event received only by the host when a user requests to enable and start smart cloud recording. |
onSmartRecordingEnableActionCallback |
function
|
Callback event received when you call EnableSmartRecording. You can use the handler to confirm or cancel to enable the smart recording. |
Returns:
-
Type
-
ZoomMeetingRecording
Methods
(inner) ActionCancelEnableSmartRecording() → {Number}
- Description:
- Cancel enable and start the smart recording.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) ActionCancelEnableSmartRecording() → {Number}
- Description:
- Cancel enable and start the smart recording.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) ActionConfirmEnableSmartRecording(bAllMeetings) → {Number}
- Description:
- Confirm to enable and start the smart recording.
- Source:
Parameters:
| Name |
Type |
Description |
bAllMeetings |
Boolean
|
True indicates to enable smart recording for all future meetings (include the current meeting). False indicates to only enable smart recording for the current meeting. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) ActionConfirmEnableSmartRecording(bAllMeetings) → {Number}
- Description:
- Confirm to enable and start the smart recording.
- Source:
Parameters:
| Name |
Type |
Description |
bAllMeetings |
Boolean
|
True indicates to enable smart recording for all future meetings (include the current meeting). False indicates to only enable smart recording for the current meeting. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) AgreeToEnableAndStartSmartRecording(bAllMeetings) → {Number}
- Description:
- Agree the legal notice to enable and start smart cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
bAllMeetings |
Boolean
|
bAllMeetings True indicates to enable smart recording for all future meetings (include the current meeting). False indicates to only enable smart recording for the current meeting. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) AgreeToEnableAndStartSmartRecording(bAllMeetings) → {Number}
- Description:
- Agree the legal notice to enable and start smart cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
bAllMeetings |
Boolean
|
bAllMeetings True indicates to enable smart recording for all future meetings (include the current meeting). False indicates to only enable smart recording for the current meeting. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) AllowLocalRecording(userid) → {Number}
- Description:
- Give the specified user authority for local recording.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specifies the user ID. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) AllowLocalRecording(userid) → {Number}
- Description:
- Give the specified user authority for local recording.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specifies the user ID. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) CanAllowDisAllowLocalRecording() → {Number}
- Description:
- Determine if the current user own the authority to change the recording permission of the others.
- Source:
Returns:
If the user own the authority, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) CanAllowDisAllowLocalRecording() → {Number}
- Description:
- Determine if the current user own the authority to change the recording permission of the others.
- Source:
Returns:
If the user own the authority, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) CanEnableSmartRecordingFeature() → {Boolean}
- Description:
- Whether the current user can enable the smart recording feature.
- Source:
Returns:
True means the current user can enable the smart recording feature.
-
Type
-
Boolean
(inner) CanEnableSmartRecordingFeature() → {Boolean}
- Description:
- Whether the current user can enable the smart recording feature.
- Source:
Returns:
True means the current user can enable the smart recording feature.
-
Type
-
Boolean
(inner) CanStartRecording(cloud_recording, userid) → {Number}
- Description:
- Determine if the specified user is enabled to start recording.
- Source:
Parameters:
| Name |
Type |
Description |
cloud_recording |
Boolean
|
TRUE indicates to determine whether to enable the cloud recording. FALSE local recording. |
userid |
Number
|
Specifies the user ID. |
Returns:
If the value of cloud_recording is set to TRUE and the cloud recording is enabled, the return value is SDKERR_SUCCESS.
If the value of cloud_recording is set to FALSE and the local recording is enabled, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) CanStartRecording(cloud_recording, userid) → {Number}
- Description:
- Determine if the specified user is enabled to start recording.
- Source:
Parameters:
| Name |
Type |
Description |
cloud_recording |
Boolean
|
TRUE indicates to determine whether to enable the cloud recording. FALSE local recording. |
userid |
Number
|
Specifies the user ID. |
Returns:
If the value of cloud_recording is set to TRUE and the cloud recording is enabled, the return value is SDKERR_SUCCESS.
If the value of cloud_recording is set to FALSE and the local recording is enabled, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) DeclineEnableAndStartSmartRecording(bDenyAll) → {Number}
- Description:
- Decline the request to start cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
bDenyAll |
Boolean
|
True indicates to deny all attendees' requests for the host to start cloud recording. Participants can't send these types of requests again until the host change the setting. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) DeclineEnableAndStartSmartRecording(bDenyAll) → {Number}
- Description:
- Decline the request to start cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
bDenyAll |
Boolean
|
True indicates to deny all attendees' requests for the host to start cloud recording. Participants can't send these types of requests again until the host change the setting. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) Deny(bDenyAll) → {Number}
- Description:
- Deny the request to start cloud recording and then destroys the IRequestCloudRecordingHandler instance.
- Source:
Parameters:
| Name |
Type |
Description |
bDenyAll |
Boolean
|
TRUE indicates to deny all requests. Participants can't send requests again until the host change the setting. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) Deny(bDenyAll) → {Number}
- Description:
- Deny the request to start cloud recording and then destroys the IRequestCloudRecordingHandler instance.
- Source:
Parameters:
| Name |
Type |
Description |
bDenyAll |
Boolean
|
TRUE indicates to deny all requests. Participants can't send requests again until the host change the setting. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) DisAllowLocalRecording(userid) → {Number}
- Description:
- Abrogate the authority of the specified user for local recoding.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specifies the user ID. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) DisAllowLocalRecording(userid) → {Number}
- Description:
- Abrogate the authority of the specified user for local recoding.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specifies the user ID. |
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) EnableSmartRecording() → {Number}
- Description:
- Enable the smart recording feature.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise the function fails. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) EnableSmartRecording() → {Number}
- Description:
- Enable the smart recording feature.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise the function fails. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) GetRequestEnableAndStartSmartRecordingTipString() → {String}
- Description:
- Get the legal tip that you should agree to handle the user request.
- Source:
Returns:
If the function succeeds, the return value is the legal notice about enable and start smart cloud recording.
-
Type
-
String
(inner) GetRequestEnableAndStartSmartRecordingTipString() → {String}
- Description:
- Get the legal tip that you should agree to handle the user request.
- Source:
Returns:
If the function succeeds, the return value is the legal notice about enable and start smart cloud recording.
-
Type
-
String
(inner) GetRequestEnableAndStartSmartRecordingUserId() → {Number}
- Description:
- Get the user ID who requested to enable and start smart cloud recording.
- Source:
Returns:
If the function succeeds, the return value is the user ID.
-
Type
-
Number
(inner) GetRequestEnableAndStartSmartRecordingUserId() → {Number}
- Description:
- Get the user ID who requested to enable and start smart cloud recording.
- Source:
Returns:
If the function succeeds, the return value is the user ID.
-
Type
-
Number
(inner) GetRequesterId() → {Number}
- Description:
- Get the user ID who requested that the host start cloud recording.
- Source:
Returns:
If the function succeeds, the return value is the user ID. Otherwise, this returns 0.
-
Type
-
Number
(inner) GetRequesterId() → {Number}
- Description:
- Get the user ID who requested that the host start cloud recording.
- Source:
Returns:
If the function succeeds, the return value is the user ID. Otherwise, this returns 0.
-
Type
-
Number
(inner) GetRequesterName() → {String}
- Description:
- Get the user name who requested that the host start cloud recording.
- Source:
Returns:
If the function succeeds, the return value is the user name.
-
Type
-
String
(inner) GetRequesterName() → {String}
- Description:
- Get the user name who requested that the host start cloud recording.
- Source:
Returns:
If the function succeeds, the return value is the user name.
-
Type
-
String
(inner) GetSmartRecordingEnableActionTipString() → {String}
- Description:
- Get the legal tip to enable the smart recording.
- Source:
Returns:
The legal notice.
-
Type
-
String
(inner) GetSmartRecordingEnableActionTipString() → {String}
- Description:
- Get the legal tip to enable the smart recording.
- Source:
Returns:
The legal notice.
-
Type
-
String
(inner) IsSmartRecordingEnabled() → {Boolean}
- Description:
- Determine if the smart recording feature is enabled in the meeting.
- Source:
Returns:
true means that the feature enabled, false means that the feature isn't enabled.
-
Type
-
Boolean
(inner) IsSmartRecordingEnabled() → {Boolean}
- Description:
- Determine if the smart recording feature is enabled in the meeting.
- Source:
Returns:
true means that the feature enabled, false means that the feature isn't enabled.
-
Type
-
Boolean
(inner) IsSupportLocalRecording(userid) → {Number}
- Description:
- Determine if the user owns the authority to enable the local recording.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specifies the user ID. |
Returns:
If the specified user is enabled to start local recording, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) IsSupportLocalRecording(userid) → {Number}
- Description:
- Determine if the user owns the authority to enable the local recording.
- Source:
Parameters:
| Name |
Type |
Description |
userid |
Number
|
Specifies the user ID. |
Returns:
If the specified user is enabled to start local recording, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) RequestStartCloudRecording() → {Number}
- Description:
- Send a request to ask the host to start cloud recording.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS and the SDK sends the request.
Otherwise it fails and the request is not sent. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) RequestStartCloudRecording() → {Number}
- Description:
- Send a request to ask the host to start cloud recording.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS and the SDK sends the request.
Otherwise it fails and the request is not sent. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) SetonCloudRecordingStatusCB(onCloudRecordingStatus) → {Boolean}
- Description:
- Set on Cloud Recording Status Callback
- Source:
Parameters:
| Name |
Type |
Description |
onCloudRecordingStatus |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonCloudRecordingStatusCB(onCloudRecordingStatus) → {Boolean}
- Description:
- Set on Cloud Recording Status Callback
- Source:
Parameters:
| Name |
Type |
Description |
onCloudRecordingStatus |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonCloudRecordingStorageFullCB(onCloudRecordingStorageFull) → {Boolean}
- Description:
- Set the cloud recording storage is full Callback
- Source:
Parameters:
| Name |
Type |
Description |
onCloudRecordingStorageFull |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonCloudRecordingStorageFullCB(onCloudRecordingStorageFull) → {Boolean}
- Description:
- Set the cloud recording storage is full Callback
- Source:
Parameters:
| Name |
Type |
Description |
onCloudRecordingStorageFull |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonEnableAndStartSmartRecordingRequestedCB(onEnableAndStartSmartRecordingRequested) → {Boolean}
- Description:
- Set callback event received only by the host when a user requests to enable and start smart cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
onEnableAndStartSmartRecordingRequested |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonEnableAndStartSmartRecordingRequestedCB(onEnableAndStartSmartRecordingRequested) → {Boolean}
- Description:
- Set callback event received only by the host when a user requests to enable and start smart cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
onEnableAndStartSmartRecordingRequested |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonRecordPrivilegeChangedCB(onRecordPrivilegeChanged) → {Boolean}
- Description:
- Set on Record Privilege Changed Callback
- Source:
Parameters:
| Name |
Type |
Description |
onRecordPrivilegeChanged |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonRecordPrivilegeChangedCB(onRecordPrivilegeChanged) → {Boolean}
- Description:
- Set on Record Privilege Changed Callback
- Source:
Parameters:
| Name |
Type |
Description |
onRecordPrivilegeChanged |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonRecording2MP4DoneCB(onRecording2MP4Done) → {Boolean}
- Description:
- Set on Recording 2MP4 Done Callback
- Source:
Parameters:
| Name |
Type |
Description |
onRecording2MP4Done |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonRecording2MP4DoneCB(onRecording2MP4Done) → {Boolean}
- Description:
- Set on Recording 2MP4 Done Callback
- Source:
Parameters:
| Name |
Type |
Description |
onRecording2MP4Done |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonRecording2MP4ProcessingCB(onRecording2MP4Processing) → {Boolean}
- Description:
- Set on Recording 2MP4 Processing Callback
- Source:
Parameters:
| Name |
Type |
Description |
onRecording2MP4Processing |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonRecording2MP4ProcessingCB(onRecording2MP4Processing) → {Boolean}
- Description:
- Set on Recording 2MP4 Processing Callback
- Source:
Parameters:
| Name |
Type |
Description |
onRecording2MP4Processing |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonRecordingStatusCB(onRecordingStatus) → {Boolean}
- Description:
- Set on Recording Status Callback
- Source:
Parameters:
| Name |
Type |
Description |
onRecordingStatus |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonRecordingStatusCB(onRecordingStatus) → {Boolean}
- Description:
- Set on Recording Status Callback
- Source:
Parameters:
| Name |
Type |
Description |
onRecordingStatus |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonRequestCloudRecordingResponseCB(onRequestCloudRecordingResponse) → {Boolean}
- Description:
- Set callback event for when the host responds to a cloud recording permission request.
- Source:
Parameters:
| Name |
Type |
Description |
onRequestCloudRecordingResponse |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonRequestCloudRecordingResponseCB(onRequestCloudRecordingResponse) → {Boolean}
- Description:
- Set callback event for when the host responds to a cloud recording permission request.
- Source:
Parameters:
| Name |
Type |
Description |
onRequestCloudRecordingResponse |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonSmartRecordingEnableActionCallback(onSmartRecordingEnableActionCallback) → {Boolean}
- Description:
- Set callback event received when you call EnableSmartRecording. You can use the handler to confirm or cancel to enable the smart recording.
- Source:
Parameters:
| Name |
Type |
Description |
onSmartRecordingEnableActionCallback |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonSmartRecordingEnableActionCallback(onSmartRecordingEnableActionCallback) → {Boolean}
- Description:
- Set callback event received when you call EnableSmartRecording. You can use the handler to confirm or cancel to enable the smart recording.
- Source:
Parameters:
| Name |
Type |
Description |
onSmartRecordingEnableActionCallback |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonStartCloudRecordingRequestedCB(onStartCloudRecordingRequested) → {Boolean}
- Description:
- Set callback event received only by the host when a user requests to start cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
onStartCloudRecordingRequested |
function
|
|
Returns:
-
Type
-
Boolean
(inner) SetonStartCloudRecordingRequestedCB(onStartCloudRecordingRequested) → {Boolean}
- Description:
- Set callback event received only by the host when a user requests to start cloud recording.
- Source:
Parameters:
| Name |
Type |
Description |
onStartCloudRecordingRequested |
function
|
|
Returns:
-
Type
-
Boolean
(inner) Start() → {Number}
- Description:
- Accept the request to start cloud recording and then destroys the IRequestCloudRecordingHandler instance.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) Start() → {Number}
- Description:
- Accept the request to start cloud recording and then destroys the IRequestCloudRecordingHandler instance.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) StartCloudRecording() → {Number}
- Description:
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) StartCloudRecording() → {Number}
- Description:
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) StartCloudRecordingWithoutEnableSmartRecording() → {Number}
- Description:
- Normal cloud recording without enable smart recording.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) StartCloudRecordingWithoutEnableSmartRecording() → {Number}
- Description:
- Normal cloud recording without enable smart recording.
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) StartRecording() → {Number}
- Description:
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) StartRecording() → {Number}
- Description:
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) StopCloudRecording() → {Number}
- Description:
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) StopCloudRecording() → {Number}
- Description:
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) StopRecording() → {Number}
- Description:
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
(inner) StopRecording() → {Number}
- Description:
- Source:
Returns:
If the function succeed, the return value is SDKERR_SUCCESS.
Otherwise failed. To get extended error information, Defined in:
ZoomSDKError
-
Type
-
Number
Events
onCloudRecordingStatus
- Description:
- Callback event that the status of cloud recording changes.
- Source:
Parameters:
| Name |
Type |
Description |
status |
String
|
Value of recording status. For more details, Defined in: RecordingStatus |
onCloudRecordingStatus
- Description:
- Callback event that the status of cloud recording changes.
- Source:
Parameters:
| Name |
Type |
Description |
status |
String
|
Value of recording status. For more details, Defined in: RecordingStatus |
onCloudRecordingStorageFull
- Description:
- Callback event that the cloud recording storage is full.
- Source:
Parameters:
| Name |
Type |
Description |
gracePeriodDate |
Number
|
a point in time, in milliseconds, in UTC. You can use the cloud recording storage until the gracePeriodDate. |
onCloudRecordingStorageFull
- Description:
- Callback event that the cloud recording storage is full.
- Source:
Parameters:
| Name |
Type |
Description |
gracePeriodDate |
Number
|
a point in time, in milliseconds, in UTC. You can use the cloud recording storage until the gracePeriodDate. |
onEnableAndStartSmartRecordingRequested
- Description:
- Callback event received only by the host when a user requests to enable and start smart cloud recording.
- Source:
onEnableAndStartSmartRecordingRequested
- Description:
- Callback event received only by the host when a user requests to enable and start smart cloud recording.
- Source:
onRecordPrivilegeChanged
- Description:
- Callback event that the recording authority changes.
- Source:
Parameters:
| Name |
Type |
Description |
canRec |
Boolean
|
TRUE indicates to enable to record. |
onRecordPrivilegeChanged
- Description:
- Callback event that the recording authority changes.
- Source:
Parameters:
| Name |
Type |
Description |
canRec |
Boolean
|
TRUE indicates to enable to record. |
onRecording2MP4Done
- Description:
- Callback event of ending the conversion to MP4 format.
In order to trigger this callback correctly, you need call EnableLocalRecordingConvertProgressBarDialog(false) before you start a meeting.
- Source:
Parameters:
| Name |
Type |
Description |
success |
Boolean
|
TRUE indicates to convert successfully. FALSE not. |
result |
String
|
This value is used to save the error code only when the convert fails. |
path |
String
|
If the conversion is successful, this value is used to save the path of the recording file. |
onRecording2MP4Done
- Description:
- Callback event of ending the conversion to MP4 format.
In order to trigger this callback correctly, you need call EnableLocalRecordingConvertProgressBarDialog(false) before you start a meeting.
- Source:
Parameters:
| Name |
Type |
Description |
success |
Boolean
|
TRUE indicates to convert successfully. FALSE not. |
result |
String
|
This value is used to save the error code only when the convert fails. |
path |
String
|
If the conversion is successful, this value is used to save the path of the recording file. |
onRecording2MP4Processing
- Description:
- Callback event of the process of the conversion to MP4 format.
In order to trigger this callback correctly, you need call EnableLocalRecordingConvertProgressBarDialog(false) before you start a meeting.
- Source:
Parameters:
| Name |
Type |
Description |
percentage |
String
|
Percentage of conversion process. Range from ZERO(0) to ONE HUNDREAD(100). |
onRecording2MP4Processing
- Description:
- Callback event of the process of the conversion to MP4 format.
In order to trigger this callback correctly, you need call EnableLocalRecordingConvertProgressBarDialog(false) before you start a meeting.
- Source:
Parameters:
| Name |
Type |
Description |
percentage |
String
|
Percentage of conversion process. Range from ZERO(0) to ONE HUNDREAD(100). |
onRecordingStatus
- Description:
- Callback event that the status of local recording changes.
- Source:
Parameters:
| Name |
Type |
Description |
status |
String
|
Value of recording status. For more details, Defined in: RecordingStatus |
onRecordingStatus
- Description:
- Callback event that the status of local recording changes.
- Source:
Parameters:
| Name |
Type |
Description |
status |
String
|
Value of recording status. For more details, Defined in: RecordingStatus |
onRequestCloudRecordingResponse
- Description:
- Callback event for when the host responds to a cloud recording permission request.
- Source:
Parameters:
onRequestCloudRecordingResponse
- Description:
- Callback event for when the host responds to a cloud recording permission request.
- Source:
Parameters:
onSmartRecordingEnableActionCallback
- Description:
- Callback event received when you call EnableSmartRecording. You can use the handler to confirm or cancel to enable the smart recording.
- Source:
onSmartRecordingEnableActionCallback
- Description:
- Callback event received when you call EnableSmartRecording. You can use the handler to confirm or cancel to enable the smart recording.
- Source:
onStartCloudRecordingRequested
- Description:
- Callback event received only by the host when a user requests to start cloud recording.
- Source:
onStartCloudRecordingRequested
- Description:
- Callback event received only by the host when a user requests to start cloud recording.
- Source: