Skip to main content
DailyStreamingLayoutConfig controls how participant video is composed when cloud recording or live streaming. It is a discriminated union — the preset field determines which layout is used and which additional fields are available. 
type DailyStreamingLayoutConfig =
  | { preset: 'default';               /* ... */ }
  | { preset: 'single-participant';    /* ... */ }
  | { preset: 'active-participant';    /* ... */ }
  | { preset: 'portrait';              /* ... */ }
  | { preset: 'audio-only';            /* ... */ }
  | { preset: 'raw-tracks-audio-only'; /* ... */ }
  | { preset: 'custom';                /* ... */ }
Pass a layout config via the layout field of DailyStreamingOptions when calling startRecording(), updateRecording(), startLiveStreaming(), or updateLiveStreaming().
DailyLiveStreamingLayoutConfig is the same union with one difference: the audio-only preset is not available for live streaming.

​
participants

Several presets accept an optional participants config that controls which participants are included in the composition and in what order.
​
participants.video
string[]
Optional. An ordered list of participant session_id values to include in the video composition. Participants not in this list are excluded.
​
participants.audio
string[]
Optional. An ordered list of participant session_id values to include in the audio mix.
​
participants.sort
string
Optional. Sort method for participants. Currently only 'active' is supported, which sorts by recent speaking activity.

​
Presets

​
default

Shows up to max_cam_streams participant camera tiles in a grid. This is the default if no layout is specified.
​
preset
string
Always "default".
​
max_cam_streams
number
Optional. Maximum number of camera tiles to show. Defaults to 9.
​
participants
DailyStreamingParticipantsConfig
Optional. See participants above.
{ "preset": "default", "max_cam_streams": 6 }

​
single-participant

Fills the frame with one participant’s camera feed.
​
preset
string
Always "single-participant".
​
session_id
string
The session_id of the participant to feature.
{ "preset": "single-participant", "session_id": "abc123" }

​
active-participant

Fills the frame with the currently active speaker’s camera feed.
​
preset
string
Always "active-participant".
​
participants
DailyStreamingParticipantsConfig
Optional. See participants above.
{ "preset": "active-participant" }

​
portrait

Stacks participant tiles vertically, optimized for portrait (mobile) aspect ratios.
​
preset
string
Always "portrait".
​
variant
string
Optional. Layout variant: 'vertical' (stacked column) or 'inset' (active speaker fills the frame with a small inset tile). Defaults to 'vertical'.
​
max_cam_streams
number
Optional. Maximum number of camera tiles to show.
​
participants
DailyStreamingParticipantsConfig
Optional. See participants above.
{ "preset": "portrait", "variant": "inset" }

​
audio-only

Records audio without any video composition.
Available for cloud recordings only. Not supported for live streaming — use DailyStreamingLayoutConfig rather than DailyLiveStreamingLayoutConfig when passing this preset to startRecording().
​
preset
string
Always "audio-only".
​
participants
DailyStreamingParticipantsConfig
Optional. See participants above.
{ "preset": "audio-only" }

​
raw-tracks-audio-only

Records raw audio tracks without mixing. Each participant’s audio is captured as a separate track.
​
preset
string
Always "raw-tracks-audio-only".
{ "preset": "raw-tracks-audio-only" }

​
custom

Renders a custom composition using Daily’s compositor. Requires a composition_id when starting a stream or recording; composition_id cannot be changed mid-session via an update call.
​
preset
string
Always "custom".
​
composition_id
string
The ID of the custom composition to use. Required when starting — cannot be changed on update calls.
​
composition_params
object
Optional. Key/value pairs passed to the composition as parameters. Values must be boolean, number, or string. Can be updated mid-session via updateRecording() or updateLiveStreaming().
​
session_assets
object
Optional. Key/value pairs mapping asset names to URLs, made available to the composition. Only valid when starting — cannot be set on update calls.
​
participants
DailyStreamingParticipantsConfig
Optional. See participants above.
// Starting a custom composition
{
  "preset": "custom",
  "composition_id": "my-composition",
  "composition_params": {
    "showLowerThirds": true,
    "accentColor": "#ff0000"
  },
  "session_assets": {
    "logo": "https://example.com/logo.png"
  }
}

// Updating composition params mid-session
{
  "preset": "custom",
  "composition_params": {
    "showLowerThirds": false
  }
}

​
VCS baseline composition

