playback.stop()
关闭输出并使句柄失效。调用是幂等的。
Syntax
await host.playback.stop(output, mode?);Parameters
| 参数 | 类型 | 说明 |
|---|---|---|
output |
audio-output handle | 要关闭的输出 |
mode |
`“drain” | “immediate”` |
drain 播放完已接受数据；immediate 丢弃缓冲并尽快停止设备。
Return value
无。收到 playback.ended 后可确认最终终止原因。
Examples
await host.playback.stop(stream.output, userPressedEmergencyStop ? 'immediate' : 'drain');Errors
错误类型或其他应用的句柄返回 stale-handle/resource-denied。同一句柄重复停止不报错。
Requirements
- 能力：
host:playback.stop - 用户激活：不需要
- 信任档位：yellow