2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

RecordingService

The RecordingService allows an application to record conferences by using the start and stop methods that turn the recording on and off. The RecordingStatusUpdatedEvent informs about the status of the recording and additional conference details.

Available in the package com.voxeet.sdk.services.RecordingService.

Methods

start

start(): Promise<Boolean>

Starts recording a part of the conference that is currently joined by the local participant. When the conference is ended or recording is stopped, the recorded parts are automatically concentrated by the server. It is possible to replay them by using the replay method of the ConferenceService.

Returns: Promise<Boolean> - the promise to resolve that indicates the result of the request.

stop

stop(): Promise<Boolean>

Stops recording the conference.

Returns: Promise<Boolean> - the promise to resolve that indicates the result of the request.

Events

RecordingStatusUpdatedEvent

Emitted when the recording state of the conference is updated from the remote location.

Available in the package com.voxeet.sdk.json.RecordingStatusUpdatedEvent.

This object can be accessed through the Websocket usage.

conferenceId (String)

The ID of the recorded conference.

participantId (String)

The ID of the Participant that records the conference.

recordingStatus (String)

The representation of raw recording status.

timeStamp (long)

The corresponding timestamp.