v2

latestOpenAPI 3.0.32026-07-266076394.0 KB

rooms

rooms/:name/live-streaming/start

Start a live stream in a room

post/rooms/{room_name}/live-streaming/start

Path parameters

room_namestring required

Request body

widthnumber

Property that specifies the output width of the given stream.

heightnumber

Property that specifies the output height of the given stream.

fpsnumber

Property that specifies the video frame rate per second.

videoBitratenumber

Property that specifies the video bitrate for the output video in kilobits per second (kbps).

audioBitratenumber

Property that specifies the audio bitrate for the output audio in kilobits per second (kbps).

minIdleTimeOutnumber

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.

maxDurationnumber

Maximum duration in seconds after which recording/streaming is forcefully stopped. Default: `15000` seconds (3 hours). This is a preventive circuit breaker to prevent billing surprises in case a user starts recording/streaming and leaves the room.

backgroundColorstring

Specifies the background color of the stream, formatted as #rrggbb or #aarrggbb string.

instanceIdstring

UUID for a streaming or recording session. Used when multiple streaming or recording sessions are running for single room.

type'cloud' | 'cloud-audio-only' | 'raw-tracks'

The type of recording that will be started.

dataOutputsstring[]

Specifies the types of recording-associated data outputs ("event-json", "transcript-webvtt", "chat-webvtt") to start. Value must be an array listing the requested data outputs.

Response

200