Video Client

The Video Client allows you to monitor video room activity. It connects to SignalWire and notifies you when rooms start, end, or when participants join and leave.

1
import { Video } from "@signalwire/realtime-api";
2
3
const video = new Video.Client({
4
  project: "<project-id>",
5
  token: "<api-token>",
6
});

Once instantiated, use getRoomSessions to list active rooms, or subscribe to events like room.started and room.ended. See Events for all available events.

Constructor

▸ new Video.Client(opts): Video.Client

Creates a new Video Client instance.

Parameters

Examples

Listening for room events

1
video.on("room.started", async (roomSession) => {
2
  console.log("Room started:", roomSession.name);
3
});
4
5
video.on("room.ended", async (roomSession) => {
6
  console.log("Room ended:", roomSession.id);
7
});

Getting active rooms

1
const { roomSessions } = await video.getRoomSessions();