WiiM HTTP API Docs
Search K

Appearance

Playback control​

Get and set playback controls

Get the playback status​

GET
/getPlayerStatus

Makes a call to https://10.10.10.254/httpapi.asp?command=getPlayerStatus

Responses​

Successful response

text/html
JSON
{
  
"type": "0",
  
"ch": "0",
  
"mode": "10",
  
"loop": "-1",
  
"eq": "0",
  
"vendor": "vTuner",
  
"status": "play",
  
"curpos": "63634",
  
"offset_pts": "63634",
  
"totlen": "0",
  
"Title": "4D6F726E696E67204C69676874",
  
"Artist": "4F77656E20526965676C696E67",
  
"Album": "4D6F726E696E67204C69676874",
  
"alarmflag": "0",
  
"plicount": "5",
  
"plicurr": "2",
  
"vol": "25",
  
"mute": "0"
}

Playground​

Samples​

Deprecated

Play a specific track from a playlist by URL and index​

GET
/setPlayerCmd:hex_playlist:url:{index}

http://10.10.10.254/httpapi.asp?command=setPlayerCmd:hex_playlist:url:

Play the URl (URI is the m3u or ASX playlist link, index is the start
index), here, url should be hexed (please refer to 1.3)

Parameters​

Path Parameters

index*
Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Pause​

GET
/setPlayerCmd:pause

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:pause

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Samples​

Resume​

GET
/setPlayerCmd:resume

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:resume

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Samples​

Toggle pause/play​

GET
/setPlayerCmd:onepause

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:onepause

If the state is paused, resume it; otherwise, pause it.

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Samples​

Play audio URL​

GET
/setPlayerCmd:play:{url}

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:play:url
Play the URL. URL points to an audio stream address.
Response is always 'OK' now

Parameters​

Path Parameters

url*

URL points to an audio stream address

Type
string
Required
Default
"http://as-hls-ww-live.akamaized.net/pool_01505109/live/ww/bbc_radio_one/bbc_radio_one.isml/bbc_radio_one-audio%3d96000.norewind.m3u8"

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Play audio playlist​

GET
/setPlayerCmd:playlist:{url}:{index}

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:playlist:url:

Play the playlist with the URL (URL points to the m3u or ASX playlist
link, index is the start index).

Response is always 'OK' now.

Parameters​

Path Parameters

index*
Type
string
Required
url*
Type
string
Required
Default
"https://gist.githubusercontent.com/bpsib/67089b959e4fa898af69fea59ad74bc3/raw/685789e28187c0a15da978b51d436a140d5ea207/BBC-Radio-HLS.m3u"

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Previous​

GET
/setPlayerCmd:prev

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:prev

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Samples​

Next​

GET
/setPlayerCmd:next

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:next

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Samples​

Seek​

GET
/setPlayerCmd:seek:position

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:seek:position
Position is from 0 to duration in second.

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Samples​

Stop​

GET
/setPlayerCmd:stop

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:stop

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Samples​

Set volume​

GET
/setPlayerCmd:vol:{value}

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:vol:value
Value can be 0 to 100.

Parameters​

Path Parameters

value*

Value can be 0 to 100.

Type
integer
Required

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Mute​

GET
/setPlayerCmd:mute:{n}

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:mute:n

Mute: n=1

Unmute: n=0

The slave mute state will be set at the same time when it's in group
play.

Parameters​

Path Parameters

n*

Mute: n=1
Unmute: n=0

Type
integer
Required
Valid values
01
Default
1

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Loop mode set​

GET
/setPlayerCmd:loopmode:{n}

https://10.10.10.254/httpapi.asp?command=setPlayerCmd:loopmode:n

n =

  • -1: ...
  • 0: Shuffle disabled, Repeat enabled - loop
  • 1: Shuffle disabled, Repeat enabled - loop once
  • 2: Shuffle enabled, Repeat enabled - loop
  • 3: Shuffle enabled, Repeat disabled
  • 4: Shuffle disabled, Repeat disabled
  • 5: Shuffle enabled, Repeat enabled - loop once

Parameters​

Path Parameters

n*
  • -1: ...
  • 0: Shuffle disabled, Repeat enabled - loop
  • 1: Shuffle disabled, Repeat enabled - loop once
  • 2: Shuffle enabled, Repeat enabled - loop
  • 3: Shuffle enabled, Repeat disabled
  • 4: Shuffle disabled, Repeat disabled
  • 5: Shuffle enabled, Repeat enabled - loop once
Type
integer
Required
Valid values
-1012345
Default
4

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Powered by VitePress OpenAPI