ConferenceRecorder

Represents a conference recorder. Add the following line to your scenario code to use the class: require(Modules.Recorder);

View as Markdown

Extends: Recorder

Methods

getPriority

Gets an endpoint’s priority.

1getPriority(): Endpoint[]

setConference

Conference object to record.

1setConference(conference: Conference): void

Parameters

conference
ConferenceRequired

setPriority

Sets an endpoint’s priority.

1setPriority(priority: Endpoint[]): Promise<void>

Parameters

priority
Endpoint[]Required

update

Updates the current video recorder parameters.

1update(parameters: UpdateRecorderVideoParameters): void

Parameters

parameters
UpdateRecorderVideoParametersRequired

Inherited Methods

addEventListener

Inherited from Recorder.

Adds a handler for the specified RecorderEvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

1addEventListener(event: RecorderEvents | T, callback: (event: _RecorderEvents[T]) => any): void

Parameters

event
RecorderEvents | TRequired
callback
(event: _RecorderEvents[T]) => anyRequired

id

Inherited from Recorder.

Returns the recorder’s id.

1id(): string

mute

Inherited from Recorder.

Whether to mute whole record without detaching media sources from it.

1mute(doMute: boolean): void

Parameters

doMute
booleanRequired

removeEventListener

Inherited from Recorder.

Removes a handler for the specified RecorderEvents event.

1removeEventListener(event: RecorderEvents | T, callback?: (event: _RecorderEvents[T]) => any): void

Parameters

event
RecorderEvents | TRequired
callback
(event: _RecorderEvents[T]) => any

stop

Inherited from Recorder.

Stops recording and triggers the RecorderEvents.Stopped event.

1stop(): void