Overview
100ms rooms can be live streamed to external platforms that support RTMP-in (for example, YouTube, Twitch). These live streams are called external streams. An external stream maps to up to 3 RTMP URLs.
External streams can be optionally recorded by passing a boolean flag. This generates a room-composite recording asset at the end of the external stream.
Endpointhttps://api.100ms.live/v2/external-streams
Object
| Property | Description |
|---|---|
| id | Unique identifier for the external 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 external stream, can be one of starting, running, stopping, post_processing, completed, failed |
| rtmp_urls | Array of RTMP URLs where the live stream is sent |
| recording | Boolean flag of whether recording was enabled for this external stream |
| resolution | Width and height of the external stream |
| 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 ->
