@@ -9,40 +9,38 @@ description: Access the Video API for building video conferencing applications.
99max-toc-depth : 3
1010---
1111
12- [ browser-sdk ] : /browser-sdk/js/reference/video/room-session
13- [ client ] : ./client/index.mdx
14- [ create-a-room-rest-api ] : /apis/video/rooms/create-room
15- [ personal-video-conference-pvc ] : /platform/video
16- [ roomsession-2 ] : ./video-roomsession.mdx
17- [ roomsession-3 ] : ./video-roomsession.mdx
18- [ roomsessionfullstate ] : ./video-roomsessionfullstate.mdx
19- [ roomsessionmember ] : ./video-roomsessionmember.mdx
20- [ roomsessionplayback ] : ./video-roomsessionplayback.mdx
21- [ roomsessionrecording ] : ./video-roomsessionrecording.mdx
22- [ video-client-1 ] : ./client/index.mdx
23- [ video-client-2 ] : ./client/events.mdx#onroomstarted
24- [ video-client ] : ./client/events.mdx
25- [ video-roomsession-1 ] : ./video-roomsession.mdx#onmemberleft
26- [ video-roomsession-2 ] : ./video-roomsession.mdx#listen
27- [ video-roomsession ] : ./video-roomsession.mdx#onmemberjoined
12+ [ browser-sdk ] : /docs/browser-sdk/js/reference/video/room-session
13+ [ client ] : /docs/server-sdk/node/reference/video/client
14+ [ create-a-room-rest-api ] : /docs/apis/video/rooms/create-room
15+ [ personal-video-conference-pvc ] : /docs/platform/video
16+ [ roomsession ] : /docs/server-sdk/node/reference/video/room-session
17+ [ roomsessionfullstate ] : /docs/server-sdk/node/reference/video/room-session-full-state
18+ [ roomsessionmember ] : /docs/server-sdk/node/reference/video/room-session-member
19+ [ roomsessionplayback ] : /docs/server-sdk/node/reference/video/room-session-playback
20+ [ roomsessionrecording ] : /docs/server-sdk/node/reference/video/room-session-recording
21+ [ video-client-events ] : /docs/server-sdk/node/reference/video/client/events
22+ [ video-client-onroomstarted ] : /docs/server-sdk/node/reference/video/client/events#onroomstarted
23+ [ video-roomsession-onmemberleft ] : /docs/server-sdk/node/reference/video/room-session/events#onmemberleft
24+ [ video-roomsession-listen ] : /docs/server-sdk/node/reference/video/room-session/listen
25+ [ video-roomsession-onmemberjoined ] : /docs/server-sdk/node/reference/video/room-session/events#onmemberjoined
2826
29- Access the Video API Consumer. You can instantiate a [ Video.Client] [ video- client-1 ] to subscribe to Video events.
27+ Access the Video API Consumer. You can instantiate a [ Video.Client] [ client ] to subscribe to Video events.
3028
3129<Info >
32- For the full list of events that a [ Video.Client] [ video- client-1 ] can subscribe to, refer to [ Video Events] [ video-client ] .
30+ For the full list of events that a [ Video.Client] [ client ] can subscribe to, refer to [ Video Events] [ video-client-events ] .
3331</Info >
3432
3533#### Example
3634
3735The following example logs whenever a room session is started or when a user joins it.
38- A [ ` RoomSession ` ] [ roomsession-2 ] can be created through the [ Browser SDK] [ browser-sdk ] ,
36+ A [ ` RoomSession ` ] [ roomsession ] can be created through the [ Browser SDK] [ browser-sdk ] ,
3937 through the [ ` Create a Room REST API ` ] [ create-a-room-rest-api ] , or
4038through the SignalWire Dashboard, utilizing a [ Personal Video Conference (` PVC ` )] [ personal-video-conference-pvc ] .
4139
42- When a [ ` RoomSession ` ] [ roomsession-2 ] is created, the [ ` onRoomStarted ` ] [ video-client-2 ] event is triggered.
43- We can then subscribe to the [ ` RoomSession ` ] [ roomsession-2 ] events,
44- such as [ ` onMemberJoined ` ] [ video-roomsession ] and [ ` onMemberLeft ` ] [ video-roomsession-1 ] ,
45- using the [ ` listen ` ] [ video-roomsession-2 ] method.
40+ When a [ ` RoomSession ` ] [ roomsession ] is created, the [ ` onRoomStarted ` ] [ video-client-onroomstarted ] event is triggered.
41+ We can then subscribe to the [ ` RoomSession ` ] [ roomsession ] events,
42+ such as [ ` onMemberJoined ` ] [ video-roomsession-onmemberjoined ] and [ ` onMemberLeft ` ] [ video-roomsession-onmemberleft ] ,
43+ using the [ ` listen ` ] [ video-roomsession-listen ] method.
4644
4745``` js
4846import { SignalWire } from " @signalwire/realtime-api" ;
@@ -72,25 +70,25 @@ await videoClient.listen({
7270## ** Classes**
7371
7472<CardGroup cols = { 2 } >
75- <Card title = " Client" icon = " fa-solid fa-server" href = " /docs/realtime -sdk/node/reference/video/client" >
73+ <Card title = " Client" icon = " fa-solid fa-server" href = " /docs/server -sdk/node/reference/video/client" >
7674 The main Video client for subscribing to room events and monitoring video sessions.
7775 </Card >
78- <Card title = " RoomSession" icon = " fa-solid fa-door-open" href = " /docs/realtime -sdk/node/reference/video/room-session" >
76+ <Card title = " RoomSession" icon = " fa-solid fa-door-open" href = " /docs/server -sdk/node/reference/video/room-session" >
7977 Represents an active video room session with methods for managing members, recordings, and playback.
8078 </Card >
81- <Card title = " RoomSessionFullState" icon = " fa-solid fa-database" href = " /docs/realtime -sdk/node/reference/video/room-session-full-state" >
79+ <Card title = " RoomSessionFullState" icon = " fa-solid fa-database" href = " /docs/server -sdk/node/reference/video/room-session-full-state" >
8280 Extended room session object containing the complete state including all members and metadata.
8381 </Card >
84- <Card title = " RoomSessionMember" icon = " fa-solid fa-user" href = " /docs/realtime -sdk/node/reference/video/room-session-member" >
82+ <Card title = " RoomSessionMember" icon = " fa-solid fa-user" href = " /docs/server -sdk/node/reference/video/room-session-member" >
8583 Represents a participant in a video room with properties for audio/video state and metadata.
8684 </Card >
87- <Card title = " RoomSessionPlayback" icon = " fa-solid fa-play" href = " /docs/realtime -sdk/node/reference/video/room-session-playback" >
85+ <Card title = " RoomSessionPlayback" icon = " fa-solid fa-play" href = " /docs/server -sdk/node/reference/video/room-session-playback" >
8886 Represents a playback instance in a video room for playing media content.
8987 </Card >
90- <Card title = " RoomSessionRecording" icon = " fa-solid fa-circle-dot" href = " /docs/realtime -sdk/node/reference/video/room-session-recording" >
88+ <Card title = " RoomSessionRecording" icon = " fa-solid fa-circle-dot" href = " /docs/server -sdk/node/reference/video/room-session-recording" >
9189 Represents a recording instance in a video room with methods to control recording state.
9290 </Card >
93- <Card title = " RoomSessionStream" icon = " fa-solid fa-broadcast-tower" href = " /docs/realtime -sdk/node/reference/video/room-session-stream" >
91+ <Card title = " RoomSessionStream" icon = " fa-solid fa-broadcast-tower" href = " /docs/server -sdk/node/reference/video/room-session-stream" >
9492 Represents an RTMP stream from a video room for streaming to external platforms.
9593 </Card >
9694</CardGroup >
0 commit comments