Rate this page:

ConferenceRecorder

Represents a conference recorder.
Add the following line to your scenario code to use the class:

require(Modules.Recorder);

Methods

addEventListener

Copy URL
addEventListener(event: 

RecorderEvents

,
callback:

Function

):

void

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.

Parameters

Returns

  • type:

    void

getPriority

Copy URL
getPriority(): 

Endpoint[]

Gets an endpoint's priority.

Returns

id

Copy URL
id(): 

string

Returns the recorder's id.

Returns

  • type:

    string

mute

Copy URL
mute(doMute: 

boolean

):

void

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

Parameters

  • doMute:

    boolean

    Mute/unmute switch

Returns

  • type:

    void

removeEventListener

Copy URL
removeEventListener(event: 

RecorderEvents

,
callback:

Function

):

void

Removes a handler for the specified RecorderEvents event.

Parameters

Returns

  • type:

    void

setConference

Copy URL
setConference(conference: 

Conference

):

void

Conference object to record.

Parameters

Returns

  • type:

    void

setPriority

Copy URL
setPriority(priority: 

Endpoint[]

):

Promise<void>

Sets an endpoint's priority.

Parameters

Returns

  • type:

    Promise<void>

stop

Copy URL
stop(): 

void

Stops recording and triggers the RecorderEvents.Stopped event.

Returns

  • type:

    void

update

Copy URL
update(parameters: 

UpdateRecorderVideoParameters

):

void

Updates the current video recorder parameters.

Parameters

Returns

  • type:

    void