zoom_meeting_recording

Zoom Meeting Recording
Description:
  • Zoom Meeting Recording
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 RecordingStatus
onCloudRecordingStatus function Callback event that the status of cloud recording changes 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 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:
  • Zoom Meeting Recording
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 RecordingStatus
onCloudRecordingStatus function Callback event that the status of cloud recording changes 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 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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) ActionCancelEnableSmartRecording() → {Number}

Description:
  • Cancel enable and start the smart recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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.
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.
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.
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.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) EnableSmartRecording() → {Number}

Description:
  • Enable the smart recording feature.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails.
Type
Number

(inner) EnableSmartRecording() → {Number}

Description:
  • Enable the smart recording feature.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails.
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.
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.
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.
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.
Type
Number

(inner) SetonCloudRecordingStatusCB(onCloudRecordingStatus) → {Boolean}

Description:
  • Set onCloudRecordingStatus callback.
Source:
Parameters:
Name Type Description
onCloudRecordingStatus function
Returns:
true or false
Type
Boolean

(inner) SetonCloudRecordingStatusCB(onCloudRecordingStatus) → {Boolean}

Description:
  • Set onCloudRecordingStatus callback.
Source:
Parameters:
Name Type Description
onCloudRecordingStatus function
Returns:
true or false
Type
Boolean

(inner) SetonCloudRecordingStorageFullCB(onCloudRecordingStorageFull) → {Boolean}

Description:
  • Set onCloudRecordingStorageFull callback.
Source:
Parameters:
Name Type Description
onCloudRecordingStorageFull function
Returns:
true or false
Type
Boolean

(inner) SetonCloudRecordingStorageFullCB(onCloudRecordingStorageFull) → {Boolean}

Description:
  • Set onCloudRecordingStorageFull callback.
Source:
Parameters:
Name Type Description
onCloudRecordingStorageFull function
Returns:
true or false
Type
Boolean

(inner) SetonEnableAndStartSmartRecordingRequestedCB(onEnableAndStartSmartRecordingRequested) → {Boolean}

Description:
  • Set onEnableAndStartSmartRecordingRequested callback.
Source:
Parameters:
Name Type Description
onEnableAndStartSmartRecordingRequested function
Returns:
true or false
Type
Boolean

(inner) SetonEnableAndStartSmartRecordingRequestedCB(onEnableAndStartSmartRecordingRequested) → {Boolean}

Description:
  • Set onEnableAndStartSmartRecordingRequested callback.
Source:
Parameters:
Name Type Description
onEnableAndStartSmartRecordingRequested function
Returns:
true or false
Type
Boolean

(inner) SetonRecordPrivilegeChangedCB(onRecordPrivilegeChanged) → {Boolean}

Description:
  • Set onRecordPrivilegeChanged callback.
Source:
Parameters:
Name Type Description
onRecordPrivilegeChanged function
Returns:
true or false
Type
Boolean

(inner) SetonRecordPrivilegeChangedCB(onRecordPrivilegeChanged) → {Boolean}

Description:
  • Set onRecordPrivilegeChanged callback.
Source:
Parameters:
Name Type Description
onRecordPrivilegeChanged function
Returns:
true or false
Type
Boolean

(inner) SetonRecording2MP4DoneCB(onRecording2MP4Done) → {Boolean}

Description:
  • Set onRecording2MP4Done callback.
Source:
Parameters:
Name Type Description
onRecording2MP4Done function
Returns:
true or false
Type
Boolean

(inner) SetonRecording2MP4DoneCB(onRecording2MP4Done) → {Boolean}

Description:
  • Set onRecording2MP4Done callback.
Source:
Parameters:
Name Type Description
onRecording2MP4Done function
Returns:
true or false
Type
Boolean

(inner) SetonRecording2MP4ProcessingCB(onRecording2MP4Processing) → {Boolean}

Description:
  • Set onRecording2MP4Processing callback.
Source:
Parameters:
Name Type Description
onRecording2MP4Processing function
Returns:
true or false
Type
Boolean

(inner) SetonRecording2MP4ProcessingCB(onRecording2MP4Processing) → {Boolean}

Description:
  • Set onRecording2MP4Processing callback.
Source:
Parameters:
Name Type Description
onRecording2MP4Processing function
Returns:
true or false
Type
Boolean

