Video

Video

View as Markdown

Access the Video API Consumer. You can instantiate a Video.Client to subscribe to Video events. Make sure to check the full list of events that a Video.Client can subscribe to.

Example

The following example logs whenever a room session is started or a user joins it:

1import { Video } from "@signalwire/realtime-api";
2
3const video = new Video.Client({ project, token });
4
5// Listen for events:
6video.on("room.started", async (roomSession) => {
7  console.log("Room has started:", roomSession.name);
8
9  roomSession.on("member.joined", async (member) => {
10    console.log("Member joined:", member.name);
11  });
12});
13
14// Get active room sessions:
15const { roomSessions } = await video.getRoomSessions();

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.