Realtime Client

A real-time Client. To construct an instance of this class, please use createClient.

Example usage:

1
import { createClient } from "@signalwire/realtime-api";
2
3
// Obtain a client:
4
const client = await createClient({ project, token });
5
6
// Listen on events:
7
client.video.on("room.started", async (room) => {});
8
9
// Connect:
10
await client.connect();

Properties

Methods

connect

• connect(): Promise<RealtimeClient>

Connects this client to the SignalWire network.

As a general best practice, it is suggested to connect the event listeners before connecting the client, so that no events are lost.

Returns

Promise<RealtimeClient>

Upon connection, asynchronously returns an instance of this same object.

Example

1
const client = await createClient({ project, token });
2
client.video.on("room.started", async (roomSession) => {}); // connect events
3
await client.connect();

disconnect

• disconnect(): void

Disconnects this client from the SignalWire network.

Returns

void

off

• off(event, fn?)

Remove an event handler.

Parameters

on

• on(event, fn)

Attaches an event handler to the specified event.

Parameters

once

• once(event, fn)

Attaches an event handler to the specified event. The handler will fire only once.

Parameters

removeAllListeners

• removeAllListeners(event?)

Detaches all event listeners for the specified event.

Parameters