PC 端小游戏接入指南
收藏
我的收藏

接入说明

现阶段 PC 小游戏只支持 Windows 直播伴侣主播使用，旨在帮助开发者降低小游戏发行人直播任务参与门槛，提升小游戏投屏、游玩的体验

•

支持场景：Windows 直播伴侣

•

面向用户：主播

•

接入条件：发布发行人直播任务的小游戏必接

支持范围

•

支持游戏方案：

方案	是否支持
普通小游戏（cocos/laya/egret/原生）	是
Unity WebGL	是
Unity Native	否

•

支持的伴侣版本：>= 8.2.0

适配前提

PC 端小游戏需要代码运行在严格模式才能保障正常运行，因此请将代码使用严格模式进行编译，并且修改因严格模式造成的问题，否则可能造成运行时报错。

通过如下方式，可以打开严格模式：

能力支持情况

目前 PC 小游戏已支持游戏运行过程的必备的渲染能力，但仍有部分开能力无法适配 PC，或者在 PC 上有特殊的表现：

能力	接口	表现
广告	tt.createRewardedVideoAd tt.createBannerAd tt.createInterstitialAd	当遇到需要看广告才能进行的动作时，默认广告自动完成并下发相应的游戏内奖励道具。
支付	tt.requestGamePayment tt.openAwemeCustomerService	支付能力建设中，如果需要进行道具购买等操作，可以先通过抖音手机端启动小游戏进行购买。注：抖音和直播伴侣需要使用同一个账号登录。
订阅	tt.requestSubscribeMessage	订阅该小游戏能力建设中。
收藏	tt.showFavoriteGuide tt.onFavoriteStateChange tt.showRevisitGuide	收藏该小游戏能力建设中。
录屏	tt.getGameRecorderManager	暂不支持小游戏内的录屏和录屏分享功能。
分享	tt.shareAppMessage tt.showShareMenu	暂不支持小游戏分享、转发功能。
群聊	tt.checkGroupInfo tt.joinGroup	暂不支持从小游戏内拉起群聊功能。
日历	tt.addPhoneCalendar	暂不支持从小游戏内拉起日历、设置日历等功能。
扫码	tt.scanCode	暂不支持小游戏内扫码能力。
侧边栏	tt.navigateToScene tt.checkScene	PC端不支持跳转侧边栏能力。
震动	tt.vibrateShort tt.vibrateLong	PC端不支持震动体验。
陀螺仪	tt.startGyroscope tt.stopGyroscope tt.onGyroscopeChange tt.offGyroscopeChange	PC端不支持陀螺仪能力。
罗盘	tt.startCompass tt.stopCompass tt.onCompassChange tt.offCompassChange	PC端不支持罗盘能力。
麦克风	tt.requestMicrophone tt.pauseMicrophone tt.resumeMicrophone	PC端不支持语音输入等操作。
相机	tt.createCamera	PC端不支持相机能力。
人脸检测	tt.createFaceDetector	PC端不支持人脸识别等操作。
手势识别	tt.createHandDetector	PC端不支持手势识别等操作。

问题排查

如果游戏在 PC 调试发现无法正常运行，可以根据下面的能力说明进行自测和适配。

环境判断

可以通过 tt.getSystemInfoSync 的返回值 platform 判断是否 PC 环境，目前直播伴侣上 platform 返回值为 windows。

// getSystemInfoSync 返回值需要注意的字段
{
    appName: "Douyin", // 直播伴侣抖音开播时 appName 为 Douyin
    brand: "windows",
    system: "Windows 10 Pro",
    platform: "windows"
}

Socket

tt.connectSocket PC 版本按 WebSocket 标准实现，对比移动端需要注意：

如果入参 protocols 传了子协议数组，那么服务端应该返回Sec-WebSocket-Protocol ，且取值与游戏发起连接时传的 protocol 取值一致，否则客户端会直接关闭连接。

Video

PC 小游戏使用 createVideo/createOffscreenVideo 接口时需要注意：Video 只支持 canvas2d context，不支持 paintTo WebGL context。

键盘事件

抖音小游戏暂时不支持 keyDown/keyUp 键盘事件，如果游戏有用到这两个接口，需要前置判断一下平台，或者判断接口是否存在。

if (tt.keyDown) {} else {
    // 不支持时使用 touch 事件替代
}

音频

浏览器针对mp3、mp4资源文件的请求默认会在 header 中带上accept-encoding=identity;q=1, *;q=0，服务器响应需要做好适配。

建议在 IDE 或者利用直播伴侣调试验证游戏运行正常后上线。

录屏/录音

当前不支持录屏/录音能力，相应的API可正常调用，但不会生成正常的录制文件，如影响游戏运行，请做好环境判断和兼容处理

其他能力

游戏转发分享、收藏、群聊、侧边栏、支付、以及强依赖移动端设备的能力，如罗盘、加速度计、相机、麦克风等能力目前均不支持。

此类能力在进行调用时会出现相应的提示——“能力暂不支持”，理论上不影响游戏的正常游玩，如出现特殊情况请做针对性处理。

调试方式

添加开播测试账号

•

打开「开发设置」-「测试管理」页面，扫码添加开播测试账号。

•

每款游戏最多添加3个测试成员，添加后该账号可获得直播伴侣开播权限及豁免游戏挂载门槛。

•

账号如涉及安全违规，将被取消以上权限，并减少一个测试账号名额。

IDE 生成游戏链接

打开抖音开发者工具，预览-扫码预览-复制链接，得到该游戏的链接；

如果扫码预览没有复制链接按钮，请升级开发者工具版本至最新版；

直播伴侣调试

建议在直播伴侣调试前先保证在 IDE 上能够正常运行。

打开 Windows 直播伴侣，进入「游戏玩法」页面，点击右上角小扳手打开调试面板，选择小游戏并粘贴第 2 步生成的 schema 打开小游戏进行调试；

注意

•

小游戏支持开播前调试和开播后调试，如果选择开播后调试，为防止封禁，开播测试过程中开发者需露脸直播，且始终保证直播间有声音，不允许挂机/完全黑屏。

•

直播伴侣下载链接：https://streamingtool.douyin.com/。

•

配置开播测试账号权限【只有开通权限,才能看到小扳手图标】。

•

开播账号必须是私密账号，设置路径：抖音-设置-隐私设置-私密账号。

PC 端小游戏接入指南收藏我的收藏

​接入说明​

​支持范围​

​适配前提​

​能力支持情况​

​问题排查​

​环境判断​

​Socket​

​Video​

​键盘事件​

​音频​

​录屏/录音​

​广告​

​其他能力​

​调试方式​

​添加开播测试账号​

​IDE 生成游戏链接​

​直播伴侣调试​