Paid plan only When using preset: 'custom', you can set composition_id to 'daily:baseline' to use Daily’s built-in VCS baseline compositor. The composition_params object then accepts the following properties to control layouts, overlays, and other visual elements.

​
Baseline composition properties

​
mode
string
default:"grid"
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.
​
showTextOverlay
boolean
default:"false"
Sets whether a text overlay is displayed. You can configure the contents of the overlay with the text.* properties.
​
showImageOverlay
boolean
default:"false"
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.
​
showBannerOverlay
boolean
default:"false"
Sets whether a banner overlay is displayed. The banner can be used for TV-style “lower third” graphics, or displayed in any corner. You can configure the content of the overlay with the banner.* properties.
​
showWebFrameOverlay
boolean
default:"false"
Sets whether a WebFrame overlay is displayed. You can configure the display of this live web browser overlay with the webFrame.* properties. The URL and the browser viewport size can be changed while your stream or recording is running.
​
showSidebar
boolean
default:"false"
Sets whether a sidebar is displayed. You can configure the display of the sidebar with the sidebar.* properties.
​
showTitleSlate
boolean
default:"false"
Sets whether a title screen (a “slate”) is displayed. You can configure the display of the slate with the titleSlate.* properties.
​
enableAutoOpeningSlate
boolean
default:"false"
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.
​
videoSettings.maxCamStreams
number
default:"25"
Limits the number of non-screenshare streams that are included in the output.
​
videoSettings.preferredParticipantIds
string
default:""
Lets you do render-time reordering of video inputs according to participant IDs within a Daily room. To enable this sorting, pass a comma-separated list of participant IDs as the value for this param; video inputs matching these IDs will be moved to the top of the list. If you pass an ID that is not present in the room, it’s ignored. All other video inputs will remain in their original order. The default value is an empty string indicating no reordering. Also note that videoSettings.preferScreenshare takes precedence over the ordering passed here. For more information about how participants and videos are sorted, see the section on selecting participants.
​
videoSettings.preferScreenshare
boolean
default:"false"
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.
​
videoSettings.omitPausedVideo
boolean
default:"false"
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.)
​
videoSettings.omitAudioOnly
boolean
default:"false"
When enabled, audio-only inputs will not be included in rendering. By default this is off, and audio participants are displayed with a placeholder graphic.
​
videoSettings.omitExtraScreenshares
boolean
default:"false"
When enabled, any screenshare video inputs beyond the first one will not be included in rendering. You can control the ordering of the inputs using the layout.participants property to explicitly select which participant should be first in the list of inputs.
​
videoSettings.showParticipantLabels
boolean
default:"false"
Sets whether call participants’ names are displayed on their video tiles.
​
videoSettings.roundedCorners
boolean
default:"false"
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.
​
videoSettings.cornerRadius_gu
number
default:"1.2"
Sets the corner radius applied to video layers when videoSettings.roundedCorners is enabled, in grid units.
​
videoSettings.scaleMode
string
default:"fill"
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.
​
videoSettings.scaleModeForScreenshare
string
default:"fit"
Controls how a screenshare 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.
​
videoSettings.placeholder.bgColor
string
default:"rgb(0, 50, 80)"
Sets the background color for video placeholder tile. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
videoSettings.highlight.color
string
default:"rgb(255, 255, 255)"
Sets the highlight color. It’s used as the border color to indicate the ‘dominant’ video input (typically the active speaker). Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
videoSettings.highlight.stroke_gu
number
default:"0.2"
Sets the stroke width used to render a highlight border. See also 'videoSettings.highlight.color'. Specified in grid units.
​
videoSettings.split.margin_gu
number
default:"0"
Sets the visual margin between the two video layers shown in split mode, in grid units.
​
videoSettings.split.direction
string
default:"auto-by-viewport"
Selects whether the 'split' layout mode is rendered in a horizontal or vertical configuration. The default value 'auto-by-viewport' means that the split direction will be automatically selected to be most appropriate for the current viewport size: if the viewport is landscape or square, the split axis is vertical; if portrait, the split axis is horizontal. Valid options: 'auto-by-viewport', 'vertical', 'horizontal'
​
videoSettings.split.scaleModeOverrides
string
default:""
Overrides the scaleMode setting for the split layout mode. Both sides of the split can have separately defined scale modes. Pass a comma-separated list such as fill, fit (this would set the left-hand side video to fill and the right-hand side video to fit). See documentation for the videoSettings.scaleMode parameter for the valid options. Note that this setting also overrides videoSettings.scaleModeForScreenshare.
​
videoSettings.grid.useDominantForSharing
boolean
default:"false"
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.
​
videoSettings.grid.itemInterval_gu
number
default:"-1"
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.
​
videoSettings.grid.outerPadding_gu
number
default:"-1"
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.
​
videoSettings.grid.highlightDominant
boolean
default:"true"
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.
​
videoSettings.grid.preserveAspectRatio
boolean
default:"true"
By default, the layout for the grid mode will try to preserve the aspect ratio of the input videos, i.e. avoid cropping the videos and instead add margins around the grid if needed. Setting this parameter to false will make the grid layout fill all available area, potentially cropping the videos.
​
videoSettings.dominant.position
string
default:"left"
Control where the dominant (or “active speaker”) video is displayed in the dominant layout mode. Values are left, right, top or bottom.
​
videoSettings.dominant.splitPos
number
default:"0.8"
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.
​
videoSettings.dominant.numChiclets
number
default:"5"
Controls how many “chiclets”, or smaller video tiles, appear alongside the dominant video when using the dominant layout.
​
videoSettings.dominant.followDomFlag
boolean
default:"true"
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.
​
videoSettings.dominant.itemInterval_gu
number
default:"0.7"
Margin between the “chiclet” items, in grid units.
​
videoSettings.dominant.outerPadding_gu
number
default:"0.5"
Padding around the row/column of “chiclet” items, in grid units.
​
videoSettings.dominant.splitMargin_gu
number
default:"0"
Margin between the “dominant” video and the row/column of “chiclet” items, in grid units.
​
videoSettings.dominant.sharpCornersOnMain
boolean
default:"true"
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.
​
videoSettings.pip.position
string
default:"top-right"
Sets the position of the smaller video in the pip (picture-in-picture) layout. Valid options: 'top-left', 'top-right', 'bottom-left', 'bottom-right'.
​
videoSettings.pip.aspectRatio
number
default:"1"
Sets the aspect ratio of the smaller video in the pip layout. The default is 1.0, which produces a square video.
​
videoSettings.pip.height_gu
number
default:"12"
Sets the height of the smaller video in the pip layout, measured in grid units.
​
videoSettings.pip.margin_gu
number
default:"1.5"
Sets the margin between the smaller video and the edge of the frame in the pip layout, in grid units.
​
videoSettings.pip.followDomFlag
boolean
default:"false"
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.
​
videoSettings.pip.sharpCornersOnMain
boolean
default:"true"
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).
​
videoSettings.labels.fontFamily
string
default:"Roboto"
Sets the participant label style option: font family. Valid options: DMSans, Roboto, RobotoCondensed, Bitter, Exo, Magra, SuezOne, Teko
​
videoSettings.labels.fontWeight
string
default:"600"
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.
​
videoSettings.labels.fontSize_pct
number
default:"100"
Sets the participant label text font size.
​
videoSettings.labels.offset_x_gu
number
default:"0"
Sets the offset value for participant labels on the x-axis, measured in grid units.
​
videoSettings.labels.offset_y_gu
number
default:"0"
Sets the offset value for participant labels on the y-axis, measured in grid units.
​
videoSettings.labels.color
string
default:"white"
Sets the participant label font color. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
videoSettings.labels.strokeColor
string
default:"rgba(0, 0, 0, 0.9)"
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’)
​
videoSettings.margin.left_gu
number
default:"0"
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.
​
videoSettings.margin.right_gu
number
default:"0"
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.
​
videoSettings.margin.top_gu
number
default:"0"
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.
​
videoSettings.margin.bottom_gu
number
default:"0"
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.
​
text.content
string
default:""
Sets the string to be displayed if showTextOverlay is true.
​
text.source
string
default:"param"
Sets the data source used for the text displayed in the overlay. The default value ‘param’ means that the value of param text.content is used. Valid options: param, highlightLines.items, chatMessages, transcript
​
text.align_horizontal
string
default:"center"
Sets the horizontal alignment of the text overlay within the video frame. Values are left, right, or center.
​
text.align_vertical
string
default:"center"
Sets the vertical alignment of the text overlay within the video frame. Values are top, bottom, or center.
​
text.offset_x_gu
number
default:"0"
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.
​
text.offset_y_gu
number
default:"0"
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.
​
text.rotation_deg
number
default:"0"
Applies a rotation to the text overlay. Units are degrees, and positive is a clockwise rotation.
​
text.fontFamily
string
default:"DMSans"
Sets the font of the text overlay. Valid options: DMSans, Roboto, RobotoCondensed, Anton, Bangers, Bitter, Exo, Magra, PermanentMarker, SuezOne, Teko
​
text.fontWeight
string
default:"500"
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.
​
text.fontStyle
string
default:""
Sets the font style for text. Valid options: ‘normal’,‘italic’.
​
text.fontSize_gu
number
default:"2.5"
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).
​
text.color
string
default:"rgba(255, 250, 200, 0.95)"
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’)
​
text.strokeColor
string
default:"rgba(0, 0, 0, 0.8)"
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’)
​
text.stroke_gu
number
default:"0.5"
Sets the width of the stroke drawn around the characters in the text overlay. Specified in grid units.
​
text.highlight.color
text
default:"rgba(255, 255, 0, 1)"
Sets the color and transparency of a highlighted item in the text overlay. To display a highlight, the value of param text.source must be set to highlightLines.items. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
text.highlight.fontWeight
enum
default:"700"
Sets the font weight of a highlighted item in the text overlay. To display a highlight, the value of param text.source must be set to highlightLines.items.
​
image.assetName
string
default:"overlay.png"
Sets the overlay image. Icon asset must be included in session_assets object. showImageOverlay must be true.
​
image.emoji
text
default:""
Sets an emoji to be rendered instead of an image asset. If this string is non-empty, it will override the value of image.assetName. The string value must be an emoji.
​
image.position
string
default:"top-right"
Sets position of overlay image. Valid options: 'top-left', 'top-right', 'bottom-left', 'bottom-right'
​
image.fullScreen
boolean
default:"false"
Sets overlay image to full screen.
​
image.aspectRatio
number
default:"1.778"
Sets aspect ratio of overlay image.
​
image.height_gu
number
default:"12"
Sets height of overlay image, in grid units.
​
image.margin_gu
number
default:"1.5"
Sets margin between the overlay image and the viewport edge, in grid units.
​
image.opacity
number
default:"1"
Sets opacity of overlay image, in range 0-1. Default value of 1 is full opacity.
​
image.enableFade
boolean
default:"true"
Sets the overlay image to fade in or out when the showImageOverlay property is updated.
​
webFrame.url
string
default:""
Sets the web page URL to be loaded into the WebFrame overlay’s embedded browser.
​
webFrame.viewportWidth_px
number
default:"1280"
Sets the width of the embedded browser window used to render the WebFrame overlay.
​
webFrame.viewportHeight_px
number
default:"720"
Sets the height of the embedded browser window used to render the WebFrame overlay.
​
webFrame.position
string
default:"top-right"
Sets position of the WebFrame overlay. Valid options: 'top-left', 'top-right', 'bottom-left', 'bottom-right'
​
webFrame.fullScreen
boolean
default:"false"
Sets the WebFrame overlay to full screen.
​
webFrame.height_gu
number
default:"12"
Sets height of the WebFrame overlay, in grid units.
​
webFrame.margin_gu
number
default:"1.5"
Sets margin between the WebFrame overlay and the viewport edge, in grid units.
​
webFrame.opacity
number
default:"1"
Sets opacity of the WebFrame overlay, in range 0-1. Default value of 1 is full opacity.
​
webFrame.enableFade
boolean
default:"true"
Sets the WebFrame overlay to fade in or out when the showWebFrameOverlay property is updated.
​
webFrame.keyPress.keyName
string
default:"ArrowRight"
Sets the keyboard key to be sent to the WebFrame browser in a simulated key press. Valid options:
  • Digits 0 - 9
  • Letters A - Z
  • ASCII special characters, e.g. !, @, +, >, etc.
  • Function keys F1 - F12
  • Enter
  • Escape
  • Backspace
  • Tab
  • Arrow keys ArrowUp, ArrowDown, ArrowLeft, ArrowRight
  • PageDown, PageUp
