描述

  • 音乐播放器（mp3player）API接口

接口版本

版本号 制定人 制定日期 版本描述
1.0 谢易成 2020-11-23 初始版本

IP地址

http://192.168.1.1

音乐存放路径

/usr/layout_test.mp3

API列表

名字 描述
set_path 设置播放路径
set_volume 设置播放音量
switch_music 切换歌曲
get_directory 获取目录下的MP3文件
stop 停止播放

1、set_path

请求参数说明

参数名 类型 说明
path string 文件路径信息

调用示例

  1. ubus命令方式：
ubus call mp3player set_path '{"path":"/usr/layout_test.mp3"}'
  1. wapi命令方式：
wapi 8ms '{"ver": "1.0", "module": "mp3player",  "api": "set_path", "param": {"path": "/usr/layout_test.mp3"}}'

返回示例

{
        "path": "\/usr\/layout_test.mp3"
}

返回参数说明

参数名 类型 说明
path string 文件路径信息

错误码

错误码 说明

2、set_volume

请求参数说明

参数名 类型 说明
volume uint32 音量范围0-90

调用示例

  1. ubus命令方式：
ubus call mp3player set_volume '{"volume":10}'
  1. wapi命令方式：
wapi 8ms '{"ver": "1.0", "module": "mp3player",  "api": "set_volume", "param": {"volume": "10"}}'

返回示例

{
        "volume": 10
}

返回参数说明

参数名 类型 说明
volume uint32 音量值

错误码

错误码 说明

3、cutover_music

请求参数说明

参数名 类型 说明
cutover string 选择上一曲”up”或者是下一曲”down”

调用示例

  1. ubus命令方式：
ubus call mp3player switch_music '{"switch":"up"}'
ubus call mp3player switch_music '{"switch":"down"}'
  1. wapi命令方式：
wapi 8ms '{"ver": "1.0", "module": "mp3player",  "api": "switch_music", "param": {"switch": "up"}}'
wapi 8ms '{"ver": "1.0", "module": "mp3player",  "api": "switch_music", "param": {"switch": "down"}}'

返回示例

{
        "switch": "down",
        "index": 1,
        "music": "\/usr\/layout_test2.mp3"
}

返回参数说明

参数名 类型 说明
cutover string 选择上一曲或者是下一曲
index uint32 当前歌曲所在目录位置
music string 当前播放的歌曲路径

错误码

错误码 说明

4、get_directory

请求参数说明

参数名 类型 说明
directory string 需要查询的目录

调用示例

  1. ubus命令方式：
ubus call mp3player get_directory '{"directory":"/usr"}'
  1. wapi命令方式：
wapi 8ms '{"ver": "1.0", "module": "mp3player",  "api": "get_directory", "param": {"directory": "/usr"}}'

返回示例

{
        "directory": "\/usr",
        "num": 2,
        "list"{ "videoplayback.mp3",
                 "201_7.mp3"
              }
}

返回参数说明

参数名 类型 说明
directory string 当前查询的目录
num uint32 查询到的文件总数
list string 查询到的文件名

错误码

错误码 说明

5、stop

请求参数说明

参数名 类型 说明
stop uint32 停止

调用示例

  1. ubus命令方式：
ubus call mp3player stop '{"stop":"stop"}'
  1. wapi命令方式：
wapi 8ms '{"ver": "1.0", "module": "mp3player",  "api": "stop"}'

返回示例

{
   "stop": "ok"
}

返回参数说明

参数名 类型 说明
stop uint32 停止

错误码

错误码 说明
文档更新时间: 2021-04-07 19:53   作者：shuke