描述
接口版本
版本号 |
制定人 |
制定日期 |
版本描述 |
1.0 |
谢易成 |
2020-11-23 |
初始版本 |
IP地址
http:
视频存放路径
/usr/videoplayback.mp4
API列表
名字 |
描述 |
set_path |
设置播放路径 |
set_volume |
设置播放音量 |
cutover_video |
切换视频 |
set_position |
设置视频窗口位置 |
set_size |
设置视频窗口大小 |
get_directory |
获取目录下的MP4文件 |
set_status |
设置播放状态 |
get_videotime |
获取视频的总时长/当前播放进度 |
set_seek |
设置前进后退的进度/播放进度 |
- 注:设置视频播放时需把背景颜色设定为8080(十六进制)。
1、set_path
请求参数说明
参数名 |
类型 |
说明 |
path |
string |
文件路径信息 |
调用示例
- ubus命令方式:
ubus call airplayer set_path '{"path":"/usr/videoplayback.mp4"}'
- wapi命令方式:
wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_path", "param": {"path": "/usr/layout_test.mp3"}}'
返回示例
{
"path": "\/usr\/videoplayback.mp4"
}
返回参数说明
参数名 |
类型 |
说明 |
path |
string |
文件路径信息 |
错误码
2、set_volume
请求参数说明
参数名 |
类型 |
说明 |
volume |
uint32 |
音量范围0-90 |
调用示例
- ubus命令方式:
ubus call airplayer set_volume '{"volume":10}'
- wapi命令方式:
wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_volume", "param": {"volume": "10"}}'
返回示例
{
"volume": 10
}
返回参数说明
参数名 |
类型 |
说明 |
volume |
uint32 |
音量值 |
错误码
3、cutover_video
请求参数说明
参数名 |
类型 |
说明 |
cutover |
tsring |
选择上一曲”up”或者是下一曲”down” |
调用示例
- ubus命令方式:
ubus call airplayer cutover_video '{"cutover":"up"}'
ubus call airplayer cutover_video '{"cutover":"down"}'
- wapi命令方式:
wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "cutover_video", "param": {"cutover_video": "up"}}'
wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "cutover_video", "param": {"cutover_video": "down"}}'
返回示例
{
"cutover": "down",
"index": 1,
"video": "\/usr\/videoplayback.mp4"
}
返回参数说明
参数名 |
类型 |
说明 |
cutover |
string |
选择上一曲或者是下一曲 |
index |
uint32 |
当前视频所在目录位置 |
video |
string |
当前播放的视频路径 |
错误码
4、set_position
请求参数说明
参数名 |
类型 |
说明 |
position_x |
uint32 |
播放器位置的x坐标 |
position_y |
uint32 |
播放器位置的x坐标 |
调用示例
- ubus命令方式:
ubus call airplayer set_position '{"position_x":0,"position_y":0}'
- wapi命令方式:
wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_position", "param": {"position_x":0,"position_y":0}}'
返回示例
{
"position_x": 0,
"position_y": 0
}
返回参数说明
参数名 |
类型 |
说明 |
position_x |
uint32 |
播放器位置的x坐标 |
position_y |
uint32 |
播放器位置的x坐标 |
错误码
5、set_size
请求参数说明
参数名 |
类型 |
说明 |
size_width |
uint32 |
播放器的宽度 |
size_height |
uint32 |
播放器的高度 |
调用示例
- ubus命令方式:
ubus call airplayer set_size '{"size_width":600,"size_height":400}'
- wapi命令方式:
wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_size", "param": {"size_width":600,"size_height":400}}'
返回示例
{
"size_width": 600,
"size_height": 400
}
返回参数说明
参数名 |
类型 |
说明 |
size_width |
uint32 |
播放器的宽度 |
size_height |
uint32 |
播放器的高度 |
错误码
6、set_status
请求参数说明
参数名 |
类型 |
说明 |
status |
uint32 |
设置播放状态 |
调用示例
- ubus命令方式:
停止播放:ubus call airplayer set_status '{"status":"stop"}'
暂停播放:ubus call airplayer set_status '{"status":"pause"}'
恢复播放:ubus call airplayer set_status '{"status":"continue"}'
播放模式切换(单曲循环、列表循环、不循环):ubus call airplayer set_status '{"status":"mode"}'
- wapi命令方式:
停止播放:wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_status", "param": {"status":"stop"}}'
暂停播放:wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_status", "param": {"status":"pause"}}'
恢复播放:wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_status", "param": {"status":"continue"}}'
播放模式切换(单曲循环、列表循环、不循环):wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_status", "param": {"status":"mode"}}'
返回示例
{
"status": "stop"
}
返回参数说明
参数名 |
类型 |
说明 |
status |
string |
播放状态/模式 |
错误码
7、set_seek
请求参数说明
参数名 |
类型 |
说明 |
seek |
uint32 |
设置前进、后退时间/播放进度 |
seek_direction |
uint32 |
0:后退;1:前进;2:直接设置播放进度 |
调用示例
- ubus命令方式:
前进:ubus call airplayer set_seek '{"seek":10,"seek_direction":1}'
后退:ubus call airplayer set_seek '{"seek":10,"seek_direction":0}'
直接设置播放进度:ubus call airplayer set_seek '{"seek":0,"seek_direction":2}'
- wapi命令方式:
前进:wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_seek", "param": {"seek":10,"seek_direction":1}}'
后退:wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_seek", "param": {"seek":10,"seek_direction":0}}'
直接设置播放进度:wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "set_seek", "param": {"seek":0,"seek_direction":2}}'
返回示例
{
"seek": -10,
"direction": 0
}
返回参数说明
参数名 |
类型 |
说明 |
seek |
uint32 |
前进、后退时间/播放进度 |
direction |
uint32 |
0:后退;1:前进;2:直接设置播放进度 |
错误码
8、get_videotime
请求参数说明
参数名 |
类型 |
说明 |
videotime |
uint32 |
获取视频的总时间/当前播放进度 |
调用示例
- ubus命令方式:
获取视频的总时间:ubus call airplayer get_videotime '{"videotime":"duration"}'
获取当前播放进度:ubus call airplayer get_videotime '{"videotime":"current"}'
- wapi命令方式:
获取视频的总时间:wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "get_videotime", "param": {"videotime":"duration"}}'
获取当前播放进度:wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "get_videotime", "param": {"videotime":"current"}}'
返回示例
{
"videotime": "duration",
"duration time": 60.027000
}
返回参数说明
参数名 |
类型 |
说明 |
videotime |
uint32 |
获取播放时间类型 |
time |
uint32 |
时间进度 |
错误码
9、get_directory
请求参数说明
参数名 |
类型 |
说明 |
directory |
string |
需要查询的目录 |
调用示例
- ubus命令方式:
ubus call airplayer get_directory '{"directory":"/usr"}'
- wapi命令方式:
wapi 8ms '{"ver": "1.0", "module": "airplayer", "api": "get_directory", "param": {"directory":"/usr"}}'
返回示例
{
"directory": "\/usr",
"num": 2,
"list": {"videoplayback.mp4",
"201_7.mp4"
}
}
返回参数说明
参数名 |
类型 |
说明 |
directory |
string |
当前查询的目录 |
num |
uint32 |
查询到的文件总数 |
list |
string |
查询到的文件名 |
错误码
文档更新时间: 2021-04-14 13:50 作者:shuke