抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 登录
  • 用户信息
  • 广告
  • 营销能力
  • 支付
  • 分享
  • 小程序跳转
  • 抖音视频能力
  • 收货地址
  • 设置
  • 授权
  • 评价能力
  • 数据分析
  • 视频拍摄器
  • 引导关注
  • 订阅消息
  • 电商插件能力(即将废弃)
  • 隐私信息授权
  • web化
  • 转发和挂载
  • 概述
  • 分享
  • 视频发布和挂载
  • 直播挂载
  • LiveOption
  • LiveParam
  • 视频拍摄器
  • tt.showShareMenu
  • tt.hideShareMenu
  • tt.navigateToVideoView
  • 侧边栏能力
  • 直播能力
  • AI/AR能力
  • 安全能力
  • 行业开放
  • 第三方平台
  • 其它
  • 生活服务(即将废弃)
  • LiveParam 是开发者在 Page.onLiveMount 钩子中返回的值,该返回值会作为上传参数,最终传递给发布器。开发者可以根据约定传入部分自定义数据,属性如下:
    属性
    类型
    默认值
    是否必填
    说明
    最低支持版本
    title
    ​
    string
    否
    直播讲解卡标题,不传则默认使用后台配置或当前小程序的名称。注意配置的 title 需要经过小程序的内容安全检测,只有检测通过后的文案才会正常展示,否则展示小程序默认文案
    3.2.0
    path
    string
    否
    挂载路径
    3.2.0
    success
    Function
    否
    直播挂载成功后执行的回调函数
    3.2.0
    fail
    Function
    否
    直播挂载失败或者用户取消挂载后执行的回调函数
    3.2.0
    complete
    Function
    否
    直播挂载完成(无论成功与否)后执行的回调函数
    3.2.0

    直播挂载成功回调

    如果返回的 LiveParam 中有 success 回调函数,那么在直播挂载成功后会触发该成功回调。回调函数为 object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    errMsg
    string
    "liveMount:ok"
    3.2.0

    直播挂载失败回调

    如果返回的 LiveParam 中有 fail 回调函数,那么在直播挂载失败后会触发该失败回调。回调函数为 object 类型,属性如下:
    属性名
    类型
    说明
    最低支持版本
    errNo
    number
    错误码
    3.2.0
    errMsg
    string
    "liveMount:fail" + 详细错误信息
    3.2.0
    ​

    错误说明

    errNo
    errMsg
    说明
    最低支持版本
    10401
    shareAppMessage:fail Internal error server error
    小程序框架异常,请 创建工单 反馈,会有专人协助您解决问题
    3.2.0
    10103
    shareAppMessage:fail network unavailable
    用户网络问题
    3.2.0
    ​
    ​

    直播挂载完成回调

    如果返回的 LiveParam 中有 complete 回调函数,那么无论直播挂载成功与否,都会触发该回调。回调函数携带的参数根据发布情况略有不同:
      1.当直播挂载成功时,与 “直播挂载成功回调” 里的回调参数一致;
      2.当直播挂载失败时,与 “直播挂载失败回调” 里的回调参数一致。