(inner) SetonRecordingStatusCB(onRecordingStatus) → {Boolean}

Description:
  • Set onRecordingStatus callback.
Source:
Parameters:
Name Type Description
onRecordingStatus function
Returns:
true or false
Type
Boolean

(inner) SetonRecordingStatusCB(onRecordingStatus) → {Boolean}

Description:
  • Set onRecordingStatus callback.
Source:
Parameters:
Name Type Description
onRecordingStatus function
Returns:
true or false
Type
Boolean

(inner) SetonRequestCloudRecordingResponseCB(onRequestCloudRecordingResponse) → {Boolean}

Description:
  • Set onRequestCloudRecordingResponse callback.
Source:
Parameters:
Name Type Description
onRequestCloudRecordingResponse function
Returns:
true or false
Type
Boolean

(inner) SetonRequestCloudRecordingResponseCB(onRequestCloudRecordingResponse) → {Boolean}

Description:
  • Set onRequestCloudRecordingResponse callback.
Source:
Parameters:
Name Type Description
onRequestCloudRecordingResponse function
Returns:
true or false
Type
Boolean

(inner) SetonSmartRecordingEnableActionCallback(onSmartRecordingEnableActionCallback) → {Boolean}

Description:
  • Set onSmartRecordingEnableAction callback.
Source:
Parameters:
Name Type Description
onSmartRecordingEnableActionCallback function
Returns:
true or false
Type
Boolean

(inner) SetonSmartRecordingEnableActionCallback(onSmartRecordingEnableActionCallback) → {Boolean}

Description:
  • Set onSmartRecordingEnableAction callback.
Source:
Parameters:
Name Type Description
onSmartRecordingEnableActionCallback function
Returns:
true or false
Type
Boolean

(inner) SetonStartCloudRecordingRequestedCB(onStartCloudRecordingRequested) → {Boolean}

Description:
  • Set onStartCloudRecordingRequested callback.
Source:
Parameters:
Name Type Description
onStartCloudRecordingRequested function
Returns:
true or false
Type
Boolean

(inner) SetonStartCloudRecordingRequestedCB(onStartCloudRecordingRequested) → {Boolean}

Description:
  • Set onStartCloudRecordingRequested callback.
Source:
Parameters:
Name Type Description
onStartCloudRecordingRequested function
Returns:
true or false
Type
Boolean

(inner) Start() → {Number}

Description:
  • Accept the request to start cloud recording and then destroys the IRequestCloudRecordingHandler instance.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) Start() → {Number}

Description:
  • Accept the request to start cloud recording and then destroys the IRequestCloudRecordingHandler instance.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartCloudRecording() → {Number}

Description:
  • Start cloud recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartCloudRecording() → {Number}

Description:
  • Start cloud recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartCloudRecordingWithoutEnableSmartRecording() → {Number}

Description:
  • Normal cloud recording without enable smart recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartCloudRecordingWithoutEnableSmartRecording() → {Number}

Description:
  • Normal cloud recording without enable smart recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartRecording() → {Number}

Description:
  • Start recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartRecording() → {Number}

Description:
  • Start recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StopCloudRecording() → {Number}

Description:
  • Stop cloud recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StopCloudRecording() → {Number}

Description:
  • Stop cloud recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StopRecording() → {Number}

Description:
  • Stop recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StopRecording() → {Number}

Description:
  • Stop recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 RecordingStatus

onCloudRecordingStatus

Description:
  • Callback event that the status of cloud recording changes.
Source:
Parameters:
Name Type Description
status String Value of recording status 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.
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.
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.
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.
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 RecordingStatus

onRecordingStatus

Description:
  • Callback event that the status of local recording changes.
Source:
Parameters:
Name Type Description
status String Value of recording status RecordingStatus

onRequestCloudRecordingResponse

Description:
  • Callback event for when the host responds to a cloud recording permission request.
Source:
Parameters:
Name Type Description
status String Value of request host to start cloud recording response status RequestStartCloudRecordingStatus

onRequestCloudRecordingResponse

Description:
  • Callback event for when the host responds to a cloud recording permission request.
