指令直推能力
收藏我的收藏
收藏
使用指令直推不需要在 SDK 当中进行额外的配置，只需要保证直播间信息获取完成，监听对应的事件，然后开启推送任务即可。
当前的连接状态
Sdk.GetMessagePushService().ConnectionState
参数类型：
枚举类型 | 枚举值 | 说明 |
ConnectionState | Disconnected = 0 | 未连接 |
| Connected = 1 | 已连接 |
连接状态事件监听
Sdk.GetMessagePushService().OnConnectionStateChanged += OnConnectionStateChanged; private static void OnConnectionStateChanged(ConnectionState state) { Log.Info($"指令推送网络连接状态：{state}"); }
监听事件状态
事件状态类 | 说明 |
ConnectionState | 参考当前的连接状态参数类型 |
消息事件监听
// 注册事件监听 Sdk.GetMessagePushService().OnMessage += OnMessage; private static void OnMessage(IPushMessage message) { Log.Info($"收到推送消息：{message.MsgId} {message.MsgType}"); }
监听事件状态
事件状态类 | 字段 | 说明 |
IPushMessage | string MsgId | 消息 ID |
| string MsgType | 推送消息的类型 |
| long Timestamp | 消息的 UNIX 时间戳，单位是毫秒 |
启动指令推送
// 开启推送任务，开启成功后才能收到指定类型的消息 // 每场对局结束后建议停止推送任务 await Sdk.GetMessagePushService().StartPushTaskAsync(msgType, pushType);
调用参数：
参数 | 参数说明 | 支持版本 |
string msgType | 要启动推送的消息类型的字符串，参考 PushMessageTypes | 2.0.0（含）以上 |
MultiPushType pushType | 指令推送模式，默认为原生SDK单推模式 SinglePush。 | 2.7.4（含）以上 |
PushMessageTypes 类型
值(需要注意大小写) | 取值说明 | 支持版本 |
live_gift | 送礼数据 | 2.0.0（含）以上 |
live_comment | 评论数据 | 2.0.0（含）以上 |
live_like | 点赞数据 | 2.0.0（含）以上 |
live_fansclub | 粉丝团数据 | 2.0.0（含）以上 |
MultiPushType 类型
枚举类型 | 枚举值 | 说明 | 支持版本 |
MultiPushType | SinglePush = 1 | SDK 单推模式，消息仅推送至SDK。 | 2.7.4（含）以上 |
| HTTPWithSDK = 2 | HTTP 和 SDK 双推模式，消息会同时推送到游戏服务器和 SDK。 说明 开发者后台配置 HTTPS 回调数据配置（配置路径：玩法后台 -> 【开发】 -> 【开发配置】 -> 【直播间互动数据配置】） | 2.7.4（含）以上 |
| DyCloudWithSDK = 3 | 抖音云 和 SDK 双推模式，消息会同时推送到游戏抖音云和 SDK。 说明 开发者后台配置 抖音云 回调数据配置（配置路径：玩法后台 -> 【开发】 -> 【开发配置】 -> 【直播间互动数据配置】） | 2.7.4（含）以上 |
返回说明：
无
停止指令推送
// 停止服务端的推送任务，停止向本地推送指定类型的消息。<br/> // 在玩法处于不需要处理互动指令的状态时，请调用此方法。 // 停止推送任务后不保证 <see cref="OnMessage"/> 一定不会触发，因此请在不需要处理指令时取消事件订阅。 await Sdk.GetMessagePushService().StopPushTaskAsync(msgType);
调用参数：
参数 | 参数说明 | 支持版本 |
string msgType | 要停止推送的消息类型的字符串，参考 PushMessageTypes | 2.0.0 |
PushMessageTypes 类型
值(需要注意大小写) | 取值说明 | 支持版本 |
live_gift | 送礼数据 | 2.0.0 |
live_comment | 评论数据 | 2.0.0 |
live_like | 点赞数据 | 2.0.0 |
live_fansclub | 粉丝团数据 | 2.0.0 |
返回说明：
无
指令直推方案流程
初始化 SDK ： ILiveOpenSdk.Initialize()
初始化直播间信息 ：IRoomInfoService.WaitForRoomInfoAsync()
注册事件监听 ：IMessagePushService.OnMessage
启动指令推送 ： IMessagePushService.StartPushTaskAsync()
开始一场对局
收到消息并成功渲染后上报履约 ： IMessageAckService.ReportAck()
结束一场对局
停止指令推送 ： IMessagePushService.StopPushTaskAsync()
游戏退出或 Unity 停止预览时销毁 SDK，释放资源 ： ILiveOpenSdk.Uninitialize()
开发调试
当前指令直推的开发调试，需要
- 1.准备好你的 appid+token（直播伴侣挂载你的玩法可获得 token）；
- 2.用 appid + token 去开启指令直推能力，礼物、评论、点赞等；
- 3.移动端加入该直播间发送对应指令，可以在本地调试环境中收到对应消息
【开发-》自查工具-》OpenAPI 自测工具】在开发中，后期也可在这里测试
