获取背景音乐播放状态
1.接口描述
接口说明:获取背景音乐播放状态。
请求方式:
- 固件版本 V2.6.0 及以上:POST [ip]/mwapi/V2.0/bgm/get-bgm-status
- 固件版本 V2.5.0 及以下:POST [ip]/mwapi/get-bgm-status
管理员权限 | 登录认证 |
---|---|
否 | 是 |
2.输入参数
无
3.输出参数
参数名称 | 类型 | 描述 |
---|---|---|
result | Int | 状态码 |
message | String | 状态描述 |
info | InfoData | 背景音乐信息 |
InfoData
参数名称 | 类型 | 描述 |
---|---|---|
musicStatus | MusicStatusInfo | 背景音乐状态 |
MusicStatusInfo
参数名称 | 类型 | 描述 |
---|---|---|
Status | Int | 播放状态 0:暂停; 1:播放 |
progress | Int | 播放进度,范围为0~1000000 |
policy | Int | 播放策略 1:顺序播放 2:随机播放 3:单曲循环 4:整体循环 |
duration | Int | 时长,毫秒 |
currentMusicId | Int | 当前背景音乐的资源ID,音频文件在设备中的唯一身份标识。 |
4.示例
获取背景音乐播放状态。
输入示例
None
输出示例
{
"info": {
"musicStatus": {
"currentMusicId": 2006,
"duration": 217000,
"policy": 2,
"progress": 500000,
"status": 0
}
},
"message": "success",
"result": 0
}
5.错误码
无接口业务逻辑相关的错误码,其他错误码详见 公共错误码。