Rate this page:

RecorderVideoParameters

An object specifying recorder video parameters. Can be passed via the CallRecordParameters.videoParameters and ConferenceRecorderParameters.videoParameters parameter.
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.

bitrate

Copy URL
bitrate: 

number

|

undefined

Video bitrate in kbps.

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.

fps

Copy URL
fps: 

number

|

undefined

Video frames per second.

height

Copy URL
height: 

number

|

undefined

Video height in pixels.

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.

mixing

Copy URL
mixing: 

boolean

Whether to create single video file of multiple participants.

objectFit

Copy URL
objectFit: 

fill

|

contain

|

cover

|

none

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

profile

Copy URL
profile: 

RecorderProfile

Video quality profile.

vad

Copy URL
vad: 

RecorderVad

Whether to highlight video frame of the speaking participant.

width

Copy URL
width: 

number

|

undefined

Video width in pixels.