StreamAction | SignalWire

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

1 import { RelayClient } from '@signalwire/sdk';
2 
3 const client = new RelayClient({
4   project: process.env.SIGNALWIRE_PROJECT_ID!,
5   token: process.env.SIGNALWIRE_TOKEN!,
6   contexts: ['default']
7 });
8 
9 client.onCall(async (call) => {
10   await call.answer();
11   const action = await call.stream('wss://example.com/audio-stream', {
12     track: 'inbound',
13   });
14 
15   const event = await action.wait();
16 });
17 
18 await client.run();