Realtime API

You can use the realtime SDK to listen for and react to events from SignalWire's RealTime APIs.

To get started, create a realtime client with createClient and listen for events. For example:

const { createClient } = require('@signalwire/realtime-api')

createClient({
  project: '<project-id>',
  token: '<project-token>'
}).then((client) => {
  client.video.on('room.started', async (roomSession) => {
    console.log("Room started")
  
    roomSession.on('member.joined', async (member) => {
      console.log(member)
    })
  
    await roomSession.subscribe()
  });

  client.connect()
});

Namespaces

• Video

Interfaces

• RealtimeClient

Functions

▸ Const createClient(userOptions): Promise<RealtimeClient>

Creates a real-time Client.

Parameters

Returns

Promise<RealtimeClient>

an instance of a real-time Client.

Example

const client = await createClient({
  project: '<project-id>',
  token: '<project-token>'
})