tt.getInnerAudioOption
基础库 4.26.0 开始支持本方法,这是一个异步方法。
查询小游戏当前音频播放路由状态,包括是否外放及当前音频路由。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 当前不支持 Android,调用会返回 999988 / The feature is not available in current operating system。 该能力不要与 RTC 路由能力混用;RTC 房间内如需切换扬声器/听筒,请使用 RtcRoomContext.setAudioPlaybackDevice。 |
| 注意事项 | 无 |
| 相关教程 | 无 |
语法
tt.getInnerAudioOption(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 | 4.26.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 4.26.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 4.26.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最 低支持版本 |
|---|---|---|---|
| speakerOn | boolean | 当前是否扬声器外放 | 4.26.0 |
| route | string | 当前真实物理路由(speakerphone/earpiece/headset/bluetooth/unknown) | 4.26.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errNo | number | 错误码 | 4.26.0 |
| errMsg | string | 错误信息 | 4.26.0 |
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 21210 | getInnerAudioOption is not supported on current host version | 当前宿主版本不支持该能力,建议先 canIUse 探测 | 4.26.0 |
| 21212 | get audio option failed | iOS 查询音频路由失败 | 4.26.0 |
| 21214 | internal error | 4.26.0 | |
| 10302 | The feature is not available in current operating system | Android 当前操作系统不支持 getInnerAudioOption | 4.26.0 |
代码示例
tt.getInnerAudioOption({ success(res) { console.log(res.speakerOn, res.route); }, fail(err) { console.log("getInnerAudioOption fail", err); } });