​
webFrame.keyPress.modifiers
string
default:""
Sets keyboard modifier keys to be sent to the WebFrame browser in a simulated key press. Valid options: "Shift", "Control", "Alt", "Meta" (on a Mac keyboard, Alt is equal to Option and Meta is equal to Command).
​
webFrame.keyPress.key
number
default:"0"
Triggers a simulated key press to be sent to WebFrame. To send a key press, increment the value of key. (Note the difference between this and keyName which is the simulated key to be sent.)
​
banner.title
text
default:"Hello world"
Sets the title text displayed in the banner component.
​
banner.subtitle
text
default:"This is an example subtitle"
Sets the subtitle text displayed in the banner component.
​
banner.source
string
default:"param"
Sets the data source for the text displayed in the banner component. Valid options: param, highlightLines.items, chatMessages, transcript
​
banner.position
string
Sets position of the banner component. Valid options: 'top-left', 'top-right', 'bottom-left', 'bottom-right'
​
banner.enableTransition
boolean
default:"true"
Sets the banner to fade in or out when the showBannerOverlay property is updated.
​
banner.margin_x_gu
number
default:"0"
Horizontal margin, specified in grid units.
​
banner.margin_y_gu
number
default:"1"
Vertical margin, specified in grid units.
​
banner.padding_gu
number
default:"2"
Padding inside the component, specified in grid units.
​
banner.alwaysUseMaxW
boolean
default:"false"
Sets whether the banner component will always use its maximum width (specified using banner.maxW_pct_default and banner.maxW_pct_portrait). If false, the banner component will shrink horizontally to fit text inside it, if appropriate.
​
banner.maxW_pct_default
number
default:"65"
Sets the maximum width for the banner component, as a percentage of the viewport size.
​
banner.maxW_pct_portrait
number
default:"90"
Sets the maximum width for the banner component, as a percentage of the viewport size, applied only when the viewport aspect ratio is portrait (i.e. smaller than 1). This override is useful because on a narrow screen the banner display typically needs more horizontal space than on a landscape screen.
​
banner.rotation_deg
number
default:"0"
Applies a rotation to the banner component. Units are degrees, and positive is a clockwise rotation.
​
banner.cornerRadius_gu
number
default:"0"
Sets the corner radius of the banner component outline. Specified in grid units.
​
banner.showIcon
boolean
default:"true"
Sets whether an icon is displayed in the banner component (true or false).
​
banner.icon.assetName
text
default:""
Sets image asset value for the banner icon. Icon asset must be included in session_assets object.
​
banner.icon.emoji
text
default:"🎉"
Sets an emoji to be rendered as the banner icon. If this string is non-empty, it will override banner.icon.assetName. The string value must be an emoji.
​
banner.icon.size_gu
number
default:"3"
Sets the size of the banner icon, specified in grid units.
​
banner.color
text
default:"rgba(50, 60, 200, 0.9)"
Sets the banner component’s background color. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
banner.strokeColor
text
default:"rgba(0, 0, 30, 0.44)"
Sets the color of the outline drawn around the banner component. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
banner.stroke_gu
number
default:"0"
Sets the width of the stroke drawn around the banner component. Specified in grid units.
​
banner.text.color
text
default:"white"
Sets the banner component’s text color. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
banner.text.strokeColor
text
default:"rgba(0, 0, 0, 0.1)"
Sets the color of the stroke drawn around the characters in the banner component. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
banner.text.stroke_gu
number
default:"0.5"
Sets the width of the stroke drawn around the characters in the banner component. Specified in grid units.
​
banner.text.fontFamily
string
default:"Roboto"
Sets the font of text displayed in the banner component. Valid options: DMSans, Roboto, RobotoCondensed, Anton, Bangers, Bitter, Exo, Magra, PermanentMarker, SuezOne, Teko
​
banner.title.fontSize_gu
number
default:"2"
Sets the banner 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).
​
banner.title.fontWeight
string
default:"500"
Sets the banner title font weight. Valid options: 100, 200, 300, 400, 500, 600, 700, 800, 900.Note: Not all font weights are valid for every font family.
​
banner.title.fontStyle
string
default:""
Sets the font style for the banner title. Valid options: ‘normal’,‘italic’.
​
banner.subtitle.fontSize_gu
number
default:"1.5"
Sets the banner subtitle 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).
​
banner.subtitle.fontWeight
string
default:"300"
Sets the banner subtitle font weight. Valid options: 100, 200, 300, 400, 500, 600, 700, 800, 900.Note: Not all font weights are valid for every font family.
​
banner.subtitle.fontStyle
string
default:""
Sets the font style for the banner subtitle. Valid options: ‘normal’,‘italic’.
​
toast.key
number
default:"0"
Triggers display of toast component. To send a toast, increment the value of key
​
toast.text
string
default:"Hello world"
Sets text displayed in toast component.
​
toast.source
string
default:"param"
Sets the data source used for the text displayed in the toast component. The default value param means that the value of param toast.content is used. Valid options: param, chatMessages, transcript
​
toast.duration_secs
number
default:"4"
Sets duration of time toast component is displayed (in seconds).
​
toast.maxW_pct_default
number
default:"50"
Sets the maximum width for the toast component, as a percentage of the viewport size.
​
toast.maxW_pct_portrait
number
default:"80"
Sets the maximum width for the toast component, as a percentage of the viewport size, applied only when the viewport aspect ratio is portrait (i.e. smaller than 1). This override is useful because on a narrow screen the toast display typically needs more horizontal space than on a landscape screen.
​
toast.showIcon
boolean
default:"true"
Sets whether icon is displayed in toast component (true or false).
​
toast.icon.assetName
string
default:""
Sets asset value for toast icon. Icon asset must be included in session_assets object.
​
toast.icon.emoji
text
default:"🎉"
Sets an emoji to be rendered as the toast icon. If this string is non-empty, it will override toast.icon.assetName. The string value must be an emoji.
​
toast.icon.size_gu
number
default:"3"
Sets the size of the toast icon, in grid units.
​
toast.color
string
default:"rgba(15, 50, 110, 0.6)"
Sets the toast component’s background color. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
toast.strokeColor
string
default:"rgba(0, 0, 30, 0.44)"
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’)
​
toast.text.color
string
default:"white"
Sets the toast component’s text color. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
toast.text.fontFamily
string
default:"Roboto"
Sets the toast component’s font family. Valid options: DMSans, Roboto, RobotoCondensed, Bitter, Exo, Magra, SuezOne, Teko
​
toast.text.fontWeight
number
default:"500"
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.
​
toast.text.fontSize_pct
number
default:"100"
Sets the font size for the toast component’s text.
​
openingSlate.duration_secs
number
default:"4"
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.
​
openingSlate.title
string
default:"Welcome"
Sets text displayed in the main title of the opening slate.
​
openingSlate.subtitle
string
default:""
Sets text displayed in the subtitle (second line) of the opening slate.
​
openingSlate.bgImageAssetName
string
default:""
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.
​
openingSlate.bgColor
string
default:"rgba(0, 0, 0, 1)"
Sets the slate’s background color. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
openingSlate.textColor
string
default:"rgba(255, 255, 255, 1)"
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’)
​
openingSlate.fontFamily
string
default:"Bitter"
Sets the font of the titles in the slate. Valid options: DMSans, Roboto, RobotoCondensed, Anton, Bangers, Bitter, Exo, Magra, PermanentMarker, SuezOne, Teko
​
openingSlate.fontWeight
string
default:"500"
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.
​
openingSlate.fontStyle
string
default:""
Sets the font style for the titles in the slate. Valid options: ‘normal’,‘italic’.
​
openingSlate.fontSize_gu
number
default:"2.5"
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).
​
openingSlate.subtitle.fontSize_pct
number
default:"75"
Sets the subtitle font size as a percentage of the main title.
​
openingSlate.subtitle.fontWeight
string
default:"400"
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.
​
titleSlate.enableTransition
boolean
default:"true"
Sets the slate to fade in or out when the showTitleSlate property is updated.’
​
titleSlate.title
string
default:"Title slate"
Sets text displayed in the main title of the slate.
​
titleSlate.subtitle
string
default:"Subtitle"
Sets text displayed in the subtitle (second line) of the slate.
​
titleSlate.bgImageAssetName
string
default:""
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.
​
titleSlate.bgColor
string
default:"rgba(0, 0, 0, 1)"
Sets the slate’s background color. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
titleSlate.textColor
string
default:"rgba(255, 255, 255, 1)"
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’)
​
titleSlate.fontFamily
string
default:"Bitter"
Sets the font of the titles in the slate. Valid options: DMSans, Roboto, RobotoCondensed, Anton, Bangers, Bitter, Exo, Magra, PermanentMarker, SuezOne, Teko
​
titleSlate.fontWeight
string
default:"500"
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.
​
titleSlate.fontStyle
string
default:""
Sets the font style for the titles in the slate. Valid options: ‘normal’,‘italic’.
​
titleSlate.fontSize_gu
number
default:"2.5"
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).
​
titleSlate.subtitle.fontSize_pct
number
default:"75"
Sets the subtitle font size as a percentage of the main title.
​
titleSlate.subtitle.fontWeight
string
default:"400"
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.
​
sidebar.shrinkVideoLayout
boolean
default:"false"
Sets whether the sidebar is displayed on top of video elements. If set to true , the video layout is shrunk horizontally to make room for the sidebar so they don’t overlap.
​
sidebar.source
string
default:"highlightLines.items"
Sets the data source for the text displayed in the sidebar. Valid options: param, highlightLines.items, chatMessages, transcript
​
sidebar.padding_gu
number
default:"1.5"
Padding inside the sidebar, specified in grid units.
​
sidebar.width_pct_landscape
number
default:"30"
Sets the width of the sidebar, as a percentage of the viewport size, applied when the viewport is landscape (its aspect ratio is greater than 1).
​
sidebar.height_pct_portrait
number
default:"25"
Sets the width of the sidebar, as a percentage of the viewport size, applied when the viewport is portrait or square (its aspect ratio is less than or equal to 1).
​
sidebar.bgColor
text
default:"rgba(0, 0, 50, 0.55)"
Sets the sidebar’s background color and opacity. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
sidebar.textColor
text
default:"rgba(255, 255, 255, 0.94)"
Sets the sidebar’s text color and opacity. Valid options:
  • Hex color codes
  • RGB or RGBA syntax
  • Standard CSS color names (e.g. ‘blue’)
