抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • API 概览
  • C# API
  • 开放接口
  • 登录
  • 侧边栏能力
  • 设置
  • 授权
  • 添加到桌面
  • 游戏排行榜
  • 订阅消息
  • 开放数据域
  • 开放数据
  • 开放数据分组
  • 客服消息
  • 直播能力
  • tt.getLiveManager
  • LiveManager
  • LiveManager.getLiveStatus
  • LiveManager.checkRoomIsValid
  • LiveManager.navigateToLive
  • LiveManager.onXScreenSizeChange
  • LiveManager.offXScreenSizeChange
  • 推荐流直出游戏能力
  • 公会群能力
  • 意见反馈
  • 游戏站
  • 收藏
  • 群聊
  • 关注
  • 数据分析
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 转发
  • 数据缓存
  • 广告
  • 界面
  • 支付
  • Worker
  • LiveManager.getLiveSetting
    收藏
    我的收藏

    基础库 3.85.0 开始支持本方法,这是一个异步方法。

    获取直播环境配置信息。

    前提条件
    业务背景
    使用限制
    注意事项
    相关教程

    语法

    LiveManager.getLiveSetting(options)

    参数说明

    options 为 object 类型,属性如下:

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

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "LiveManager.getLiveSetting:ok"
    3.85.0
    isVideoLiveboolean
    当前是否为直播场景
    3.85.0
    isAnchorboolean
    当前玩家身份是否是主播
    3.85.0
    instantPlayboolean
    是否开通即看即玩能力并且主播端开关已打开
    3.85.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "LiveManager.getLiveSetting:fail" + 详细错误信息
    3.85.0

    代码示例

    const liveManager = tt.getLiveManager(); liveManager.getLiveSetting({ success: (res) => { console.log('success', res); }, fail: (res) => { console.log('fail', res); } })