POST v1/CtrlMachine/SetBackgroundMusic?num={num}
控制背景音乐设备
请求信息
URI参数
| 字段名称 | 描述 | 类型 | 约束 |
|---|---|---|---|
| num |
中控机机身号 |
string |
必须 |
Body参数
CMBackgroundMusicSetting 实体
CMBackgroundMusicSetting| 字段名称 | 描述 | 类型 | 约束 |
|---|---|---|---|
| musicCtrl |
控制音乐 可为null |
MusicCtrl |
枚举定义的值 |
| volume |
音量调节 可为null |
integer |
范围 [0, 100] |
| switchMode |
切换模式 可为null |
MusicSwitchMode |
枚举定义的值 |
| id |
中控机的设备id |
string |
必填 |
| timeout |
超时的秒数 如果在Timeout秒之后才收到数据则不处理 |
integer |
范围 [1, 30] |
请求格式
application/json, text/json
例子:
{
"musicCtrl": 1,
"volume": 1,
"switchMode": 1,
"id": "sample string 1",
"timeout": 2
}
application/x-www-form-urlencoded
例子:
musicCtrl=控制音乐
可为null&volume=音量调节
可为null&switchMode=切换模式
可为null&id=中控机的设备id&timeout=0
响应信息
返回类型
ApiResultOfBoolean| 字段名称 | 描述 | 类型 | 约束 |
|---|---|---|---|
| code |
错误码 |
ErrorCode |
必填 |
| msg |
相关提示信息 |
string |
必填 |
| data |
业务数据 |
boolean |
必填 |
响应格式
application/json, text/json
例子:
{
"code": 0,
"msg": "sample string 1",
"data": true
}
接口调试
Authorization
AppId
Token
URI
POST
请求header
请求body
响应body