StreamAction

Returned from call.stream(). Tracks an active audio stream to a WebSocket endpoint. Terminal state: finished.

Inherits all properties and methods from the base Action interface (controlId, isDone, completed, result, wait()).

Properties

No additional properties beyond the base Action interface.

Methods

stop

Stop audio streaming.

Example

import { RelayClient } from '@signalwire/sdk';
const client = new RelayClient({
  project: process.env.SIGNALWIRE_PROJECT_ID!,
  token: process.env.SIGNALWIRE_API_TOKEN!,
  contexts: ['default']
});
client.onCall(async (call) => {
  await call.answer();
  const action = await call.stream('wss://example.com/audio-stream', {
    track: 'inbound',
  });
  const event = await action.wait();
});
await client.run();