Overview
100ms rooms can be live streamed over HLS (HTTP Live Streaming). 100ms live streams return a playback URL (in m3u8 format), which is compatible with any HLS video player.
Live streams can be optionally recorded—and generate two types of recording assets, based on enabled flags:
hls_vod
: Setting this to true generates aroom-vod
asset for on-demand playback use-casessingle_file_per_layer
: Setting this to true generates multipleroom-composite
assets, each representing 1 layer of the live stream
Endpointhttps://api.100ms.live/v2/live-streams
Object
Property | Description |
---|---|
id | Unique identifier for the live stream object |
room_id | Identifier of the room where this stream was started |
session_id | Identifier of the session where this stream was started |
status | Status of the live stream, can be one of starting , running , stopping , post_processing , completed , failed |
playback | This object contains the m3u8 url for playback |
recording | Object with boolean flags to enable recording types |
meeting_url | Meeting URL opened in the web browser that is composing the stream |
destination | Name of the destination on your template to define stream configuration |
recording_assets | Array of recording assets that are generated out of the stream |
created_at | Timestamp for when the external stream was created |
started_at | Timestamp for when the external stream was started |
started_by | Identifier of the peer who started the external stream. If the stream was started from server-side, this is an empty string |
stopped_at | Timestamp for when the external stream was stopped |
stopped_by | Identifier of the peer who stopped the external stream. If the stream was stopped from server-side, this is an empty string |
updated_at | Timestamp for when the external stream was updated |
Postman collection
You can use our Postman collection to start exploring 100ms APIs. Use the Postman guide to get started.
Have a suggestion? Recommend changes ->