Unity SDK 接入收藏我的收藏
收藏
我的收藏环境要求
- •支持的引擎版本:Unity 2020 及以上 LTS 版本(例如 2020.3.x, 2021.3.x, ...)
- •支持的编译模式:Mono 或 IL2cpp
- •支持的 C# 语言版本:8.0 及以上(注:Unity 2020 默认使用 C# 8.0)
安装 BGDT 和 SDK
BGDT 是一个字节跳动的游戏开发工具发布平台。开发者可在平台上根据企业/权限下载并使用相关工具。
首次使用直播开放 SDK 之前,需要在 Unity 项目中安装 BGDT 插件。
- 1.安装其中提供的 com.bytedance.bgdt-cp.unitypackage ( BGDT 有自更新功能)
- 2.在 Unity 菜单栏中找到 ByteGame - ByteGame Develop Tools
- 3.选择安装LiveOpenSDK
- 4.注意:
- •若看不到
LiveOpenSDK
,请确认右上角的渠道显示为cp
。若有问题请联系我们。- •若弹出菜单里显示
Apply
,表示这个版本是内部测试版本。如有需要可以申请权限,联系我们通过后点击左上角的Reload
刷新列表即可。- •安装后,你的 Unity 工程下应得到目录:
Packages/com.bytedance.liveopensdk
其中,
SampleGameScene.unity
是附带的测试场景,可以在这里测试 SDK 接入。
SDK 接入
SDK 附带了测试场景与 SDK 能力的示例代码,可以复制一份
com.bytedance.liveopensdk/Samples
放到自己工程的 Assets 目录中,在此基础上进行修改,避免自己的参数、修改内容被后续更新覆盖。
示例代码清单:
文件名 | 说明 | 需要配置的参数 |
SampleGameStartup.cs | 测试场景的逻辑 | 无 |
SampleLiveOpenSdkManager.cs | SDK 本体接入示例 | AppId |
SampleMessagePushManager.cs | 指令直推接入示例 | 无 |
SampleDyCloudManager.cs | 抖音云接入示例 | EnvId、ServiceId、IsDebug、DebugIpAddress |
详细接入步骤和文档请参考对应章节
测试场景的操作方法:
点击“指令直推模式”或“抖音云模式”启动对应技术的指令推送流程。下方日志会显示流程中的信息和收到的指令。也可以查看 Unity 的控制台了解详细日志。
服务器接入抖音云(可选)
若要使用抖音云相关能力,请参考以下文档:
- 1.抖音云产品概述
- 2.弹幕小玩法x抖音云接入指南
兼容 性说明
由于直播开放 SDK 处于快速迭代阶段,部分接口、示例代码和文档会随后续版本更新。为了降低 SDK 版本升级的适配成本,请在接入时遵照下方的兼容性说明操作。
- 1.不建议修改 SDK 包路径中的任何代码,因为这些修改会被后续更新覆盖。
- 2.
Samples
路径下的示例代码仅供参考,可以复制到工程中修改。后续更新不对这部分代码做任何兼容性保证。- 3.
Runtime
路径下的代码为 SDK 的 Unity 引擎集成层,属于 SDK 内部实现的一部分,不对这部分代码做任何兼容性保证。- 4.请在编码时使用
ByteDance.LiveOpenSdk.Api
程序集中的API。- 5.命名空间:
ByteDance.LiveOpenSdk