Description

• Video player (airplay) API

Interface version

IP address

http://192.168.1.1

Video storage path

/usr/videoplayback.mp4

API list

• Note: set the background color to 8080 (hexadecimal) when setting video playback.

1. set_path

Request parameter description

Call sample

1. ubus command method:

ubus call airplayer set_path '{"path":"/usr/videoplayback.mp4"}'

2. wapi command method:

wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_path", "param": {"path": "/usr/layout_test.mp3"}}'

Return sample

{
        "path": "\/usr\/videoplayback.mp4"
}

Return parameter description

Error code

2. set_volume

Request parameter description

Call sample

1. ubus command method:

ubus call airplayer set_volume '{"volume":10}'

2. wapi command method:

wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_volume", "param": {"volume": "10"}}'

Return sample

{
       "volume": 10
}

Return parameter description

Error code

3. cutover_video

Request parameter description

Call sample

1. ubus command method:

ubus call airplayer cutover_video '{"cutover":"up"}'
ubus call airplayer cutover_video '{"cutover":"down"}'

2. wapi command method:

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"}}'

Return sample

{
        "cutover": "down",
        "index": 1,
        "video": "\/usr\/videoplayback.mp4"
}

Return parameter description

Error code

4. set_position

Request parameter description

Call sample

1. ubus command method:

ubus call airplayer set_position '{"position_x":0,"position_y":0}'

2. wapi command method:

wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_position", "param": {"position_x":0,"position_y":0}}'

Return sample

{
        "position_x": 0,
        "position_y": 0
}

Return parameter description

Error code

5. set_size

Request parameter description

Call sample

1. ubus command method:

ubus call airplayer set_size '{"size_width":600,"size_height":400}'

2. wapi command method:

wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_size", "param": {"size_width":600,"size_height":400}}'

Return sample

{
        "size_width": 600,
        "size_height": 400
}

Return parameter description

Error code

6. set_status

Request parameter description

Call sample

1. ubus command method:

stop playback：ubus call airplayer set_status '{"status":"stop"}'
pause playback：ubus call airplayer set_status '{"status":"pause"}'
resume playback：ubus call airplayer set_status '{"status":"continue"}'
playback mode switching (single loop, list loop, no loop)：ubus call airplayer set_status '{"status":"mode"}'

2. wapi command method:

stop playback：wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_status", "param": {"status":"stop"}}'
pause playback：wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_status", "param": {"status":"pause"}}'
resume playback：wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_status", "param": {"status":"continue"}}'
playback mode switching (single loop, list loop, no loop)：wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_status", "param": {"status":"mode"}}'

Return sample

{
     "status": "stop"
}

Return parameter description

Error code

7. set_seek

Request parameter description

Call sample

1. ubus command method:

forward：ubus call airplayer set_seek '{"seek":10,"seek_direction":1}'
backward：ubus call airplayer set_seek '{"seek":10,"seek_direction":0}'
set playback progress directly：ubus call airplayer set_seek '{"seek":0,"seek_direction":2}'

2. wapi command method:

forward：wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_seek", "param": {"seek":10,"seek_direction":1}}'
backward：wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_seek", "param": {"seek":10,"seek_direction":0}}'
set playback progress directly：wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "set_seek", "param": {"seek":0,"seek_direction":2}}'

Return sample

{
        "seek": -10,
        "direction": 0
}

Return parameter description

Error code

8. get_videotime

Request parameter description

Call sample

1. ubus command method:

get video duration：ubus call airplayer get_videotime '{"videotime":"duration"}'
get current playback progress：ubus call airplayer get_videotime '{"videotime":"current"}'

2. wapi command method:

get video duration：wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "get_videotime", "param": {"videotime":"duration"}}'
get current playback progress：wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "get_videotime", "param": {"videotime":"current"}}'

Return sample

{
        "videotime": "duration",
        "duration time": 60.027000
}

Return parameter description

Error code

9. get_directory

Request parameter description

Call sample

1. ubus command method:

ubus call airplayer get_directory '{"directory":"/usr"}'

2. wapi command method:

wapi 8ms '{"ver": "1.0", "module": "airplayer",  "api": "get_directory", "param": {"directory":"/usr"}}'

Return sample

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

Return parameter description

Error code