Source:
Parameters:
Name Type Description
status String Value of request host to start cloud recording response status RequestStartCloudRecordingStatus

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:
Zoom Meeting Recording
Description:
  • Zoom Meeting Recording
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 RecordingStatus
onCloudRecordingStatus function Callback event that the status of cloud recording changes 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 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:
  • Zoom Meeting Recording
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 RecordingStatus
onCloudRecordingStatus function Callback event that the status of cloud recording changes 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 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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) ActionCancelEnableSmartRecording() → {Number}

Description:
  • Cancel enable and start the smart recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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.
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.
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.
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.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) EnableSmartRecording() → {Number}

Description:
  • Enable the smart recording feature.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails.
Type
Number

(inner) EnableSmartRecording() → {Number}

Description:
  • Enable the smart recording feature.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails.
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.
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.
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.
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.
Type
Number

(inner) SetonCloudRecordingStatusCB(onCloudRecordingStatus) → {Boolean}

Description:
  • Set onCloudRecordingStatus callback.
Source:
Parameters:
Name Type Description
onCloudRecordingStatus function
Returns:
true or false
Type
Boolean

(inner) SetonCloudRecordingStatusCB(onCloudRecordingStatus) → {Boolean}

Description:
  • Set onCloudRecordingStatus callback.
Source:
Parameters:
Name Type Description
onCloudRecordingStatus function
Returns:
true or false
Type
Boolean

(inner) SetonCloudRecordingStorageFullCB(onCloudRecordingStorageFull) → {Boolean}

Description:
  • Set onCloudRecordingStorageFull callback.
Source:
Parameters:
Name Type Description
onCloudRecordingStorageFull function
Returns:
true or false
Type
Boolean

(inner) SetonCloudRecordingStorageFullCB(onCloudRecordingStorageFull) → {Boolean}

Description:
  • Set onCloudRecordingStorageFull callback.
Source:
Parameters:
Name Type Description
onCloudRecordingStorageFull function
Returns:
true or false
Type
Boolean

(inner) SetonEnableAndStartSmartRecordingRequestedCB(onEnableAndStartSmartRecordingRequested) → {Boolean}

Description:
  • Set onEnableAndStartSmartRecordingRequested callback.
Source:
Parameters:
Name Type Description
onEnableAndStartSmartRecordingRequested function
Returns:
true or false
Type
Boolean

(inner) SetonEnableAndStartSmartRecordingRequestedCB(onEnableAndStartSmartRecordingRequested) → {Boolean}

Description:
  • Set onEnableAndStartSmartRecordingRequested callback.
Source:
Parameters:
Name Type Description
onEnableAndStartSmartRecordingRequested function
Returns:
true or false
Type
Boolean

(inner) SetonRecordPrivilegeChangedCB(onRecordPrivilegeChanged) → {Boolean}

Description:
  • Set onRecordPrivilegeChanged callback.
Source:
Parameters:
Name Type Description
onRecordPrivilegeChanged function
Returns:
true or false
Type
Boolean

(inner) SetonRecordPrivilegeChangedCB(onRecordPrivilegeChanged) → {Boolean}

Description:
  • Set onRecordPrivilegeChanged callback.
Source:
Parameters:
Name Type Description
onRecordPrivilegeChanged function
Returns:
true or false
Type
Boolean

(inner) SetonRecording2MP4DoneCB(onRecording2MP4Done) → {Boolean}

Description:
  • Set onRecording2MP4Done callback.
Source:
Parameters:
Name Type Description
onRecording2MP4Done function
Returns:
true or false
Type
Boolean

(inner) SetonRecording2MP4DoneCB(onRecording2MP4Done) → {Boolean}

Description:
  • Set onRecording2MP4Done callback.
Source:
Parameters:
Name Type Description
onRecording2MP4Done function
Returns:
true or false
Type
Boolean

(inner) SetonRecording2MP4ProcessingCB(onRecording2MP4Processing) → {Boolean}

Description:
  • Set onRecording2MP4Processing callback.
Source:
Parameters:
Name Type Description
onRecording2MP4Processing function
Returns:
true or false
Type
Boolean

(inner) SetonRecording2MP4ProcessingCB(onRecording2MP4Processing) → {Boolean}

Description:
  • Set onRecording2MP4Processing callback.
Source:
Parameters:
Name Type Description
onRecording2MP4Processing function
Returns:
true or false
Type
Boolean

