Rate this page:

RecorderLabels

An object that specifies video frame with the participants' name settings. Can be passed via the RecorderVideoParameters.labels or UpdateRecorderVideoParameters.labels parameter.
Add the following line to your scenario code to use the interface:

require(Modules.Recorder);

Props

background

Copy URL
background: 

string

|

undefined

Optional. Participant's label background color in HEX format. The default value is #c7c7cc

color

Copy URL
color: 

string

|

undefined

Optional. Participant's label color in HEX format. The default value is #000000

font

Copy URL
font: 

RecorderLabelFont

Optional. Participant's label font. The default value is [RecorderLabelFont.ROBOTO_REGULAR]

height

Copy URL
height: 

number

|

undefined

Optional. Participant's label height in pixels. The default value is 24

margin

Copy URL
margin: 

number

|

undefined

Optional. Margin space outside the label in pixels. The default value is 8

position

Copy URL
position: 

RecorderLabelPosition

Optional. Participant's label position. The default value is [RecorderLabelPosition.BOTTOM_RIGHT]

textAlign

Copy URL
textAlign: 

RecorderLabelTextAlign

Optional. Participant's label text horizontal and vertical alignment. The default value is [RecorderLabelTextAlign.MIDDLE_LEFT]

width

Copy URL
width: 

number

|

undefined

Optional. Participant's label width in pixels. The default value is 104