抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台

直播间即看即玩能力技术指南
收藏
我的收藏

能力说明

当前能力以白名单方式开放接入,接入前请联系平台运营或发起oncall申请
为开发者提供直播间观众即看即玩主播在玩场景的开放能力,提升用户体验与留存、助力主播内容经营
    观众看播体验更丝滑:直播间观众点击讲解卡进入小游戏后,能直接体验到主播在玩场景/关卡;
    丰富主播直播内容:基于即看即玩能力,主播可口播呼吁观众进入游戏体验同场景,助力直播内容脚本编排;
    丰富游戏体验:厂商可基于此能力,尝试拓展观众进入主播同区服观众进变现转化高的场景游玩等游戏交互体验。

技术接入方案

参考流程图

主播侧链路

    1.小游戏需要在主播侧进入支持即玩的场景时,通过tt.reportScene上报场景值,自定义标识即玩场景;
    2.在小游戏进入即玩场景后,调用LiveManager.uploadGameProgress上报即玩的场景进度到观众端。
    3.当主播离开了即玩场景后,至少需要调用一次LiveManager.uploadGameProgress上报data=""来通知到观众端;
    4.即玩能力只有在移动端视频开播或伴侣挂载启动游戏开播的情况下才能使用,其他场景调用会报错,可通过tt.getLiveSetting中返回的isVideoLive=true来识别。

观众侧链路

    1.小游戏需要在观众侧进入支持即玩的场景时,通过tt.reportScene上报场景值
    2.主播打开即玩开关的情况下,在一次小游戏启动周期内,data的值不会发生变化,只有重新进入游戏才会刷新;
    3.即玩能力只有在主播是移动端视频开播或伴侣挂载启动游戏开播的情况下才能使用,其他场景调用会报错,可通过tt.getLiveSetting中返回的isVideoLive=true来识别。

关键API

能力
是否必接
JSAPI
Unity C# API
获取直播管理对象
获取直播场景下配置
LiveManager.getLiveSetting
上传主播游玩进度
LiveManager.uploadGameProgress
观众侧同步主播游戏进度
LiveManager.syncGameProgress
上报场景数据
TT.ReportScene
监听即看即玩开关状态变化
LiveManager.onInstantPlayStatusChange
取消监听即玩开关状态变化
LiveManager.offInstantPlayStatusChange

测试流程

步骤
图示
开通平台能力
使用抖音测试账号扫码登录开发者工具。登录账号要求已加入当前游戏的应用测试设备
在开发者工具上方选择添加编译模式,【进入场景】指定场景值 023009 或 023010,分别表示主播侧启动和观众侧启动游戏
在移动端使用抖音账号开启直播间,并挂载启动当前游戏
在开发者工具中运行游戏,并测试结果
const liveManager = tt.getLiveManager(); liveManager.getLiveSetting({ success: (res) => { const { instantPlay, isAnchor } = res; // 主播端上传游玩进度 if (instantPlay && isAnchor) { LiveManager.uploadGameProgress({ data: '关卡信息' }); }; // 观众端同步主播游玩进度 if (instantPlay && !isAnchor) { LiveManager.syncGameProgress({ success: (result) => { console.log('获取主播进度', result.data) } }); } }, })