Create a Stream for a Room

POST 
/rooms/:id/streams

Permissions

The API token must include the following scopes: Video.

Request

Path Parameters

id uuidrequired
Unique id of a video room
Example: fe4093d9-58c2-4931-b4b9-5679f82652c6

application/json

Body

required

url string

RTMP or RTMPS url. This must be the address of a server accepting incoming RTMP/RTMPS streams.

Responses

200

OK

application/json

Schema

Schema

id uuid

A unique identifier for the stream

url string

RTMP or RTMPS url. This must be the address of a server accepting incoming RTMP/RTMPS streams.

stream_type string

The type of stream.

width integer

The stream's width.

height integer

The stream's height.

fps integer

The stream's fps

created_at date-time
updated_at date-time

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "url": "rtmp://broadcaster",
  "stream_type": "rtmp",
  "width": 0,
  "height": 0,
  "fps": "20",
  "created_at": "2024-07-12T14:04:37.582Z",
  "updated_at": "2024-07-12T14:04:37.582Z"
}

Loading...