NEWDolby Interactivity APIs are now the Dolby.io Communications APIs Learn More >
X

RecordingService

The RecordingService allows an application to record conferences by using the start and stop methods that turn the recording on and off. The service also allows checking if the conference is recorded, and informs about the recording status.

Accessors

delegate

delegate: VTRecordingDelegate

A means of communication between objects in the recording service.

Returns: VTRecordingDelegate


status

status: VTRecordingStatus

Checks the current recording status.

Returns: VTRecordingStatus


isRecording

isRecording: Bool

Checks whether the conference is recorded.

Returns: Bool

Methods

start

start(fireInterval: Int?, completion: ((_ error: NSError?) -> Void)?)

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

Parameters:

NameTypeDefaultDescription
fireIntervalInt?1000msAn interval after which the recording starts.
completion((_ error: NSError?) -> Void)?nilThe block to execute when the query completes.

stop

stop(completion: ((_ error: NSError?) -> Void)?)

Stops recording a conference.

Parameters:

NameTypeDefaultDescription
completion((_ error: NSError?) -> Void)?nilThe block to execute when the query completes.

Did this page help you?