接收的事件

当您连接到 StreamDock SDK 后，会收到以下几种事件通知：

事件类型	描述
deviceDidConnect	设备已连接
deviceDidDisconnect	设备已断开
read	按键和旋钮操作事件
getFirmVersion	固件版本查询结果

deviceDidConnect

当有新的 StreamDock 设备连接到您的电脑时，会收到此事件。

{
    "event": "deviceDidConnect",
    "path": "设备的唯一标识符",
    "payload": {
        "Path": "设备路径",
        "VendorID": 1234,
        "ProductID": 5678,
        "SerialNumber": "SN123456",
        "Manufacturer": "ManufacturerName",
        "Product": "ProductName",
        "FirmwareVersion": "1.0.0",
        "ReleaseNumber": 1,
        "Type": "N4Pro"
    }
}

事件说明：

event: 事件类型，固定为 "deviceDidConnect"
path: 设备的唯一标识符，后续操作需要使用此路径
payload: 包含设备的详细信息

使用建议：

收到此事件后，可以开始设置设备的背景和按键图标
建议保存设备路径，以便后续操作使用

deviceDidDisconnect

当 StreamDock 设备从电脑断开连接时，会收到此事件。

{
    "event": "deviceDidDisconnect",
    "path": "设备的唯一标识符",
    "payload": {
        "Path": "设备路径",
        "VendorID": 1234,
        "ProductID": 5678,
        "SerialNumber": "SN123456",
        "Manufacturer": "ManufacturerName",
        "Product": "ProductName",
        "FirmwareVersion": "1.0.0",
        "ReleaseNumber": 1,
        "Type": "N4Pro"
    }
}

事件说明：

event: 事件类型，固定为 "deviceDidDisconnect"
path: 断开连接的设备唯一标识符
payload: 包含断开设备的详细信息

使用建议：

收到此事件后，应停止对该设备的操作
可以更新UI状态，提示用户设备已断开

read

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

按键事件

{
    "event": "read",
    "path": "path",
    "payload": {
        "keyId": 5,
        "keyUpOrKeyDown": "keyDown"
    }
}

成员	描述
event	read
path	设备路径（唯一标识）
payload	json

payload 对象包含以下成员：

payload	描述
keyId	按键序号（从1开始）
keyUpOrKeyDown	按键按下(keyDown)或抬起(keyUp)

旋钮旋转事件

{
    "event": "read",
    "path": "path",
    "payload": {
        "knobId": 1,
        "direction": "left"
    }
}

成员	描述
event	read
path	设备路径（唯一标识）
payload	json

payload 对象包含以下成员：

payload	描述
knobId	旋钮序号（从1开始）
direction	旋转方向 ("left" 或 "right")

旋钮按下事件

{
    "event": "read",
    "path": "path",
    "payload": {
        "knobId": 1,
        "state": "pressed"
    }
}

成员	描述
event	read
path	设备路径（唯一标识）
payload	json

payload 对象包含以下成员：

payload	描述
knobId	旋钮序号（从1开始）
state	状态 ("pressed")

滑动事件

{
    "event": "read",
    "path": "path",
    "payload": {
        "direction": "left"
    }
}

成员	描述
event	read
path	设备路径（唯一标识）
payload	json

payload 对象包含以下成员：

payload	描述
direction	滑动方向 ("left", "right")

getFirmVersion

getFirmVersion 的返回值

{
    "event": "getFirmVersion",
    "path": "path",
    "payload": {
        "firmVersion": "firmVersion"
    }
}

成员	描述
event	getFirmVersion
path	设备路径（唯一标识）
payload	json

payload 对象包含以下成员：

payload	描述
firmVersion	设备固件版本号