Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ New to the Realtime SDK? Start with our first steps guides to learn the fundamen
<CardGroup cols={1}>
<Card
title="First Steps with Voice"
href="/docs/realtime-sdk/guides/make-and-receive-calls"
href="/docs/server-sdk/node/guides/get-started-with-voice"
icon="fa-solid fa-phone"
>
Learn to make and receive phone calls from your Node.js application. Configure phone numbers, handle inbound calls, and dial outbound calls.
</Card>
{/*
<Card
title="First Steps with Messaging"
href="/docs/realtime-sdk/guides/first-steps-with-messaging"
href="/docs/server-sdk/node/guides/first-steps-with-messaging"
icon="fa-solid fa-message"
>
Send and receive SMS messages from your Node.js application. Set up messaging, handle inbound texts, and send outbound messages.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ await chatClient.listen({
## **Classes**

<CardGroup cols={2}>
<Card title="Client" icon="fa-solid fa-server" href="/docs/realtime-sdk/node/reference/chat/client">
<Card title="Client" icon="fa-solid fa-server" href="/docs/server-sdk/node/node/reference/chat/client">
The main Chat client for sending messages, managing members, and subscribing to chat events.
</Card>
<Card title="ChatMember" icon="fa-solid fa-user" href="/docs/realtime-sdk/node/reference/chat/chat-member">
<Card title="ChatMember" icon="fa-solid fa-user" href="/docs/server-sdk/node/node/reference/chat/chat-member">
Represents a member in a chat channel with properties for identity and state.
</Card>
<Card title="ChatMessage" icon="fa-solid fa-message" href="/docs/realtime-sdk/node/reference/chat/chat-message">
<Card title="ChatMessage" icon="fa-solid fa-message" href="/docs/server-sdk/node/node/reference/chat/chat-message">
Represents a chat message with content, sender information, and metadata.
</Card>
</CardGroup>
Original file line number Diff line number Diff line change
Expand Up @@ -161,35 +161,35 @@ await videoClient.listen({
<CardGroup cols={3}>
<Card
title="Voice"
href="/docs/realtime-sdk/reference/voice/client"
href="/docs/server-sdk/node/reference/voice/client"
icon="fa-solid fa-phone"
>
Make and receive calls, play audio, record, and build IVRs
</Card>
<Card
title="Video"
href="/docs/realtime-sdk/reference/video/client"
href="/docs/server-sdk/node/reference/video/client"
icon="fa-solid fa-video"
>
Monitor video rooms, members, recordings, and streams
</Card>
<Card
title="PubSub"
href="/docs/realtime-sdk/reference/pubsub/client"
href="/docs/server-sdk/node/reference/pubsub/client"
icon="fa-solid fa-tower-broadcast"
>
Publish and subscribe to real-time message channels
</Card>
<Card
title="Chat"
href="/docs/realtime-sdk/reference/chat/client"
href="/docs/server-sdk/node/reference/chat/client"
icon="fa-solid fa-comments"
>
Build chat applications with members and messages
</Card>
<Card
title="Task"
href="/docs/realtime-sdk/reference/task/client"
href="/docs/server-sdk/node/reference/task/client"
icon="fa-solid fa-list-check"
>
Distribute tasks to workers via topic routing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,19 +89,19 @@ const pubSubClient = client.pubSub;
### Available Namespace Clients

<CardGroup cols={2}>
<Card title="Voice" icon="fa-solid fa-phone" href="/docs/realtime-sdk/node/reference/voice/client">
<Card title="Voice" icon="fa-solid fa-phone" href="/docs/server-sdk/node/node/reference/voice/client">
Make and receive phone calls, play audio, gather input, and build IVR systems.
</Card>
<Card title="Video" icon="fa-solid fa-video" href="/docs/realtime-sdk/node/reference/video/client">
<Card title="Video" icon="fa-solid fa-video" href="/docs/server-sdk/node/node/reference/video/client">
Monitor video rooms, track participants, and manage recordings.
</Card>
<Card title="Chat" icon="fa-solid fa-comments" href="/docs/realtime-sdk/node/reference/chat/client">
<Card title="Chat" icon="fa-solid fa-comments" href="/docs/server-sdk/node/node/reference/chat/client">
Real-time chat messaging between users across channels.
</Card>
<Card title="Task" icon="fa-solid fa-list-check" href="/docs/realtime-sdk/node/reference/task/client">
<Card title="Task" icon="fa-solid fa-list-check" href="/docs/server-sdk/node/node/reference/task/client">
Distribute tasks to workers for server-side processing.
</Card>
<Card title="PubSub" icon="fa-solid fa-tower-broadcast" href="/docs/realtime-sdk/node/reference/pubsub/client">
<Card title="PubSub" icon="fa-solid fa-tower-broadcast" href="/docs/server-sdk/node/node/reference/pubsub/client">
Publish and subscribe to messages across channels.
</Card>
</CardGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ In the example above:
## **Classes**

<CardGroup cols={2}>
<Card title="Client" icon="fa-solid fa-server" href="/docs/realtime-sdk/messaging/client">
<Card title="Client" icon="fa-solid fa-server" href="/docs/server-sdk/node/messaging/client">
The main Messaging client for sending SMS/MMS and listening for inbound message events.
</Card>
<Card title="MessageContract" icon="fa-solid fa-file-contract" href="/docs/realtime-sdk/messaging/message-contract">
<Card title="MessageContract" icon="fa-solid fa-file-contract" href="/docs/server-sdk/node/messaging/message-contract">
Represents a message object with properties like from, to, body, and media attachments.
</Card>
<Card title="MessagingSendResult" icon="fa-solid fa-paper-plane" href="/docs/realtime-sdk/messaging/messaging-sendresult">
<Card title="MessagingSendResult" icon="fa-solid fa-paper-plane" href="/docs/server-sdk/node/messaging/messaging-sendresult">
The result object returned after sending a message, containing delivery status information.
</Card>
</CardGroup>
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ await pubSubClient.listen({
## **Classes**

<CardGroup cols={2}>
<Card title="Client" icon="fa-solid fa-server" href="/docs/realtime-sdk/node/reference/pubsub/client">
<Card title="Client" icon="fa-solid fa-server" href="/docs/server-sdk/node/node/reference/pubsub/client">
The main PubSub client for publishing messages and subscribing to channels.
</Card>
<Card title="PubSubMessage" icon="fa-solid fa-envelope" href="/docs/realtime-sdk/node/reference/pubsub/pubsub-message">
<Card title="PubSubMessage" icon="fa-solid fa-envelope" href="/docs/server-sdk/node/node/reference/pubsub/pubsub-message">
Represents a message received on a PubSub channel with content and metadata.
</Card>
</CardGroup>
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ await taskClient.listen({
## **Classes**

<CardGroup cols={2}>
<Card title="Client" icon="fa-solid fa-server" href="/docs/realtime-sdk/node/reference/task/client">
<Card title="Client" icon="fa-solid fa-server" href="/docs/server-sdk/node/node/reference/task/client">
The main Task client for sending and receiving tasks between applications using topic-based routing.
</Card>
</CardGroup>
58 changes: 28 additions & 30 deletions fern/products/realtime-sdk/pages/latest/tech-ref/video/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,40 +9,38 @@ description: Access the Video API for building video conferencing applications.
max-toc-depth: 3
---

[browser-sdk]: /browser-sdk/js/reference/video/room-session
[client]: ./client/index.mdx
[create-a-room-rest-api]: /apis/video/rooms/create-room
[personal-video-conference-pvc]: /platform/video
[roomsession-2]: ./video-roomsession.mdx
[roomsession-3]: ./video-roomsession.mdx
[roomsessionfullstate]: ./video-roomsessionfullstate.mdx
[roomsessionmember]: ./video-roomsessionmember.mdx
[roomsessionplayback]: ./video-roomsessionplayback.mdx
[roomsessionrecording]: ./video-roomsessionrecording.mdx
[video-client-1]: ./client/index.mdx
[video-client-2]: ./client/events.mdx#onroomstarted
[video-client]: ./client/events.mdx
[video-roomsession-1]: ./video-roomsession.mdx#onmemberleft
[video-roomsession-2]: ./video-roomsession.mdx#listen
[video-roomsession]: ./video-roomsession.mdx#onmemberjoined
[browser-sdk]: /docs/browser-sdk/js/reference/video/room-session
[client]: /docs/server-sdk/node/reference/video/client
[create-a-room-rest-api]: /docs/apis/video/rooms/create-room
[personal-video-conference-pvc]: /docs/platform/video
[roomsession]: /docs/server-sdk/node/reference/video/room-session
[roomsessionfullstate]: /docs/server-sdk/node/reference/video/room-session-full-state
[roomsessionmember]: /docs/server-sdk/node/reference/video/room-session-member
[roomsessionplayback]: /docs/server-sdk/node/reference/video/room-session-playback
[roomsessionrecording]: /docs/server-sdk/node/reference/video/room-session-recording
[video-client-events]: /docs/server-sdk/node/reference/video/client/events
[video-client-onroomstarted]: /docs/server-sdk/node/reference/video/client/events#onroomstarted
[video-roomsession-onmemberleft]: /docs/server-sdk/node/reference/video/room-session/events#onmemberleft
[video-roomsession-listen]: /docs/server-sdk/node/reference/video/room-session/listen
[video-roomsession-onmemberjoined]: /docs/server-sdk/node/reference/video/room-session/events#onmemberjoined

Access the Video API Consumer. You can instantiate a [Video.Client][video-client-1] to subscribe to Video events.
Access the Video API Consumer. You can instantiate a [Video.Client][client] to subscribe to Video events.

<Info>
For the full list of events that a [Video.Client][video-client-1] can subscribe to, refer to [Video Events][video-client].
For the full list of events that a [Video.Client][client] can subscribe to, refer to [Video Events][video-client-events].
</Info>

#### Example

The following example logs whenever a room session is started or when a user joins it.
A [`RoomSession`][roomsession-2] can be created through the [Browser SDK][browser-sdk],
A [`RoomSession`][roomsession] can be created through the [Browser SDK][browser-sdk],
through the [`Create a Room REST API`][create-a-room-rest-api], or
through the SignalWire Dashboard, utilizing a [Personal Video Conference (`PVC`)][personal-video-conference-pvc].

When a [`RoomSession`][roomsession-2] is created, the [`onRoomStarted`][video-client-2] event is triggered.
We can then subscribe to the [`RoomSession`][roomsession-2] events,
such as [`onMemberJoined`][video-roomsession] and [`onMemberLeft`][video-roomsession-1],
using the [`listen`][video-roomsession-2] method.
When a [`RoomSession`][roomsession] is created, the [`onRoomStarted`][video-client-onroomstarted] event is triggered.
We can then subscribe to the [`RoomSession`][roomsession] events,
such as [`onMemberJoined`][video-roomsession-onmemberjoined] and [`onMemberLeft`][video-roomsession-onmemberleft],
using the [`listen`][video-roomsession-listen] method.

```js
import { SignalWire } from "@signalwire/realtime-api";
Expand Down Expand Up @@ -72,25 +70,25 @@ await videoClient.listen({
## **Classes**

<CardGroup cols={2}>
<Card title="Client" icon="fa-solid fa-server" href="/docs/realtime-sdk/node/reference/video/client">
<Card title="Client" icon="fa-solid fa-server" href="/docs/server-sdk/node/reference/video/client">
The main Video client for subscribing to room events and monitoring video sessions.
</Card>
<Card title="RoomSession" icon="fa-solid fa-door-open" href="/docs/realtime-sdk/node/reference/video/room-session">
<Card title="RoomSession" icon="fa-solid fa-door-open" href="/docs/server-sdk/node/reference/video/room-session">
Represents an active video room session with methods for managing members, recordings, and playback.
</Card>
<Card title="RoomSessionFullState" icon="fa-solid fa-database" href="/docs/realtime-sdk/node/reference/video/room-session-full-state">
<Card title="RoomSessionFullState" icon="fa-solid fa-database" href="/docs/server-sdk/node/reference/video/room-session-full-state">
Extended room session object containing the complete state including all members and metadata.
</Card>
<Card title="RoomSessionMember" icon="fa-solid fa-user" href="/docs/realtime-sdk/node/reference/video/room-session-member">
<Card title="RoomSessionMember" icon="fa-solid fa-user" href="/docs/server-sdk/node/reference/video/room-session-member">
Represents a participant in a video room with properties for audio/video state and metadata.
</Card>
<Card title="RoomSessionPlayback" icon="fa-solid fa-play" href="/docs/realtime-sdk/node/reference/video/room-session-playback">
<Card title="RoomSessionPlayback" icon="fa-solid fa-play" href="/docs/server-sdk/node/reference/video/room-session-playback">
Represents a playback instance in a video room for playing media content.
</Card>
<Card title="RoomSessionRecording" icon="fa-solid fa-circle-dot" href="/docs/realtime-sdk/node/reference/video/room-session-recording">
<Card title="RoomSessionRecording" icon="fa-solid fa-circle-dot" href="/docs/server-sdk/node/reference/video/room-session-recording">
Represents a recording instance in a video room with methods to control recording state.
</Card>
<Card title="RoomSessionStream" icon="fa-solid fa-broadcast-tower" href="/docs/realtime-sdk/node/reference/video/room-session-stream">
<Card title="RoomSessionStream" icon="fa-solid fa-broadcast-tower" href="/docs/server-sdk/node/reference/video/room-session-stream">
Represents an RTMP stream from a video room for streaming to external platforms.
</Card>
</CardGroup>
22 changes: 11 additions & 11 deletions fern/products/realtime-sdk/pages/latest/tech-ref/voice/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,37 +43,37 @@ await client.voice.listen({
## **Classes**

<CardGroup cols={2}>
<Card title="Call" icon="fa-solid fa-phone-volume" href="/docs/realtime-sdk/node/reference/voice/call">
<Card title="Call" icon="fa-solid fa-phone-volume" href="/docs/server-sdk/node/node/reference/voice/call">
Represents an active voice call with methods for playback, recording, speech detection, and call control.
</Card>
<Card title="CallCollect" icon="fa-solid fa-keyboard" href="/docs/realtime-sdk/node/reference/voice/call-collect">
<Card title="CallCollect" icon="fa-solid fa-keyboard" href="/docs/server-sdk/node/node/reference/voice/call-collect">
Represents a collect operation for gathering user input via DTMF or speech during a call.
</Card>
<Card title="CallDetect" icon="fa-solid fa-magnifying-glass" href="/docs/realtime-sdk/node/reference/voice/call-detect">
<Card title="CallDetect" icon="fa-solid fa-magnifying-glass" href="/docs/server-sdk/node/node/reference/voice/call-detect">
Represents a detect operation for identifying answering machines, fax tones, or digits during a call.
</Card>
<Card title="CallPlayback" icon="fa-solid fa-play" href="/docs/realtime-sdk/node/reference/voice/call-playback">
<Card title="CallPlayback" icon="fa-solid fa-play" href="/docs/server-sdk/node/node/reference/voice/call-playback">
Represents a playback operation for playing audio, TTS, silence, or ringtones during a call.
</Card>
<Card title="CallPrompt" icon="fa-solid fa-comment-dots" href="/docs/realtime-sdk/node/reference/voice/call-prompt">
<Card title="CallPrompt" icon="fa-solid fa-comment-dots" href="/docs/server-sdk/node/node/reference/voice/call-prompt">
Represents a prompt operation that combines playback with input collection during a call.
</Card>
<Card title="CallRecording" icon="fa-solid fa-microphone" href="/docs/realtime-sdk/node/reference/voice/call-recording">
<Card title="CallRecording" icon="fa-solid fa-microphone" href="/docs/server-sdk/node/node/reference/voice/call-recording">
Represents a recording operation for capturing audio during a call.
</Card>
<Card title="CallState" icon="fa-solid fa-circle-info" href="/docs/realtime-sdk/node/reference/voice/call-state">
<Card title="CallState" icon="fa-solid fa-circle-info" href="/docs/server-sdk/node/node/reference/voice/call-state">
Represents the state of a call with properties for tracking call progress and status.
</Card>
<Card title="CallTap" icon="fa-solid fa-ear-listen" href="/docs/realtime-sdk/node/reference/voice/call-tap">
<Card title="CallTap" icon="fa-solid fa-ear-listen" href="/docs/server-sdk/node/node/reference/voice/call-tap">
Represents a tap operation for streaming call audio to an external destination.
</Card>
<Card title="Client" icon="fa-solid fa-server" href="/docs/realtime-sdk/node/reference/voice/client">
<Card title="Client" icon="fa-solid fa-server" href="/docs/server-sdk/node/node/reference/voice/client">
The main Voice client for making outbound calls and listening for inbound call events.
</Card>
<Card title="DeviceBuilder" icon="fa-solid fa-wrench" href="/docs/realtime-sdk/node/reference/voice/device-builder">
<Card title="DeviceBuilder" icon="fa-solid fa-wrench" href="/docs/server-sdk/node/node/reference/voice/device-builder">
Helper class for building device configurations when dialing multiple endpoints.
</Card>
<Card title="Playlist" icon="fa-solid fa-list" href="/docs/realtime-sdk/node/reference/voice/playlist">
<Card title="Playlist" icon="fa-solid fa-list" href="/docs/server-sdk/node/node/reference/voice/playlist">
Helper class for building playlists of audio, TTS, silence, and ringtones for playback.
</Card>
</CardGroup>
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,28 @@ Actions in the SignalWire Relay SDK for .NET represent asynchronous operations t
## Available Actions

<CardGroup cols={2}>
<Card title="ConnectAction" href="/docs/realtime-sdk/v2/reference/dotnet/calling/actions/connect">
<Card title="ConnectAction" href="/docs/server-sdk/v2/reference/dotnet/calling/actions/connect">
Connect action for bridging calls
</Card>
<Card title="DetectAction" href="/docs/realtime-sdk/v2/reference/dotnet/calling/actions/detect">
<Card title="DetectAction" href="/docs/server-sdk/v2/reference/dotnet/calling/actions/detect">
Detect action for call detection
</Card>
<Card title="FaxAction" href="/docs/realtime-sdk/v2/reference/dotnet/calling/actions/fax">
<Card title="FaxAction" href="/docs/server-sdk/v2/reference/dotnet/calling/actions/fax">
Fax action for sending faxes
</Card>
<Card title="PlayAction" href="/docs/realtime-sdk/v2/reference/dotnet/calling/actions/play">
<Card title="PlayAction" href="/docs/server-sdk/v2/reference/dotnet/calling/actions/play">
Play action for audio playback
</Card>
<Card title="PromptAction" href="/docs/realtime-sdk/v2/reference/dotnet/calling/actions/prompt">
<Card title="PromptAction" href="/docs/server-sdk/v2/reference/dotnet/calling/actions/prompt">
Prompt action for collecting input
</Card>
<Card title="RecordAction" href="/docs/realtime-sdk/v2/reference/dotnet/calling/actions/record">
<Card title="RecordAction" href="/docs/server-sdk/v2/reference/dotnet/calling/actions/record">
Record action for call recording
</Card>
<Card title="SendDigitsAction" href="/docs/realtime-sdk/v2/reference/dotnet/calling/actions/send-digits">
<Card title="SendDigitsAction" href="/docs/server-sdk/v2/reference/dotnet/calling/actions/send-digits">
Send Digits action for DTMF tones
</Card>
<Card title="TapAction" href="/docs/realtime-sdk/v2/reference/dotnet/calling/actions/tap">
<Card title="TapAction" href="/docs/server-sdk/v2/reference/dotnet/calling/actions/tap">
Tap action for media streaming
</Card>
</CardGroup>
Loading