Rate this page:

UpdateRecorderVideoParameters

Updates the current video recorder options. Can be passed as arguments to the ConferenceRecorder.update method.
Add the following line to your scenario code to use the interface:

require(Modules.Recorder);

Props

background

Copy URL
background: 

string

|

undefined

Optional. HTML color code for the video file background.

customData

Copy URL
customData: 

Object

Optional. A container to store custom data for the current recorder.

direction

Copy URL
direction: 

RecorderDirection

Optional. Video frame's direction, left to right or right to left.

labels

Copy URL
labels: 

RecorderLabels

Optional. Whether to show the participants' names on their video frames.

layout

Copy URL
layout: 

RecorderLayout

Optional. Video layout settings. If set to grid, all the video frames are the same size. If set to tribune, one active video frame is bigger than the others. If set to custom, you need to provide a 'layout' option with an object that specifies custom layout settings.

layoutPriority

Copy URL
layoutPriority: 

RecorderLayoutPriority

Optional. If 'layout' option is set to tribune, specifies which frame is bigger than the others. Set to vad if you want the bigger frame to change to the speaking participant, or specify the participant's ID to show one person constantly.

layoutSettings

Copy URL
layoutSettings: 

RecorderDrawArea[]

Optional. If 'layout' option is set to custom, specifies custom video layout settings.

objectFit

Copy URL
objectFit: 

RecorderObjectFit

Optional. How to fill a participant's video source to the conference frame.

vad

Copy URL
vad: 

RecorderVad

Optional. Whether to highlight video frame of the speaking participant.