Video

RoomSessionRecording

View as Markdown

Represents a specific recording of a room session.

Properties

id
stringRequired

The unique ID of this recording.

roomId
stringRequired

The ID of the room associated to this recording.

roomSessionId
stringRequired

The ID of the room session associated to this recording.

state
"recording" | "paused" | "completed"Required

Current state.

duration
number

Duration, if available.

startedAt
Date

Start time, if available.

endedAt
Date

End time, if available.

hasEnded
booleanRequired

Whether the recording has ended. Returns true if the state is "completed".

Methods

pause

▸ pause(): Promise<void>

Pauses the recording.

Returns

Promise<void>

Example

In this example, we start a recording and pause it after 5 seconds. This example assumes you have already created a RoomSession and members are joining.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Initialize the SignalWire client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" });
5
6// Access video client from the main client
7const videoClient = client.video;
8
9// Setup listener for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomSession) => {
12    console.log("Room started", roomSession.displayName);
13
14    let roomRecording =  roomSession.startRecording({
15      listen: {
16        onStarted: () => {
17          console.log("Recording started");
18        },
19        onEnded: (recording) => {
20          console.log(`Recording ended.
21          Recording State: ${recording.state}.
22          Recording Id: ${recording.id}`);
23        },
24      }
25    })
26    await roomSession.listen({
27      onRecordingUpdated: (recording) => {
28        console.log(`Recording State: ${recording.state}. Recording Id: ${recording.id}`);
29      },
30      onMemberJoined: async (member) => {
31        console.log("Member joined", member.name);
32    },
33      onMemberLeft: (member) => {
34        console.log("Member left", member.name);
35      },
36    })
37
38    // Pausing the recording after 5 seconds
39    setTimeout(async () => {
40      console.log("Stopping recording");
41      await roomRecording.pause();
42    }, 5000);
43  },
44  onRoomEnded: async (roomSession) => {
45    console.log("Room ended", roomSession.displayName);
46  }
47});

resume

▸ resume(): Promise<void>

Resumes the recording.

Returns

Promise<void>

Example

In this example, we start a recording and pause it after 5 seconds. Then we resume the recording after another 5 seconds of being paused. This example assumes you have already created a RoomSession and members are joining.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Initialize the SignalWire client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" });
5
6// Access video client from the main client
7const videoClient = client.video;
8
9// Setup listener for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomSession) => {
12    console.log("Room started", roomSession.displayName);
13
14    let roomRecording =  roomSession.startRecording({
15      listen: {
16        onStarted: () => {
17          console.log("Recording started");
18        },
19        onEnded: (recording) => {
20          console.log(`Recording ended.
21          Recording State: ${recording.state}.
22          Recording Id: ${recording.id}`);
23        },
24      }
25    })
26
27    await roomSession.listen({
28      onRecordingUpdated: (recording) => {
29        console.log(`Recording State: ${recording.state}. Recording Id: ${recording.id}`);
30      },
31      onMemberJoined: async (member) => {
32        console.log("Member joined", member.name);
33
34    },
35      onMemberLeft: (member) => {
36        console.log("Member left", member.name);
37      },
38    })
39
40    // Pause the recording after 5 seconds
41    setTimeout(async () => {
42      console.log("Pausing recording");
43      await roomRecording.pause();
44
45      // Resume the recording after 5 seconds
46      setTimeout(() => {
47        console.log("Resuming recording");
48        roomRecording.resume();
49      }, 5000);
50    }, 5000);
51  },
52  onRoomEnded: async (roomSession) => {
53    console.log("Room ended", roomSession.displayName);
54  }
55});

stop

▸ stop(): Promise<void>

Stops the recording.

Returns

Promise<void>

Example

In this example, we start a recording and stop it after 5 seconds. This example assumes you have already created a RoomSession and members are joining.

1import { SignalWire } from "@signalwire/realtime-api";
2
3// Initialize the SignalWire client
4const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" });
5
6// Access video client from the main client
7const videoClient = client.video;
8
9// Setup listener for when a room starts
10await videoClient.listen({
11  onRoomStarted: async (roomSession) => {
12    console.log("Room started", roomSession.displayName);
13
14    let roomRecording =  roomSession.startRecording({
15      listen: {
16        onStarted: () => {
17          console.log("Recording started");
18        },
19        onEnded: (recording) => {
20          console.log(`Recording ended.
21          Recording State: ${recording.state}.
22          Recording Id: ${recording.id}`);
23        },
24      }
25    })
26
27    await roomSession.listen({
28      onRecordingUpdated: (recording) => {
29        console.log(`Recording State: ${recording.state}. Recording Id: ${recording.id}`);
30      },
31      onMemberJoined: async (member) => {
32        console.log("Member joined", member.name);
33
34    },
35      onMemberLeft: (member) => {
36        console.log("Member left", member.name);
37      },
38    })
39
40    // Stopping the recording after 5 seconds
41    setTimeout(async () => {
42      console.log("Stopping recording");
43      await roomRecording.stop();
44    }, 5000);
45  },
46  onRoomEnded: async (roomSession) => {
47    console.log("Room ended", roomSession.displayName);
48  }
49});

Events

onStarted

▸ RoomSessionRecording({ listen: {onStarted: Callback }})

Emitted when the recording starts.

Parameters

recording
RoomSessionRecordingRequired

The recording that started. See RoomSessionRecording.

onUpdated

▸ RoomSessionRecording({ listen: {onUpdated: Callback }})

Emitted when the recording is updated.

Parameters

recording
RoomSessionRecordingRequired

The recording that updated. See RoomSessionRecording.

onEnded

▸ RoomSessionRecording({ listen: {onEnded: Callback }})

Emitted when the recording ends.

Parameters

recording
RoomSessionRecordingRequired

The recording that ended. See RoomSessionRecording.