startRecording()
startRecording()
If server-side recording (cloud) is enabled for the room, this starts a recording of all meeting participants that have their cams and/or mics on. Devices that are off will not be recorded. For example, if a participant's cam is off, it will not be recorded. Same goes for the mic.
It has no effect if recording is not enabled.
Control cloud recording layouts
Heads up! You must be running react-native-daily-js 0.18.0+ to try out the "cloud" recording type.
If you're using the cloud recording type, you can pass configuration properties to startRecording() to control the look and feel of the recording.
The options currently include:
-
height,width: Can be specified to control the resolution of the live stream -
backgroundColor: Specifies the background color of the stream, formatted as#rrggbbor#aarrggbbstring. -
fps: Specifies the video frame rate per second. -
minIdleTimeOut: Amount of time in seconds to wait before ending a recording or live stream when the room is idle (e.g. when all users have muted video and audio). Default:300(seconds). Note: Once the timeout has been reached, it typically takes an additional 1-3 minutes for the recording or live stream to be shut down. -
layout: an object specifying the way participants’ videos are laid out in the live stream. Apresetkey with one of the following values must be provided:'default': This is the default grid layout, which renders participants in a grid, or in a vertical grid to the right, if a screen share is enabled. Optionally, amax_cam_streamsinteger key can be provided to specify how many cameras to include in the grid. The default value is 20, which is also the maximum number of cameras in a grid. The maximum may be increased at a later date.'single-participant': Use this layout to limit the audio and video to be streamed to a specific participant. The selected participant’s session ID must be specified via asession_idkey.'active-participant': This layout focuses on the current speaker, and places up to 9 other cameras to the right in a vertical grid in the order in which they last spoke.'portrait': Allows for mobile-friendly layouts. The video will be forced into portrait mode, where up to 2 participants will be shown. An additionalvariantkey may be specified. Valid values are:'vertical'for a vertical grid layout (the default)'inset'for having one participant's video take up the entire screen, and the other inset in a smaller rectangle. Participants' videos are scaled and cropped to fit the entire available space. Participants with theis_ownerflag are shown lower in the grid (vertical variant), or full screen (inset variant).
'custom': Allows for custom layouts. (See below.)
Daily offers a "baseline" composition option via the "custom" layout preset for customizing your video layouts while recording. This option allows for even more flexibility while using Daily's recording API.
Many VCS properties use a "grid unit". The grid unit is a designer-friendly, device-independent unit. The default grid size is 1/36 of the output's minimum dimension. In other words, 1gu = 20px on a 720p stream and 30px on a 1080p stream. Learn more about grid units in our [VCS SDK docs](/reference/vcs/layout-api#the-grid-unit).
Baseline composition properties
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.
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.
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')
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. Steps: 0.01.
Padding around the row/column of “chiclet” items, in grid units. Steps: 0.01.
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. Steps: 1.
Sets the margin between the smaller video and the edge of the frame in the pip layout. Steps: 0.01.
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 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 offset value for participant labels on the x-axis, measured in grid units. Steps: 0.1
Sets the offset value for participant labels on the y-axis, measured in grid units. Steps: 0.1
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 right margin value applied to videos. Steps: 1.
Sets the bottom margin value applied to videos. Steps: 1.
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 to be applied to the text overlay's position based on the values of text.align_horizontal and text.align_vertical. Steps: 0.1
Sets a Y offset to be applied to the text overlay's position based on the values of text.align_horizontal and text.align_vertical. Steps: 0.1
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 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). Steps: 0.1
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 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 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 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 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 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.
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" in a few different places. By default, that array will contain all participants in the order in which they joined the call. But you can control which participants are available to VCS, and the order in which they appear, using the participants property. Specific VCS compositions may also have additional controls for specific track order. For example, the baseline composition has a property for moving screenshare tracks to the top of the track list.
Here's an example of selecting three specific participant video tracks, everyone's audio tracks, and sorting the video by most recent active speaker:
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
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
An optional array of strings indicating which participant audio tracks to make available to VCS. Possible values are the same as the video property.
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.