Skip to navigation

listStreams

View as MarkdownOpen in Claude

List streams associated with a video room.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the video room.

Response

datalist of objectsRequired
List of streams.

Response Example

Response
{
"links": {
"self": "https://example.signalwire.com/api/video/rooms?page=2",
"first": "https://example.signalwire.com/api/video/rooms?page=1",
"next": "https://example.signalwire.com/api/video/rooms?page=3",
"prev": "https://example.signalwire.com/api/video/rooms?page=1"
},
"data": [
{
"id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
"url": "rtmp://broadcaster",
"stream_type": "rtmp",
"width": 1920,
"height": 1080,
"fps": 20,
"created_at": "2022-01-01T10:00:00Z",
"updated_at": "2022-01-01T11:00:00Z"
}
]
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
project: "your-project-id",
token: "your-api-token",
host: "your-space.signalwire.com",
});
const streams = await client.video.rooms.listStreams("room-id");
for (const stream of streams.data ?? []) {
console.log(`${stream.url}: ${stream.id}`);
}