Video | SignalWire

Access the Video API Consumer. You can instantiate a Video.Client to subscribe to Video events.

For the full list of events that a Video.Client can subscribe to, refer to Video Events.

Example

The following example logs whenever a room session is started or when a user joins it. A RoomSession can be created through the Browser SDK, through the Create a Room REST API, or through the SignalWire Dashboard, utilizing a Personal Video Conference (PVC).

When a RoomSession is created, the onRoomStarted event is triggered. We can then subscribe to the RoomSession events, such as onMemberJoined and onMemberLeft, using the listen method.

1 import { SignalWire } from "@signalwire/realtime-api";
2 
3 const client = await SignalWire({ project: "ProjectID Here", token: "API Token Here" });
4 
5 const videoClient = client.video;
6 
7 await videoClient.listen({
8   onRoomStarted: async (roomSession) => {
9     console.log("Room started:", roomSession.displayName);
10     await roomSession.listen({
11       onMemberJoined: async (member) => {
12         console.log("Member joined:", member.name);
13       },
14       onMemberLeft: async (member) => {
15         console.log("Member left:", member.name);
16       }
17     });
18   },
19   onRoomEnded: async (roomSession) => {
20     console.log("Room ended:", roomSession.displayName);
21   }
22 });

Classes

Client

The main Video client for subscribing to room events and monitoring video sessions.

RoomSession

Represents an active video room session with methods for managing members, recordings, and playback.

RoomSessionFullState

Extended room session object containing the complete state including all members and metadata.

RoomSessionMember

Represents a participant in a video room with properties for audio/video state and metadata.

RoomSessionPlayback

Represents a playback instance in a video room for playing media content.

RoomSessionRecording

Represents a recording instance in a video room with methods to control recording state.

RoomSessionStream

Represents an RTMP stream from a video room for streaming to external platforms.