抖音开放平台Logo
开发者文档
控制台

玩法客户端(exe)(原“包体管理能力”)

收藏
我的收藏

能力介绍​

需用开发引擎导出 exe 启动包,上传包体后,主播可在抖音直播伴侣下载对应的玩法启动。​

接入流程​

第一步:选择申请方式

    手动申请
    a.登录开发者平台控制台。​
    b.在「我的应用」页面中点击「直播小玩法」,然后在「直播小玩法」页签中点击已创建的应用。
    c.在应用详情页面左侧导航栏选择「能力」>「平台基础」,在「平台基础」页签的「包体管理」区域中点击「申请开通」。

第二步:玩法客户端(exe)包体的上传​

    1.上传入口:开发-版本管理-包体信息。​
    2.可以分别上传要更新的内容。​
    3.勾选自己要更新的内容,并提交审核(版本(即小魔盒)、包体或两者,如果申请了包体能力的新玩法,首次提交时需要将两者都进行提交)。​
    4.提审确认。​
5. 提交审核后等待平台审核。​

包体文件

    1.包体文件为整个玩法打包的一个压缩文件,格式只支持 zip 格式。​
    2.压缩文件名称必须为 xx_1.0.0.zip,xx 为开发者自定义名称(需为英文字符),1.0.0 为版本号。​
    3.解压后的文件夹名称需与压缩包名称保持一致。
    4.解压后的内容需是玩法的根目录文件夹,而非若干个玩法文件。​
    5.包体文件最大支持 4G。​
正确实例:​
错误示例:​

包体版本号

    1.每次提交只能递增。​
    2.版本号必须和文件名中的版本号一致。​
    3.启动 exe 名称。​
    压缩包解压缩后,启动文件的文件名。​
    启动文件必须在压缩包解压后的根目录。​
    启动文件名只有能由英文或下划线组成,后缀必须为 exe。例如,解压后的文件名为 start_game.exe,则填入 start_game.exe。​
    4.上传完成并审核通过后,如图所示会显示在线上的包体。​
    5.如想要更换线上包体,请上传新的包体。​

玩法接入​

    1.直播伴侣通过启动参数的方式传入token,并启动相应Unity玩法。启动参数格式:-token=xxx。​
    2.开发者获取到 token 之后,需要调用开放平台接口获取直播信息(例如 room_id)。​

调试阶段​

如何本地调试阶段测试 token?

    1.将伴侣升级到 5.1.0 及以上(如果没办法升级则找运营加白伴侣的 did)。​
    2.在伴侣调试环境下输入小玩法的 scheme 地址。​
    3.勾选“同时启动本地玩法的exe”。​
    4.选择本地 exe 的地址。​
    5.点击启动,观察本地的 exe 是否能正常打开。​

接口列表​

API 名称
API 类型
API 描述
Open API
该接口用于获取开放能力接口的调用凭证access_token​
Open API
主播使用直播伴侣启动玩法后,直播伴侣会传入 token 到玩法中,当玩法获取 token 后,传递给玩法的服务端。玩法服务端通过该接口,使用 token 获取直播间信息(该接口需要申请包体管理能力)​

常见问题​

运行基于 electron 开发的包体会报错:gpu_process_host.cc(968)] GPU process launch failed: error_code=18,导致小玩法出现闪退现象。​
加上代码:app.commandLine.appendSwitch('no-sandbox')可解决。​