stop

View as MarkdownOpen in Claude

Stop playback immediately.

Returns

Promise<Record<string, unknown>> — Server acknowledgment.

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.play([{ type: 'tts', text: 'Hello!' }]);
// Stop playback early
await action.stop();
});
await client.run();