REST ClientVideoVideoConferences

createStream

View as MarkdownOpen in Claude

Create a new stream for a conference, enabling external streaming output (e.g., RTMP to a streaming platform).

Path parameters

idstringRequired
Unique id of a video conference

Request

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

Response

idstringRequiredformat: "uuid"
Unique identifier for the stream.
urlstring or nullRequired
RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.
stream_typestring or nullRequired
The type of stream.
widthinteger or nullRequired
The stream's width in pixels.
heightinteger or nullRequired
The stream's height in pixels.
fpsinteger or nullRequired
The stream's frames per second.
created_atdatetimeRequired
Timestamp when the stream was created.
updated_atdatetimeRequired
Timestamp when the stream was last updated.

Response Example

Response
1{
2  "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
3  "url": "rtmp://broadcaster",
4  "stream_type": "rtmp",
5  "width": 1920,
6  "height": 1080,
7  "fps": 20,
8  "created_at": "2022-01-01T10:00:00Z",
9  "updated_at": "2022-01-01T11:00:00Z"
10}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com",
7});
8
9const stream = await client.video.conferences.createStream("conference-id", {
10  url: "rtmp://live.example.com/key",
11});