CreatorCreator
首页
快速上手
  • 中文简体
  • English
首页
快速上手
  • 中文简体
  • English
  • Creator

    • 快速上手
  • Stream Dock

    • 插件SDK
    • 图标包

      • 概述
      • 术语
      • 创建图标包
      • 图标规格
    • 场景配置

      • 什么是场景配置?
      • 导出
      • 使用案例
  • mPanel

    • 插件SDK
  • Linux StreamDock SDK

    • Cpp SDK

      • 概述
      • 依赖安装
      • 设备管理器
      • StreamDock 基类
      • StreamDock293
      • 通信传输
      • 示例
      • 源代码
    • Python SDK

      • 概述
      • 依赖安装
      • 设备管理器
      • StreamDock 基类
      • StreamDock293
      • 示例
      • 源代码
  • Windows StreamDock SDK

    • WebSocket SDK

      • 概述
      • 快速上手
      • 发送的事件
      • 接收的事件
    • Cpp SDK

      • 概述
      • 依赖安装
      • 设备管理器
      • StreamDock 基类
      • StreamDock293
      • 通信传输
      • 示例
      • 源代码
  • 支持

    • 帮助和错误报告

接收的事件

WebSocket连接后可从SDK收到一些事件:

Event描述
deviceDidConnect设备连接
deviceDidDisconnect设备断开连接
read按键事件和旋钮事件(发送read事件后才会开启读取)
getFirmVersion getFirmVersion 的返回值

deviceDidConnect

设备连接后触发的事件

{
    "event": "deviceDidConnect",
    "path": "XFw/XEhJRCNWSURfNjYwMiZQSURfMTAwMSZNSV8wMCM4JjE0NTM2YWViJjAmMDAwMCN7NGQxZTU1YjItZjE2Zi0xMWNmLTg4Y2ItMDAxMTExMDAwMDMwfQ==",
    "payload": null
}
成员描述
eventdeviceDidConnect
path设备路径(唯一标识)
payloadnull

deviceDidDisconnect

设备断开连接后触发的事件

{
    "event": "deviceDidDisconnect",
    "path": "XFw/XEhJRCNWSURfNjYwMiZQSURfMTAwMSZNSV8wMCM4JjE0NTM2YWViJjAmMDAwMCN7NGQxZTU1YjItZjE2Zi0xMWNmLTg4Y2ItMDAxMTExMDAwMDMwfQ==",
    "payload": null
}
成员描述
eventdeviceDidDisconnect
path设备路径(唯一标识)
payloadnull

read

按键事件和旋钮事件(发送read事件后才会开启读取)

按键事件

{
    "event": "read",
    "path": "XFw/XEhJRCNWSURfNTUwMCZQSURfMTAwMSM2JjY5M2Y3ZWUmMiYwMDAwI3s0ZDFlNTViMi1mMTZmLTExY2YtODhjYi0wMDExMTEwMDAwMzB9",
    "payload": {
        "key": 5,
        "keyUpOrKeyDown": "keyDown"
    }
}
成员描述
eventread
path设备路径(唯一标识)
payloadjson

payload 对象包含以下成员:

payload描述
key要按键序号(从1开始)
keyUpOrKeyDown按键按下或抬起

旋钮事件

旋钮旋转消息(dialRotate为-1表示逆时针旋转,1表示顺时针旋转):
{
    "event": "read",
    "path": "XFw/XEhJRCNWSURfNjYwMyZQSURfMTAwMiZNSV8wMCM3JjMyZGZjYmIxJjAmMDAwMCN7NGQxZTU1YjItZjE2Zi0xMWNmLTg4Y2ItMDAxMTExMDAwMDMwfQ==",
    "payload": {
        "dialRotate": -1,
        "key": 1
    }
}

旋钮按下抬起消息:
{
    "event": "read",
    "path": "XFw/XEhJRCNWSURfNjYwMyZQSURfMTAwMiZNSV8wMCM3JjMyZGZjYmIxJjAmMDAwMCN7NGQxZTU1YjItZjE2Zi0xMWNmLTg4Y2ItMDAxMTExMDAwMDMwfQ==",
    "payload": {
        "dialDownOrUp": "dialDown",
        "key": 1
    }
}
成员描述
eventread
path设备路径(唯一标识)
payloadjson

payload 对象包含以下成员:

payload描述
key要按键序号(从1开始)
dialRotate旋钮旋转(-1表示逆时针旋转,1表示顺时针旋转)
dialDownOrUp旋钮按下或抬起

背景图设置成功后触发的事件:

{
    "event": "read",
    "path": "XFw/XEhJRCNWSURfNTUwMCZQSURfMTAwMSM2JjM4NjJkMmM2JjEmMDAwMCN7NGQxZTU1YjItZjE2Zi0xMWNmLTg4Y2ItMDAxMTExMDAwMDMwfQ==",
    "payload": {
        "setBackgroundImg": "ok"
    }
}
成员描述
eventread
path设备路径(唯一标识)
payloadjson

payload 对象包含以下成员:

payload描述
setBackgroundImg字符串"ok"

getFirmVersion

getFirmVersion 的返回值

{
    "event": "getFirmVersion",
    "path": "XFw/XEhJRCNWSURfNTUwMCZQSURfMTAwMSM2JjY5M2Y3ZWUmMiYwMDAwI3s0ZDFlNTViMi1mMTZmLTExY2YtODhjYi0wMDExMTEwMDAwMzB9",
    "payload": {
        "firmVersion": "AVYyLjI5M1YyLjAwLjAwMc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3N"
    }
}
成员描述
eventgetFirmVersion
path设备路径(唯一标识)
payloadjson

payload 对象包含以下成员:

payload描述
firmVersion设备固件版本号(base64编码)
Last Updated:
Contributors: Heart
Prev
发送的事件