抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • JavaScript API
  • API 概览
  • 基础
  • 界面
  • 渲染
  • 数据缓存
  • 文件
  • 位置
  • 设备
  • 网络
  • 媒体
  • 图片
  • 音频
  • 录屏
  • 麦克风
  • 实时语音
  • 相机
  • 录音
  • RecorderManager
  • tt.getRecorderManager
  • tt.setInnerAudioOption
  • tt.getInnerAudioOption
  • tt.onAudioRouteChange
  • tt.offAudioRouteChange
  • 视频
  • AI
  • Worker
  • 数据分析
  • 支付
  • 广告
  • 开放能力
  • C# API
  • 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 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    successfunction否
    接口调用成功的回调函数
    4.26.0
    failfunction否
    接口调用失败的回调函数
    4.26.0
    completefunction否
    接口调用结束的回调函数(调用成功、失败都会执行)
    4.26.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    speakerOnboolean

    当前是否扬声器外放

    4.26.0
    routestring

    当前真实物理路由(speakerphone/earpiece/headset/bluetooth/unknown)

    4.26.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errNonumber

    错误码

    4.26.0
    errMsgstring

    错误信息

    4.26.0

    错误码

    errNoerrMsg说明最低支持版本
    21210getInnerAudioOption is not supported on current host version
    当前宿主版本不支持该能力,建议先 canIUse 探测
    4.26.0
    21212get audio option failed
    iOS 查询音频路由失败
    4.26.0
    21214internal error
    4.26.0
    10302The 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); } });