v0.1首个正式支持的版本化规范查看版本范围

playback.stop()

停止接受新音频,并按所选模式排空或立即关闭。调用本身只等待状态转换,不等待音频排空。

Syntax

await host.playback.stop(output, mode?);

Parameters

参数 类型 说明
output audio-output handle 要关闭的输出
mode "drain" | "immediate" 默认 drain

drain 立即转为不可写的 draining 状态,再播放完已接受数据;immediate 丢弃缓冲并立即停止。draining 期间再次 drain 是 no-op,传 immediate 则升级为立即终止;已经终止后任一模式都是 no-op。

Return value

无。方法返回表示状态转换完成,不表示 drain 已排空。若应用声明了 playback.ended,终止时可用该事件清理本地状态。

Examples

await host.playback.stop(stream.output, userPressedEmergencyStop ? 'immediate' : 'drain');

Errors

特有错误:stale-handleresource-denied。同一句柄按上述状态机重复停止不报错;转入 draining 后的 write 返回 stale-handle

Requirements

  • 授权:handle-derived,不进入 manifest capability 列表
  • 用户激活:不需要
  • 信任档位:yellow

See also

playback.endedplayback.open()

Host API 版本与分层概览Host API v0.1版本非正式提议提议canvas API呈现canvas.getInfo()方法canvas.draw()方法canvas.present()方法canvas.measureText()方法canvas.frame event事件canvas.resize event事件asset API呈现asset.read()方法asset.loadFont()方法playback API呈现playback.open()方法playback.write()方法playback.stop()方法playback.ready event事件playback.ended event事件input API输入input.focus()方法input.pointer event事件input.key event事件input.wheel event事件input.focusChange event事件ime API输入ime.openSession()方法ime.updateState()方法ime.updateGeometry()方法ime.closeSession()方法ime.textUpdate event事件ime.composition event事件ime.formatUpdate event事件ime.characterBoundsRequest event事件ime.ended event事件capture API输入capture.requestCamera()方法capture.requestMic()方法capture.frame()方法capture.readAudio()方法capture.stop()方法capture.ended event事件store API数据store.get()方法store.put()方法store.delete()方法store.list()方法store.deletePrefix()方法clipboard API数据clipboard.readText()方法clipboard.writeText()方法env API平台集成env.snapshot()方法env.change event事件开始调用 Host API指南构建交互式绘图应用指南构建自绘文本编辑器指南管理媒体采集与播放指南组织本地数据与同步指南