​
sidebar.fontFamily
string
default:"DMSans"
Sets the font of text displayed in the sidebar. Valid options: DMSans, Roboto, RobotoCondensed, Anton, Bangers, Bitter, Exo, Magra, PermanentMarker, SuezOne, Teko
​
sidebar.fontWeight
string
default:"300"
Sets the sidebar 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.
​
sidebar.fontStyle
string
default:""
Sets the font style for text in the sidebar. Valid options: ‘normal’,‘italic’.
​
sidebar.fontSize_gu
number
default:"1.4"
Sets the sidebar text 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).
​
sidebar.textHighlight.color
text
default:"rgba(255, 230, 0, 1)"
Sets the color used for the highlighted item in the sidebar.
​
sidebar.textHighlight.fontWeight
string
default:"600"
Sets the font weight used for the highlighted item in the sidebar.
​
highlightLines.items
text
Sets a list of text items. Items must be separated by newline characters. This param is a data source that can be displayed in other components like TextOverlay, Banner and Sidebar using the various “source” params available in the settings for those components.
​
highlightLines.position
number
default:"0"
Sets the highlight index associated with the text items specified in highlightLines.items. The item at this index will be displayed using a special highlight style (which depends on the component used to display this data). If you don’t want a highlight, set this value to -1.
​
emojiReactions.source
string
default:"emojiReactions"
Sets the data source used for emoji reactions. The default value emojiReactions means that this component will display emojis that are sent via the standard source API.The other valid option is param, which lets you send a reaction using param values instead of the standard source. The steps are as follows: set emojiReactions.source to param, set a single-emoji string for emojiReactions.emoji, and increment the value of emojiReactions.key to send one emoji for display.
​
emojiReactions.key
number
default:"0"
If emojiReactions.source is set to param, increment this numeric key to send a new emoji for display.
​
emojiReactions.emoji
text
default:""
If emojiReactions.source is set to param, set a single emoji as the string value for this param, and it will be the next emoji reaction rendered when emojiReactions.key is incremented.
​
emojiReactions.offset_x_gu
number
default:"0"
Sets a horizontal offset applied to the emoji reactions animation rendering (each new emoji floats up from the bottom of the screen). Specified in grid units.
​
debug.showRoomState
boolean
default:"false"
When set to true, a room state debugging display is visible. It prints various information about participant state.
​
debug.overlayOpacity
number
default:"90"
Sets the opacity of the debugging display which can be toggled using debug.showRoomState.

