Start live stream for a room
Use this to start a live stream for a room. This would return a playback URL (in m3u8 format) that can be shared with HLS player clients for playback.
The live stream will be in starting
state to begin with, and turn into running
shortly.
POSThttps://api.100ms.live/v2/live-streams/room/<room_id>/start
curl --location --request POST 'https://api.100ms.live/v2/live-streams/room/<room_id>/start' \ --header 'Authorization: Bearer <management_token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "meeting_url" : "<meeting_url>", "recording": { "hls_vod": true, "single_file_per_layer": true } }'
RESPONSE
Status: 200 OK
{ "id": "<stream_id>", "room_id": "<room_id>", "session_id": "<session_id>", "status": "starting", "meeting_url": "<meeting_url>", "playback": { "url": "<master-manifest-url>" }, "recording": { "hls_vod": true, "single_file_per_layer": true }, "destination": "<destination_name>", "created_at": "2023-03-22T04:24:10.155978231Z", "started_at": null, "updated_at": "2023-03-22T04:24:10.155978231Z", "started_by": "", "stopped_at": null, "stopped_by": "", "recording_assets": null }
Parameters
Name | Type | Description | Required |
---|---|---|---|
meeting_url | string | Single click meeting URL for the stream | No |
recording | object | Flags to enable recording | No |
destination | string | Name of destination from template to pick up configuration | No |
meeting_url
This is a URL which lands into the room directly. You can use 100ms room links that look like:
https://<domain>.app.100ms.live/preview/<room_id>/<role>?skip_preview=true
Other supported query parameters:
skip_preview=true
: skips the preview page and directly joins the meeting with header and controls disabledskip_preview_headful=true
: skips the preview page and directly joins the meeting with header and controls enabledauth_token=token1234
: Use this to pass an auth token to authenticate the room join actionui_mode=activespeaker
: Render active speaker mode by defaultname=johndoe
: Use this to add a name for the peer
recording
Name | Type | Description | Required |
---|---|---|---|
hls_vod | bool | Generate a room-vod asset for on-demand playback use-case | No |
single_file_per_layer | bool | Generate room-composite assets, one for each layer | No |
Have a suggestion? Recommend changes ->