useParams()

Sets the layout mode. Valid options:

• single: Show a single full-screen video.
• split: Show the first two participants side-by-side.
• grid: Show up to 20 videos in a grid layout.
• dominant: Show the active speaker in a large pane on the left, with additional video thumbnails on the right.
• pip: Show the active speaker in a full-screen view, with the first participant inlaid in a corner.

Sets whether a text overlay is displayed. You can configure the contents of the overlay with the text.* properties.

Sets whether an image overlay is displayed. You can configure the display of the overlay with the image.* properties. The image used must be passed in the session_id layout option when the stream or recording is started.

Sets whether a title screen (a "slate") is displayed. You can configure the display of the slate with the titleSlate.* properties.

Sets whether a title screen (a "slate") is automatically shown at the start of the stream. You can configure the display of this automatic slate with the openingSlate. properties.

Limits the number of non-screenshare streams that are included in the output.

When enabled, screen share inputs will be sorted before camera inputs. This is useful when prioritizing screen shares in your layout, especially when all inputs are not included in the final stream. For more information about how participants and videos are sorted, see the section on selecting participants.

When enabled, paused video inputs will not be included. By default this is off, and paused inputs are displayed with a placeholder graphic. ("Paused video" means that the video track for a participant is not available, either due to user action or network conditions.)

Sets whether call participants' names are displayed on their video tiles.

Sets whether to display video tiles with squared or rounded corners. Note that some modes (dominant and pip) have additional params to control whether the main video has rounded corners or not.

Sets the corner radius applied to video layers when videoSettings.roundedCorners is enabled, in grid units.

Controls how source video is displayed inside a tile if they have different aspect ratios. Use fill to crop the video to fill the entire tile. Use fit to make sure the entire video fits inside the tile, adding letterboxes or pillarboxes as necessary.

Sets the background color for video placeholder tile. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the visual margin between the two video layers shown in split mode, in grid units.

When enabled, the layout will automatically switch to dominant mode from grid if a screenshare video input is available. By using this automatic behavior, you avoid having to manually switch the mode via an API call.

Overrides the visual margin between items in grid mode, in grid units. The default value of -1 means that the layout algorithm selects a reasonable margin automatically depending on the number of videos.

Overrides the outer padding around items in grid mode, in grid units. The default value of -1 means that the layout algorithm selects a reasonable padding automatically depending on the number of videos.

By default, the grid mode will highlight the dominant video (typically the "active speaker") with a light outline. You can disable the highlight using this setting.

Control where the dominant (or "active speaker") video is displayed in the dominant layout mode. Values are left, right, top or bottom.

Sets the position of the imaginary line separating the dominant video from the smaller tiles when using the dominant layout. Values are from 0 to 1. The default is 0.8, so if videoSettings.dominant.position is set to left, the dominant video will take 80% of the width of the screen on the left.

Controls how many "chiclets", or smaller video tiles, appear alongside the dominant video when using the dominant layout.

When in dominant mode, the large tile displays the active speaker by default. Turn off this followDomFlag to display the first participant instead of the active speaker.

Margin between the “chiclet” items, in grid units.

Padding around the row/column of “chiclet” items, in grid units.

Margin between the "dominant" video and the row/column of "chiclet" items, in grid units.

Sets whether the "dominant" video will be rendered with rounded corners when videoSettings.roundedCorners is enabled. Defaults to false because sharp corners are a more natural choice for the default configuration where the dominant video is tightly aligned to viewport edges.

Sets the position of the smaller video in the pip (picture-in-picture) layout. Valid options: top-left, top-right, bottom-left, bottom-right.

Sets the aspect ratio of the smaller video in the pip layout. The default is 1.0, which produces a square video.

Sets the height of the smaller video in the pip layout, measured in grid units.

Sets the margin between the smaller video and the edge of the frame in the pip layout, in grid units.

When in "pip" (or picture-in-picture) mode, the overlay tile displays the first participant in the participant array by default. Turn on this followDomFlag to display the active speaker instead.

Sets whether the main video in pip mode will be rendered with rounded corners when videoSettings.roundedCorners is enabled. Defaults to false because sharp corners are a more natural choice for the default configuration where the main video is full-screen (no margin to viewport edges).

Sets the participant label style option: font family. Valid options: Roboto, RobotoCondensed, Bitter, Exo, Magra, SuezOne, Teko

Sets the participant label text font weight. Valid options: 100, 200, 300, 400, 500, 600, 700, 800, 900.

Note: Not all font weights are valid for every font family.

Sets the participant label text font size.

Sets the offset value for participant labels on the x-axis, measured in grid units.

Sets the offset value for participant labels on the y-axis, measured in grid units.

Sets the participant label font color. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the label font stroke color (the line outlining the text letters). Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the left margin value applied to videos (in any layout mode), in grid units. You can use these videoSettings.margin.* params to shrink the video area, for example to make room for overlays.

Sets the right margin value applied to videos (in any layout mode), in grid units. You can use these videoSettings.margin.* params to shrink the video area, for example to make room for overlays.

Sets the top margin value applied to videos (in any layout mode), in grid units. You can use these videoSettings.margin.* params to shrink the video area, for example to make room for overlays.