(inner) SetonRecordingStatusCB(onRecordingStatus) → {Boolean}

Description:
  • Set onRecordingStatus callback.
Source:
Parameters:
Name Type Description
onRecordingStatus function
Returns:
true or false
Type
Boolean

(inner) SetonRecordingStatusCB(onRecordingStatus) → {Boolean}

Description:
  • Set onRecordingStatus callback.
Source:
Parameters:
Name Type Description
onRecordingStatus function
Returns:
true or false
Type
Boolean

(inner) SetonRequestCloudRecordingResponseCB(onRequestCloudRecordingResponse) → {Boolean}

Description:
  • Set onRequestCloudRecordingResponse callback.
Source:
Parameters:
Name Type Description
onRequestCloudRecordingResponse function
Returns:
true or false
Type
Boolean

(inner) SetonRequestCloudRecordingResponseCB(onRequestCloudRecordingResponse) → {Boolean}

Description:
  • Set onRequestCloudRecordingResponse callback.
Source:
Parameters:
Name Type Description
onRequestCloudRecordingResponse function
Returns:
true or false
Type
Boolean

(inner) SetonSmartRecordingEnableActionCallback(onSmartRecordingEnableActionCallback) → {Boolean}

Description:
  • Set onSmartRecordingEnableAction callback.
Source:
Parameters:
Name Type Description
onSmartRecordingEnableActionCallback function
Returns:
true or false
Type
Boolean

(inner) SetonSmartRecordingEnableActionCallback(onSmartRecordingEnableActionCallback) → {Boolean}

Description:
  • Set onSmartRecordingEnableAction callback.
Source:
Parameters:
Name Type Description
onSmartRecordingEnableActionCallback function
Returns:
true or false
Type
Boolean

(inner) SetonStartCloudRecordingRequestedCB(onStartCloudRecordingRequested) → {Boolean}

Description:
  • Set onStartCloudRecordingRequested callback.
Source:
Parameters:
Name Type Description
onStartCloudRecordingRequested function
Returns:
true or false
Type
Boolean

(inner) SetonStartCloudRecordingRequestedCB(onStartCloudRecordingRequested) → {Boolean}

Description:
  • Set onStartCloudRecordingRequested callback.
Source:
Parameters:
Name Type Description
onStartCloudRecordingRequested function
Returns:
true or false
Type
Boolean

(inner) Start() → {Number}

Description:
  • Accept the request to start cloud recording and then destroys the IRequestCloudRecordingHandler instance.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) Start() → {Number}

Description:
  • Accept the request to start cloud recording and then destroys the IRequestCloudRecordingHandler instance.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartCloudRecording() → {Number}

Description:
  • Start cloud recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartCloudRecording() → {Number}

Description:
  • Start cloud recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartCloudRecordingWithoutEnableSmartRecording() → {Number}

Description:
  • Normal cloud recording without enable smart recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartCloudRecordingWithoutEnableSmartRecording() → {Number}

Description:
  • Normal cloud recording without enable smart recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartRecording() → {Number}

Description:
  • Start recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StartRecording() → {Number}

Description:
  • Start recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StopCloudRecording() → {Number}

Description:
  • Stop cloud recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StopCloudRecording() → {Number}

Description:
  • Stop cloud recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StopRecording() → {Number}

Description:
  • Stop recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
Type
Number

(inner) StopRecording() → {Number}

Description:
  • Stop recording.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
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 RecordingStatus

onCloudRecordingStatus

Description:
  • Callback event that the status of cloud recording changes.
Source:
Parameters:
Name Type Description
status String Value of recording status 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.
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.
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.
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.
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 RecordingStatus

onRecordingStatus

Description:
  • Callback event that the status of local recording changes.
Source:
Parameters:
Name Type Description
status String Value of recording status RecordingStatus

onRequestCloudRecordingResponse

Description:
  • Callback event for when the host responds to a cloud recording permission request.
Source:
Parameters:
Name Type Description
status String Value of request host to start cloud recording response status RequestStartCloudRecordingStatus

onRequestCloudRecordingResponse

Description:
  • Callback event for when the host responds to a cloud recording permission request.
Source:
Parameters:
Name Type Description
status String Value of request host to start cloud recording response status RequestStartCloudRecordingStatus

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: