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 a room-vod asset for on-demand playback use-cases
  • single_file_per_layer: Setting this to true generates multiple room-composite assets, each representing 1 layer of the live stream
Endpointhttps://api.100ms.live/v2/live-streams

Object

PropertyDescription
idUnique identifier for the live stream object
room_idIdentifier of the room where this stream was started
session_idIdentifier of the session where this stream was started
statusStatus of the live stream, can be one of starting, running, stopping, post_processing, completed, failed
playbackThis object contains the m3u8 url for playback
recordingObject with boolean flags to enable recording types
meeting_urlMeeting URL opened in the web browser that is composing the stream
destinationName of the destination on your template to define stream configuration
recording_assetsArray of recording assets that are generated out of the stream
created_atTimestamp for when the external stream was created
started_atTimestamp for when the external stream was started
started_byIdentifier of the peer who started the external stream. If the stream was started from server-side, this is an empty string
stopped_atTimestamp for when the external stream was stopped
stopped_byIdentifier of the peer who stopped the external stream. If the stream was stopped from server-side, this is an empty string
updated_atTimestamp 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.

Run in Postman


Have a suggestion? Recommend changes ->

Run in postman

Was this helpful?

1234