抖音开放平台Logo
开发者文档
直播小玩法
控制台
  • 概览
  • Unity SDK 接入
  • 直播能力 Unity SDK 支持
  • 直播间数据
  • 抖音云能力
  • 指令直推能力
  • 履约上报能力
  • 礼物进阶互动效果
  • 用户战绩与排行榜
  • API 概览
  • SDK
  • 观众一键同玩能力
  • 云同步能力
  • 云适配能力
  • 更新日志
  • FAQ

    • SDK 实例对象

    /// <summary>
/// 直播开放 SDK 的实例对象。
/// </summary>
public static ILiveOpenSdk Sdk => LiveOpenSdk.Instance;
    ​

    SDK 版本号

    Sdk.Version
    ​

    SDK 日志输出

    可自定义日志输出
    Sdk.LogSource
    ​

    SDK 环境公参

    // 请在初始化 SDK 之前设置好相关参数
Sdk.Env
    ​

    SDK 线程属性

    回调事件的同步上下文。若希望事件在特定的线程触发，可以设置这个属性。
    Sdk.DefaultSynchronizationContext
    ​

    SDK 初始化

    引擎集成层提供了LiveOpenSdk静态类，通过其Instance属性可以访问小玩法 API 的顶层接口ILiveOpenSdk。
    通过 ILiveOpenSdk.Env 配置好 AppId 属性后，就可以调用Initialize() 初始化 SDK。只有初始化完毕后才能访问其他的服务接口。
    // 同步初始化。
 Sdk.Initialize();
    ​
    Env 当中有另一个重要属性 Token，它用于 SDK 内部请求服务端接口时鉴权。
    正常情况下小玩法的主程序是由直播伴侣或云游戏启动的，SDK 初始化时会自动从命令行参数中获取 Token，设置到这个属性中。
    但是当开发者在 Unity 中调试时，往往是没有 Token 的，此时 SDK 中的大部分功能将不可用。开发者可以先使用直播伴侣启动一个玩法进程（主播是私密账号 + 调试成员，伴侣开播后小玩法面板右上角点击小扳手），获取到 Token 后手动设置到 Env 当中。有关调试体验的问题将在后期优化。
    对抖音云而言，当 IsDebug 为 true 时，SDK 内部会生成一个专用于抖音云的虚假 Token，可以正常连接到抖音云的服务端。
    ​

    SDK 反初始化

    // 反初始化
Sdk.Uninitialize()
    ​

    SDK 内部服务

    获取 SDK 内，各个模块的服务
    Sdk.GetService<T>()
    ​