​
Selecting participants

The baseline composition has several modes that display multiple participant videos. You may be wondering how to control which participants appear in specific places within those layouts. Internally, VCS uses an ordered array of video inputs that it calls “video input slots”. By default, that array will contain all participants in the order in which they joined the call. But there are two ways you can override this default behavior and choose which participants appear in your layout:
  1. Participant selection on the room level using the participants property.
  2. Input reordering on the composition level (a.k.a. switching) using the preferredParticipantIds and preferScreenshare params available in the baseline composition.
These two are not mutually exclusive. What’s the difference, and when should you use one or the other? Room-level participant selection is a powerful generic tool. It lets you choose any participants within the room, and will trigger any necessary backend connections so that a participant’s audio and video streams become available to the VCS rendering server. This means there may be a slight delay as connections are made. In contrast, composition-level input reordering (a.k.a. switching) happens at the very last moment in the VCS engine just before a video frame is rendered. (The name “switching” refers to a video switcher, a hardware device used in traditional video production for this kind of input control.) It’s applied together with any other composition param updates you’re sending, so there is a guarantee of synchronization. You should use this method when you want to ensure that the reordering of inputs happens precisely at the same time as your update to some other composition param value(s). For example, if you’re switching a layout mode and want the inputs to be sorted in a different way simultaneously. You can use the two methods together. Room-level selection using the participants property lets you establish the participants whose streams will be available to the rendering. You can then do rapid switching within that selection using the preferredParticipantIds and preferScreenshare params in the baseline composition. Here’s an example of selecting three specific participant video tracks, everyone’s audio tracks, and sorting the video by most recent active speaker: 
{
	layout: {
		preset: "custom",
		composition_params: {...},
		participants: {
			video: ["participant-guid-1", "participant-guid-2", "participant-guid-3"],
			audio: ["*"],
			sort: "active"
		}
	}
}
Here’s another example where we’re further sorting the same video tracks using the baseline composition params. The params update is switching to a different layout mode ('split'). This mode can only show two participants, so we use videoSettings.preferredParticipantIds to select the two participants in a clean frame-synchronized way, without having to modify the underlying connections made via the participants property: 
{
	layout: {
		preset: "custom",
		composition_params: {
			mode: 'split',
			'videoSettings.preferredParticipantIds': 'participant-guid-2, participant-guid-1',
		},
		participants: {
			video: ["participant-guid-1", "participant-guid-2", "participant-guid-3"],
			audio: ["*"],
			sort: "active"
		}
	}
}
If you include the participants object in a startLiveStreaming()/startRecording() or updateLiveStreaming()/updateRecording() call, you need to include it in any subsequent updateLiveStreaming()/updateRecording() calls as well, even if you aren’t changing it.If you set the participants property for your recording or live stream and then make an updateLiveStreaming()/updateRecording() call to update the composition_params, you’ll need to resend the same values you used before in the participants property. This is true even if you are not updating the participants property. If you don’t, the participant configuration will reset to default, as if you hadn’t set it in the first place —meaning VCS will receive all audio and video tracks from all participants, sorted by the order in which the participants joined the call.