Sets the bottom margin value applied to videos (in any layout mode), in grid units. You can use these videoSettings.margin.* params to shrink the video area, for example to make room for overlays.

Sets the string to be displayed if showTextOverlay is true.

Sets the horizontal alignment of the text overlay within the video frame. Values are left, right, or center.

Sets the vertical alignment of the text overlay within the video frame. Values are top, bottom, or center.

Sets an x-offset (horizontal) to be applied to the text overlay's position based on the values of text.align_horizontal and text.align_vertical.

Sets a y-offset (vertical) to be applied to the text overlay's position based on the values of text.align_horizontal and text.align_vertical.

Applies a rotation to the text overlay. Units are degrees, and positive is a clockwise rotation.

Sets the font of the text overlay. Valid options: Roboto, RobotoCondensed, Anton, Bangers, Bitter, Exo, Magra, PermanentMarker, SuezOne, Teko

Selects a weight variant from the selected font family. Valid options: 100, 200, 300, 400, 500, 600, 700, 800, 900.

Note: Not all font weights are valid for every font family.

Sets the font style for text. Valid options: 'normal','italic'.

Sets the text overlay font size using grid units (gu). By default, one grid unit is 1/36 of the smaller dimension of the viewport (e.g. 20px in a 1280*720 stream).

Sets the color and transparency of the text overlay. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the color of the stroke drawn around the characters in the text overlay. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the overlay image. Icon asset must be included in session_assets object. showImageOverlay must be true.

Sets position of overlay image. Valid options: top-left, top-right, bottom-left, bottom-right

Sets overlay image to full screen.

Sets aspect ratio of overlay image.

Sets height of overlay image, in grid units.

Sets margin between the overlay image and the viewport edge, in grid units.

Sets opacity of overlay image, in range 0-1. Default value of 1 is full opacity.

Sets the overlay image to fade in or out when the showImageOverlay property is updated.

Triggers display of toast component. To send a toast, increment the value of key

Sets text displayed in toast component.

Sets duration of time toast component is displayed (in seconds).

Sets number of lines text in toast component is displayed on.

Sets whether icon is displayed in toast component (true or false).

Sets asset value for toast icon. Icon asset must be included in session_assets object.

Sets the toast component's background color. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the color of the stroke drawn around the text characters in the toast component. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the toast component's text color. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the toast component's font family. Valid options: Roboto, RobotoCondensed, Bitter, Exo, Magra, SuezOne, Teko

Sets the font weight for the toast component's text. Valid options: 100, 200, 300, 400, 500, 600, 700, 800, 900.

Note: Not all font weights are valid for every font family.

Sets the font size for the toast component's text.

Sets the number of seconds that the opening slate will be displayed when the stream starts. After this time, the slate goes away with a fade-out effect.

Sets text displayed in the main title of the opening slate.

Sets text displayed in the subtitle (second line) of the opening slate.

Sets an image to be used as the background for the slate. This image asset must be included in session_assets object when starting the stream/recording.

Sets the slate's background color. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the text color of the titles in the slate. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the font of the titles in the slate. Valid options: Roboto, RobotoCondensed, Anton, Bangers, Bitter, Exo, Magra, PermanentMarker, SuezOne, Teko

Selects a weight variant from the selected font family. Valid options: 100, 200, 300, 400, 500, 600, 700, 800, 900.

Note: Not all font weights are valid for every font family.

Sets the font style for the titles in the slate. Valid options: 'normal','italic'.

Sets the main title font size using grid units (gu). By default, one grid unit is 1/36 of the smaller dimension of the viewport (e.g. 20px in a 1280*720 stream).

Sets the subtitle font size as a percentage of the main title.

Selects a weight variant from the selected font family specifically for the subtitle. Valid options: 100, 200, 300, 400, 500, 600, 700, 800, 900.

Note: Not all font weights are valid for every font family.

Sets text displayed in the main title of the slate.

Sets text displayed in the subtitle (second line) of the slate.

Sets an image to be used as the background for the slate. This image asset must be included in session_assets object when starting the stream/recording.

Sets the slate's background color. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the text color of the titles in the slate. Valid options:

• Hex color codes

• RGB or RGBA syntax

• Standard CSS color names (e.g. 'blue')

Sets the font of the titles in the slate. Valid options: Roboto, RobotoCondensed, Anton, Bangers, Bitter, Exo, Magra, PermanentMarker, SuezOne, Teko

Selects a weight variant from the selected font family. Valid options: 100, 200, 300, 400, 500, 600, 700, 800, 900.

Note: Not all font weights are valid for every font family.

Sets the font style for the titles in the slate. Valid options: 'normal','italic'.

Sets the main title font size using grid units (gu). By default, one grid unit is 1/36 of the smaller dimension of the viewport (e.g. 20px in a 1280*720 stream).

Sets the subtitle font size as a percentage of the main title.

Selects a weight variant from the selected font family specifically for the subtitle. Valid options: 100, 200, 300, 400, 500, 600, 700, 800, 900.

Note: Not all font weights are valid for every font family.