RecordingService

The RecordingService allows an application to record conferences via the start and stop methods. The model also notifies about the recording status changes and allows receiving information about the current recording.

Events

statusUpdated

statusUpdated(isRecording: boolean, recording: Recording): void

🚀

SDK Beta

This API is a part of the Beta program.

Emitted when the recording status has changed. The event is available only in SDK 3.5 and later.

example

VoxeetSDK.recording.on("statusUpdated", (recording, isRecording) => {

});

Parameters:

NameTypeDescription
isRecordingbooleanThe status of the recording.
recordingRecordingThe current recording.

Returns: void

Accessors

current

• get current(): Recording | null

Returns information about the current recording. Use this accessor if you wish to receive information that is available in the Recording object, such as the ID of the participant who started the recording or the timestamp that informs when the recording was started.

Returns: Recording | null

Methods

start

start(): any

Starts recording a conference. For more information, see the Recording mechanisms article or the Recording document.

Returns: any


stop

stop(): any

Stops recording a conference.

Returns: any


Did this page help you?