设置按键自定义功能
1.接口描述
接口说明:设置按键在自定义模式下所绑定的功能。
请求方式:
- 固件版本 V2.6.0 及以上:POST [ip]/mwapi/V2.0/presentation/update-scene-of-button
- 固件版本 V2.5.0 及以下:POST [ip]/mwapi/update-scene-of-button
2.输入参数
参数名称 |
必选 |
类型 |
描述 |
showId |
是 |
Int |
演示稿ID,可通过获取演示稿列表获得 |
sceneOfButton1 |
否 |
Int |
设备按键一指向的画面 ID (可通过获取画面列表获得)或事件 ID,仅在自定义模式下有效 |
sceneOfButton2 |
否 |
Int |
设备按键二指向的画面 ID (可通过获取画面列表获得)或事件 ID,仅在自定义模式下有效 |
sceneOfButton3 |
否 |
Int |
设备按键三指向的画面 ID (可通过获取画面列表获得)或事件 ID,仅在自定义模式下有效 |
sceneOfButton4 |
否 |
Int |
设备按键四指向的画面 ID (可通过获取画面列表获得)或事件 ID,仅在自定义模式下有效 |
sceneOfButton5 |
否 |
Int |
设备按键五指向的画面 ID (可通过获取画面列表获得)或事件 ID,仅在自定义模式下有效 |
事件ID |
定义 |
0 |
禁用 |
-10 |
切到 HDMI 1 |
-11 |
切到 HDMI 2 |
-12 |
切到 WEBCAM |
-13 |
切到无线投屏画面 |
-14 |
切到画中画/切换画中画位置 |
-15 |
切换画中画的源 |
-16 |
切到分屏画面/切换分屏画面位置 |
-17 |
切换分屏画面的源 |
-18 |
交换画中画或分屏画面的源 |
-20 |
切到当前演示稿第一个画面 |
-21 |
切到当前演示稿最后一个画面 |
-22 |
切到当前演示稿下一个画面 |
-23 |
切到当前演示稿上一个画面 |
-30 |
开始录制/停止录制 |
-31 |
拍照 |
-32 |
播放/暂停视频(当前场景) |
-33 |
播放/暂停BGM(当前场景) |
-34 |
启用/取消 FTB |
-35 |
主声道音频的静音或非静音控制 |
-36 |
麦克风的静音或非静音控制 |
-37 |
画面冻结/取消画面冻结 |
-38 |
直播推流启停控制 |
-40 |
第一页文档(当前场景) |
-41 |
最后一页文档(当前场景) |
-42 |
下一页文档(当前场景) |
-43 |
上一页文档(当前场景) |
-50 |
唤醒设备 |
-51 |
设备进入休眠 |
-100 |
启动录制 |
-101 |
停止录制 |
-102 |
启动直播推流 |
-103 |
停止直播推流 |
-104 |
播放当前场景视频 |
-105 |
暂停当前场景视频 |
-106 |
播放BGM |
-107 |
暂停BGM |
-108 |
启用FTB |
-109 |
取消FTB |
-110 |
主声道静音 |
-111 |
主声道取消静音 |
-112 |
麦克风静音 |
-113 |
麦克风取消静音 |
-114 |
冻结画面 |
-115 |
取消冻结画面 |
3.输出参数
参数名称 |
类型 |
描述 |
status |
Int |
状态码 |
message |
String |
状态描述 |
4.示例
将演示稿1的按键一的功能设置为“画面冻结/取消画面冻结”,按键二设置为“启用FTB”。
输入示例
{
"showId": 1,
"sceneOfButton1": -37,
"sceneOfButton3": -108
}
输出示例
{
"message": "success",
"status": 0
}
5.错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 |
定义 |
说明 |
7 |
MW_STATUS_INVALID_ARG |
参数缺失 |
24 |
MW_STATUS_DEVICE_TYPE_ERROR |
非自定义模式 |
39 |
MW_STATUS_MISMATCH |
画面不存在 |