​
participants properties

​
video
array
Required. An array of strings indicating which participant videos to make available to VCS. Possible values are:
  • ["participant-guid-1", "participant-guid-2", "participant-guid-3"]: A list of specific participant IDs
  • ["*"]: everyone
  • ["owners"]: All call owners
​
audio
array
An optional array of strings indicating which participant audio tracks to make available to VCS. Possible values are the same as the video property.
​
sort
string
The only currently valid value for this property is "active". This property controls the order in which VCS sees the participant video tracks. When set to "active", each time the call’s active speaker changes to a different participant, that participant will bubble up to the first position in the array. In other words, setting sort to "active" will cause an n-tile layout to always show the n most recent speakers in the call. If you leave the property unset, the list of participants will stay in a fixed order: either the order you specified in the video property, or in the order they joined the call if you use "*" or "owners".

​
Session assets

Session assets — images or custom VCS components — that can be passed as assets and used during a live stream or cloud recording. To learn more, visit our Session assets page in the VCS SDK reference docs. Note: Session assets must be made available at the beginning of the recording or live stream even if they are not used until later in the call. 
await call.startLiveStreaming({
  instanceId: '00000000-0000-4000-8000-000000000000', // optional: default value
  rtmpUrl: 'RTMP_URL',
  width: 1280,
  height: 720,
  layout: {
    preset: 'custom', // required
    composition_id: 'daily:baseline', // optional: default value
    composition_params: {
      // ... Add your composition params here
    },
    session_assets: {
      // the key can be any string
      // the value must be an absolute URL to a hosted asset
      'images/logo': 'https://example.com/foobar.png',
    },
  },
});

​
Default values

​
Composition parameter defaults

​
See also

Types

Methods

Events