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

HTML color code for the video file background.

customData

Copy URL
customData: 

Object

A container to store custom data for the current recorder.

direction

Copy URL
direction: 

ltr

|

rtl

Video frames' direction, left to right or right to left.

labels

Copy URL
labels: 

RecorderLabels

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

layout

Copy URL
layout: 

grid

|

tribune

|

custom

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 layoutSettings option with an object specifying custom layout settings.

layoutPriority

Copy URL
layoutPriority: 

vad

|

string[]

If layout 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[]

If layout is set to custom, specifies custom video layout settings.

objectFit

Copy URL
objectFit: 

fill

|

contain

|

cover

|

none

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

vad

Copy URL
vad: 

RecorderVad

Whether to highlight video frame of the speaking participant.