Calling

stop_stream

View as MarkdownOpen in Claude

Stop an audio stream started with stream. By default it stops the most recently started stream; pass a control_id to stop a specific one.

Properties

stop_stream
object

An object that accepts the following properties.

stop_stream.control_id
stringDefaults to The most recently started stream is stopped

The control ID of the stream to stop, as assigned when you started it with stream.

Variables

stream_control_id
string

Read by the method. Control ID of the most recently started stream.

stop_stream_result
success | failed

Set by the method. Whether the stream stopped successfully.

Examples

Stop the last stream

1version: 1.0.0
2sections:
3 main:
4 - stop_stream: {}

Stop a specific stream

1version: 1.0.0
2sections:
3 main:
4 - stop_stream:
5 control_id: my-stream-id