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