Skip to content

Other

Existing commands, purpose unkown. To research further...


Get the remote volume step

GET
/get_remote_volume_step

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

Returns: {"status":"OK","remote_volume_step":1}

Responses

Successful response

application/json
JSON
{
  
"status": "string",
  
"remote_volume_step": 0
}

Playground

Samples


Set the remote volume step

GET
/set_remote_volume_step:{n}

Makes a call to https://10.10.10.254/httpapi.asp?command=set_remote_volume_step:{n}

Parameters

Path Parameters

n*

The volume step value

Type
integer
Required
Minimum
0
Maximum
100

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get the MV remote silence update time

GET
/getMvRemoteSilenceUpdateTime

...

Returns: {"start":"0:1", "end":"23:59"}

Responses

Successful response

application/json
JSON
{
  
"start": "string",
  
"end": "string"
}

Playground

Samples


Get SPDIF output maximum capabilities

GET
/getSpdifOutMaxCap

...

Responses

Successful response

Playground

Samples


Get the maximum capabilities of the coaxial output

GET
/getCoaxOutMaxCap

...

Returns: 48000:16:0

Responses

Successful response

text/plain
JSON
"string"

Playground

Samples


Get auxiliary voltage support list

GET
/getAuxVoltageSupportList

...

Responses

Successful response

Playground

Samples


Deprecated

Audio Cast get speaker list

GET
/audio_cast:get_speaker_list

...

Responses

Successful response

Playground

Samples


Deprecated

Audio Cast scan speaker

GET
/audio_cast:scan_speaker

...

Responses

Successful response

Playground

Samples


Deprecated

Audio Cast get speaker transcode buffer time

GET
/audio_cast:speaker_get_transcode_buffer_time

...

Responses

Successful response

Playground

Samples


Deprecated

Audio Cast get speaker transcode profile

GET
/audio_cast:speaker_get_transcode_profile

...

Responses

Successful response

Playground

Samples


Deprecated

Audio Cast set speaker password

GET
/audio_cast:speaker_set_password:{str1}:{str2}

...

Parameters

Path Parameters

str1*

Unknown

Type
string
Required
str2*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Deprecated

Audio Cast set speaker volume

GET
/audio_cast:speaker_set_volume:{str}:{volume}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required
volume*

Unknown

Type
integer
Required
Minimum
0
Maximum
100

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get sound card mode support list

GET
/getSoundCardModeSupportList

...

Responses

Successful response

Playground

Samples


Get the active sound card output mode

GET
/getActiveSoundCardOutputMode

...

Returns: {"index":"1","mode":"AUDIO_OUTPUT_AUX_MODE","cardId":"hw:0,1","devName":"Speaker Out","btSource":"0","audioCast":"0"}

Responses

Successful response

application/json
JSON
{
  
"index": "string",
  
"mode": "string",
  
"cardId": "string",
  
"devName": "string",
  
"btSource": "string",
  
"audioCast": "string"
}

Playground

Samples


WiiM Ultra enable/disable LCD

GET
/setLightOperationBrightConfig:%7B%22auto_sense_enable%22:{s},%22default_bright%22:{b},%22disable%22:{d}%7D

Example: https://10.10.10.254/httpapi.asp?command=setLightOperationBrightConfig:{%22auto_sense_enable%22:0,%22default_bright%22:1,%22disable%22:1}

Turns the screen of the WiiM Ultra on or off

Parameters

Path Parameters

s*

autosense?

Type
integer
Required
Default
0
b*

brightness?

Type
integer
Required
Default
1
d*

disable: 1 (off) or 0 (on)

Type
integer
Required
Valid values
01
Default
1

Responses

Successful response

Playground

Variables
Key
Value

Samples


Search for firmware updates available (check for updates)

GET
/getMvRemoteUpdateStartCheck

Example: http://10.10.10.254/httpapi.asp?command=getMvRemoteUpdateStartCheck

Search for the firmware updates available

Returns: OK

Responses

Successful response

text/plain
JSON
"string"

Playground

Samples


Start firmware update

GET
/getMvRemoteUpdateStart

Example: http://10.10.10.254/httpapi.asp?command=getMvRemoteUpdateStart

After calling the interface, if a new version is available, the device starts to download updates. At the end of the download, the update process starts.

WARNING: DO NOT POWER OFF DURING THIS PROCESS!!

Returns: OK

Responses

Successful response

text/plain
JSON
"string"

Playground

Samples


Status of the update process

GET
/getMvRemoteUpdateStatus

Example: http://10.10.10.254/httpapi.asp?command=getMvRemoteUpdateStatus

Get the download progress.

Value Meaning

  • 10 Under review
  • 20 OK
  • 21 The verification of the downloaded update file failed
  • 22 Downloading the update file failed
  • 23 The verification of the downloaded update file failed
  • 25 Start downloading
  • 27 Download complete
  • 30 Downloading and verification completed

Responses

Successful response

text/plain
JSON
"string"

Playground

Samples


Status of the update process

GET
/getMvRomBurnPrecent

Example: http://10.10.10.254/httpapi.asp?command=getMvRomBurnPrecent

Status of updating

Returns: { "status" : "0", "progress" : "50"}

Fields Meaning
status State
progress Progress between 0 to 100%

Responses

Successful response

application/json
JSON
{
  
"status": "string",
  
"progress": "string"
}

Playground

Samples


EasyLink response stop

GET
/EasyLinkResponseStop

...

Responses

Successful response

Playground

Samples


Notify upgrade type firmware

GET
/NotifyUpgradeType:firmware

...

Responses

Successful response

Playground

Samples


Get LMP filter capability

GET
/getLMPFilterCapability

...

Returns: { "version": "1.1" }

Responses

Successful response

application/json
JSON
{
  
"version": "string"
}

Playground

Samples


Get stream service config for a specific source

GET
/getStreamServiceConfig:{source}

...

Parameters

Path Parameters

source*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set handshake code

GET
/setHandshakeCode:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get system log for a specific IP address

GET
/getsyslog:ip:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get the device status

GET
/getStatus:ip:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get update server

GET
/GetUpdateServer

...

Responses

Successful response

Playground

Samples


Get weather info

GET
/getWeatherInfo

...

Responses

Successful response

Playground

Samples


Set access PIN

GET
/setAccessPIN:%7B%22PIN%22:%22{str}%22%7D

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set language

GET
/setLanguage:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Deprecated

Auto play setting

GET
/AutoPlaySet

...

Responses

Successful response

Playground

Samples


Get MV ROM download status

GET
/getMvRomDownloadStatus

...

Returns: {"status":"0","count":"0","dcount":"0","wcount":"0","tsize":"0","dsize":"0","wsize":"0","csize":"0", "cdsize":"0", "cwsize":"0", "progress":"0","name":"","ver":"0","new_ver":"0"}

Responses

Successful response

application/json
JSON
{
  
"status": "string",
  
"count": "string",
  
"dcount": "string",
  
"wcount": "string",
  
"tsize": "string",
  
"dsize": "string",
  
"wsize": "string",
  
"csize": "string",
  
"cdsize": "string",
  
"cwsize": "string",
  
"progress": "string",
  
"name": "string",
  
"ver": "string",
  
"new_ver": "string"
}

Playground

Samples


Get MV ROM download status V2

GET
/getMvRomDownloadV2Status

...

Returns: {"status":"0","progress":"0","name":"","ver":"0","new_ver":"0"}

Responses

Successful response

application/json
JSON
{
  
"status": "string",
  
"progress": "string",
  
"name": "string",
  
"ver": "string",
  
"new_ver": "string"
}

Playground

Samples


Set hex group name

GET
/setHexGroupName:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set MV remote silence OTA time

GET
/setMvRemoteSilenceOTATime:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set MV remote silence update time

GET
/setMvRemoteSilenceUpdateTime:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set timezone

GET
/setTimezone:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Deprecated

Check access PIN

GET
/checkAccessPIN

...

Responses

Successful response

Playground

Samples


Set update server

GET
/SetUpdateServer:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set weather location

GET
/setWeatherLocation:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Start check

GET
/StartCheck

...

Responses

Successful response

Playground

Samples


Deprecated

Get battery value

GET
/getbatteryval

...

Responses

Successful response

Playground

Samples


Get Automatic Speech Recognition Status

GET
/getAsrStatus

...

Returns: { "times_talk_on": "0", "times_request_succeed": "0", "times_request_failed": "0", "times_vad_time_out": "0", "times_play_failed": "0", "open_failed": "0", "capture_failed": "0", "mode": "normal", "score": "0", "volume": "18", "play_status": "0", "config_score": "0", "config_interval": "0", "trigger_test_mode": "0", "trigger_mis_test_mode": "0", "trigger_recording": "0", "have_prompt": "0", "fallback_enable": "0", "profile": "near", "hands_free": "0", "status": "ok", "id": "0" }

Responses

Successful response

application/json
JSON
{
  
"times_talk_on": "string",
  
"times_request_succeed": "string",
  
"times_request_failed": "string",
  
"times_vad_time_out": "string",
  
"times_play_failed": "string",
  
"open_failed": "string",
  
"capture_failed": "string",
  
"mode": "string",
  
"score": "string",
  
"volume": "string",
  
"play_status": "string",
  
"config_score": "string",
  
"config_interval": "string",
  
"trigger_test_mode": "string",
  
"trigger_mis_test_mode": "string",
  
"trigger_recording": "string",
  
"have_prompt": "string",
  
"fallback_enable": "string",
  
"profile": "string",
  
"hands_free": "string",
  
"status": "string",
  
"id": "string"
}

Playground

Samples


Get LP Auth Code

GET
/getLPAuthCode:hostId={str}:clientId={str2}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required
str2*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set token parameters

GET
/setTokenParams:code={str}:redirect_uri={str2}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required
str2*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set talk prompt

GET
/talksetPrompt:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set talk alarm pre-wake

GET
/talksetAlarmPreWake:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set talk alarm tone

GET
/talksetAlarmTone:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set talk alarm tone preview

GET
/talksetAlarmTonePreview:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set talk alarm volume

GET
/talksetAlarmVolume:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set talk alarm common settings

GET
/talksetAlarmcommon:prewake:{str}:vol:{n1}:tone:{n2}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required
n1*

Unknown

Type
integer
Required
n2*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set sync play extra delay

GET
/SetSyncPlayExtraDelay:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set initial configuration

GET
/setInitialConfiguration:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Deprecated

Get UI config

GET
/get_ui_config

...

Responses

Successful response

Playground

Samples


Get SPDIF auto-sense enable status

GET
/getSpdifAutoSenseEnable

...

Responses

Successful response

Playground

Samples


Get SPDIF input noise removal status

GET
/getSpdifInNoiseRemove

...

Responses

Successful response

Playground

Samples


Phono mode switch set

GET
/PHONO_MODE_SWITCH_SET:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set play mode volume enable

GET
/setPlayModeVolumeEnable:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Deprecated

Get UI wallpaper list

GET
/get_ui_wallpaper_list

...

Responses

Successful response

Playground

Samples


Set play mode volume value

GET
/setPlayModeVolumeValue:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set power mode time

GET
/setPowerModeTime:%7B%22idleInterval%22:%22{str}%22%7D

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get the volume step of the buttons

GET
/get_button_volume_step

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

Returns: {"status":"OK","button_volume_step":2}

Responses

Successful response

application/json
JSON
{
  
"status": "OK",
  
"button_volume_step": 2
}

Playground

Samples


Set the volume step of the buttons

GET
/set_button_volume_step:{str}

Makes a call to https://10.10.10.254/httpapi.asp?command=set_button_volume_step:{str}

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get AUX auto-sense enable status

GET
/getAuxAutoSenseEnable

...

Returns: 0 or 1, where 0 means AUX auto-sense is disabled and 1 means AUX auto-sense is enabled

Responses

Successful response

text/plain

Playground

Samples


Set UI config

GET
/set_ui_config:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set SPDIF auto-sense enable

GET
/setSpdifAutoSenseEnable:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set SPDIF input noise removal

GET
/setSpdifInNoiseRemove:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get channel mode

GET
/getChannelMode

...

Returns an integer representing the current channel mode. The meaning of the values is currently unknown.

Responses

Successful response

text/plain

Playground

Samples


Get auto-sense enable status

GET
/getAutoSenseEnable

...

Returns: 0 or 1, where 0 means auto-sense is disabled and 1 means auto-sense is enabled

Responses

Successful response

text/plain

Playground

Samples


Start reboot time

GET
/StartRebootTime:1

...

Responses

Successful response

Playground

Samples


Get LED switch status

GET
/LED_SWITCH_GET

...

Responses

Successful response

Playground

Samples


Get MQA receiver capacity

GET
/getMQAReceiverCap

...

Returns: 0 or 1, where 0 means MQA is not supported and 1 means MQA is supported

Responses

Successful response

text/plain

Playground

Samples


Reload button status

GET
/Reload_Button_GET

...

Responses

Successful response

Playground

Samples


Set AUX auto-sense enable

GET
/setAuxAutoSenseEnable:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get low priority prompt disable status

GET
/getLowPriorityPromptDisable

...

Returns: 0 or 1, where 0 means low priority prompts are enabled and 1 means low priority prompts are disabled

Responses

Successful response

text/plain

Playground

Samples


Get soft mute status

GET
/getSoftMute

...

Responses

Successful response

Playground

Samples


Get LINE IN maximum capacity

GET
/getLineInMaxCap

...

Returns: 48000:16:0, which means a maximum sampling rate of 48000 Hz, a maximum bit depth of 16 bits, and a maximum channel count of 0 (unknown)

Responses

Successful response

text/plain
JSON
"string"

Playground

Samples


Get AUX input maximum capacity

GET
/getAuxInMaxCap

...

Returns: 48000:16:0, which means a maximum sampling rate of 48000 Hz, a maximum bit depth of 16 bits, and a maximum channel count of 0 (unknown)

Responses

Successful response

text/plain
JSON
"string"

Playground

Samples


Get UAC output maximum capacity

GET
/getUacOutMaxCap

...

Responses

Successful response

Playground

Samples


Get HDMI auto-sense enable

GET
/getHDMIAutoSenseEnable

...

Returns: 0 or 1, where 0 means HDMI auto-sense is disabled and 1 means HDMI auto-sense is enabled

Responses

Successful response

text/plain

Playground

Samples


Set channel mode

GET
/setChannelMode:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get sync play extra delay

GET
/GetSyncPlayExtraDelay

...

Responses

Successful response

Playground

Samples


Get light operation brightness configuration

GET
/getLightOperationBrightConfig

...

Responses

Successful response

Playground

Samples


Set UI wallpaper list

GET
/set_ui_wallpaper_list:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get main/sub extra delay

GET
/getMainSubExtraDelay

...

Returns, without Subwoofer attached: {"category": "mainsubdelay", "body": {"errorType": "-1000", "mainSubExtraDelay": "-1000.000", "mainDelay": "-1000.000", "subDelay": "-1000.000", "errorDescribe": "unknow error"}}

Responses

Successful response

application/json
JSON
{
  
"category": "mainsubdelay",
  
"body": {
  
  
"errorType": "-1000",
  
  
"mainSubExtraDelay": "-1000.000",
  
  
"mainDelay": "-1000.000",
  
  
"subDelay": "-1000.000",
  
  
"errorDescribe": "unknow error"
  
}
}

Playground

Samples


Disable Cast

GET
/Cast:Disable

...

Responses

Successful response

Playground

Samples


Disable usage report for Cast

GET
/Cast:DisableUsageReport

...

Responses

Successful response

Playground

Samples


Set auto-sense enable

GET
/setAutoSenseEnable:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get phono mode switch state

GET
/PHONO_MODE_SWITCH_GET

...

Responses

Successful response

Playground

Samples


Get play mode volume enable

GET
/getPlayModeVolumeEnable

...

Responses

Successful response

Playground

Samples


Set volume control

GET
/setVolumeControl:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get play mode volume value

GET
/getPlayModeVolumeValue

...

Responses

Successful response

Playground

Samples


Set MQA receiver capacity

GET
/setMQAReceiverCap:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get power mode time

GET
/getPowerModeTime

...

Responses

Successful response

Playground

Samples


Set max volume

GET
/setMaxVolume:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Enable Cast

GET
/Cast:EnableCast

...

Responses

Successful response

Playground

Samples


Reload button update

GET
/Reload_Button_UPDATE:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Enable usage report for Cast

GET
/Cast:EnableUsageReport

...

Responses

Successful response

Playground

Samples


Disable low priority prompt

GET
/disableLowPriorityPrompt:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set soft mute

GET
/setSoftMute:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set HDMI auto-sense enable

GET
/setHDMIAutoSenseEnable:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set SPDIF output max capacity

GET
/setSpdifOutMaxCap:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set coaxial output max capacity

GET
/setCoaxOutMaxCap:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set line input max capacity

GET
/setLineInMaxCap:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set auxiliary input max capacity

GET
/setAuxInMaxCap:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set UAC out max cap

GET
/setUacOutMaxCap:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Enable system information output

GET
/EnableSysInfo:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get AirPlay extra delay

GET
/GetAirplayExtraDelay

Makes a call to https://10.10.10.254/httpapi?command=GetAirplayExtraDelay

Returns: {"AirplayExtraDelay":-10}

Responses

Successful response

application/json
JSON
{
  
"AirplayExtraDelay": -10
}

Playground

Samples


Deprecated

Get current wireless connection information

GET
/GetCurrentWirelessConnect

Makes a call to https://10.10.10.254/httpapi?command=GetCurrentWirelessConnect

Responses

Successful response

Playground

Samples


Slave alert get

GET
/SlaveIP:{ip}:alertget

...

Parameters

Path Parameters

ip*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Slave set alarm volume

GET
/SlaveIP:{ip}:talksetAlarmVolume:{n}

...

Parameters

Path Parameters

ip*

Unknown

Type
string
Required
n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Squeezelite auto connect enable

GET
/Squeezelite:autoConnectEnable:{n}

...

Parameters

Path Parameters

n*

Unknown

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Squeezelite connect server

GET
/Squeezelite:connectServer:{ip}

...

Parameters

Path Parameters

ip*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Squeezelite discover

GET
/Squeezelite:discover

...

Responses

Successful response

Playground

Samples


Squeezelite get state

GET
/Squeezelite:getState

...

Responses

Successful response

Playground

Samples


Deprecated

Get setup router information

GET
/getSetupRouterInfo

...

Responses

Successful response

Playground

Samples


Set setup router information

GET
/setSetupRouterInfo:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Alert get

GET
/alertget

...

Responses

Successful response

Playground

Samples


TVS logout

GET
/TvsLogout

...

Responses

Successful response

Playground

Samples


Get TVS state

GET
/TvsState

...

Responses

Successful response

Playground

Samples


Get TVS device information

GET
/getTvsDevInfo

...

Responses

Successful response

Playground

Samples


Set TVS access token

GET
/setTVSAccessToken:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set TVS debug mode

GET
/setTVSDebugMode:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set TVS client ID

GET
/setTvsClientID:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Create routine

GET
/createRoutine:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get all routines

GET
/getAllRoutines

...

Returns: { "routines": [ { "updateDate": "2025-10-12T12:03:48Z", "steps": [ { "type": "subwoofer", "payload": { "subOutput": 0 } }, { "type": "loopMode", "payload": { "mode": 3 } } ], "createDate": "2025-10-12T12:03:48Z", "id": "E59E781B-CE00-4347-9E5B-A82F47C675AC", "name": "Spotify Liked", "index": 1 } ] }

Responses

Successful response

application/json
JSON
{
  
"routines": [
  
  
{
  
  
  
"updateDate": "2025-10-12T12:03:48Z",
  
  
  
"steps": [
  
  
  
  
{
  
  
  
  
  
"type": "subwoofer",
  
  
  
  
  
"payload": {
  
  
  
  
  
}
  
  
  
  
}
  
  
  
],
  
  
  
"createDate": "2025-10-12T12:03:48Z",
  
  
  
"id": "E59E781B-CE00-4347-9E5B-A82F47C675AC",
  
  
  
"name": "Spotify Liked",
  
  
  
"index": 1
  
  
}
  
]
}

Playground

Samples


Get routine capability

GET
/getRoutineCapability

...

Returns: { "version": "1.1" }

Responses

Successful response

application/json
JSON
{
  
"version": "1.1"
}

Playground

Samples


Get audio input capability

GET
/getAudioInputCapbility

...

Returns: { "ver": "1.0", "audioInput": [ { "mode": "wifi" }, { "mode": "line-in" }, { "mode": "bluetooth" }, { "mode": "optical" }, { "mode": "HDMI" } ] }

Responses

Successful response

application/json
JSON
{
  
"ver": "1.0",
  
"audioInput": [
  
  
{
  
  
  
"mode": "wifi"
  
  
}
  
]
}

Playground

Samples


Get audio output maximum 32-bit support

GET
/getAudioOutMax32bit

...

Returns: 0 or 1

Responses

Successful response

application/json
JSON
{
  
"audioOutMax32bit": 1
}

Playground

Samples


Set audio output maximum 32-bit support

GET
/setAudioOutMax32bit:{n}

...

n: 0 or 1

Parameters

Path Parameters

n*

The desired audio output maximum 32-bit support (0 or 1)

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get audio output VRMS for a specific output

GET
/getAudioOutputVrms:{str}

...

Parameters

Path Parameters

str*

Unknown (possibly the output type or identifier)

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get list of audio outputs that support VRMS

GET
/getAudioOutputVrmsSupportList

...

Responses

Successful response

Playground

Samples


Set audio output VRMS for a specific output

GET
/setAudioOutputVrms:{str}

...

Parameters

Path Parameters

str*

Unknown (possibly the output type or identifier)

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Deprecated

Get CBL status

GET
/getCBLStatus

...

Responses

Successful response

Playground

Samples


Get CEC power control status

GET
/getCecPowerCtrl

...

Returns: 0 or 1

Responses

Successful response

text/plain

Playground

Samples


Set CEC power control status

GET
/setCecPowerCtrl:{n}

...

n: 0 or 1

Parameters

Path Parameters

n*

The desired CEC power control status (0 or 1)

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get CXDISH percentage

GET
/getCxdishPrecent

...

Returns: {"status":"0","progress":"0"}

Responses

Successful response

application/json
JSON
{
  
"status": "0",
  
"progress": "0"
}

Playground

Samples


Get list of supported digital filter types

GET
/getDigitalFilterTypeSupportList

...

Returns: [ { "index": 1, "args": [ "amixer cset name='ES9018 DigiFilt' 0" ], "value": "Fast Roll-Off" }, { "index": 2, "args": [ "amixer cset name='ES9018 DigiFilt' 1" ], "value": "Slow Roll-Off" }, { "index": 3, "args": [ "amixer cset name='ES9018 DigiFilt' 2" ], "value": "Minimum Phase" } ]

Responses

Successful response

application/json
JSON
{
  
"digitalFilterTypes": [
  
  
{
  
  
  
"index": 1,
  
  
  
"args": [
  
  
  
  
"amixer cset name='ES9018 DigiFilt' 0"
  
  
  
],
  
  
  
"value": "Fast Roll-Off"
  
  
}
  
]
}

Playground

Samples


Get current digital filter type

GET
/getDigitalFilterType

...

Returns: 1, 2, or 3 corresponding to the supported digital filter types

Responses

Successful response

application/json
JSON
1

Playground

Samples


Set digital filter type

GET
/setDigitalFilterType:{n}

...

Parameters

Path Parameters

n*

The digital filter type to set (1, 2, or 3)

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get current output digital filter type

GET
/getOutputDigitalFilterType:{str}

...

Parameters

Path Parameters

str*

Unknown (possibly the output type or identifier)

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get list of supported output digital filter types

GET
/getOutputDigitalFilterTypeSupportList

...

Responses

Successful response

Playground

Samples


Set output digital filter type

GET
/setOutputDigitalFilterType:{str}

...

Parameters

Path Parameters

str*

Unknown (possibly the output type or identifier)

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get supported digital input audio types

GET
/getDigitalInputAudioTypeSupport

...

Returns: 0x1

Responses

Successful response

application/json
JSON
"0x1"

Playground

Samples


Get output voltage

GET
/getOutputVoltage

...

Returns an integer

Responses

Successful response

application/json
JSON
2

Playground

Samples


Set output voltage

GET
/setOutputVoltage:{n}

...

Parameters

Path Parameters

n*

The desired output voltage

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get feature capability

GET
/getFeatureCapbility

...

Responses

Successful response

Playground

Samples


Get play mode gain configuration

GET
/getPlayModeGainConfig

...

Responses

Successful response

Playground

Samples


Set play mode gain configuration

GET
/setPlayModeGainConfig:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Media server scan

GET
/mediaserver:scan

...

Responses

Successful response

Playground

Samples


Media server USB disk unmount

GET
/mediaserver:udiskumount

...

Responses

Successful response

Playground

Samples


Get list of supported input modes

GET
/getInputModeSupportList

...

Responses

Successful response

Playground

Samples


Get input mode rename information

GET
/getModeRename

...

Returns: {"Line-In" : "", "SPDIF-In" : "PC"}

Responses

Successful response

application/json
JSON
{
  
"additionalProperties": "string"
}

Playground

Samples


Set input mode rename information

GET
/setModeRename:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set music explicit content filter

GET
/setMusicExplicit:{n}

...

n: 0 or 1

Parameters

Path Parameters

n*

The desired music explicit content filter status (0 or 1)

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get MV remote update device OTA information

GET
/getMvRemoteUpdateDeviceOtaInfo

...

Returns: {"language":"en_us","projectId":"0fb639765679eb9a7cf7d68761e2d71b6a2d62ea47cc049db3c7df61d6816fc9","fwVersion":"Linkplay.5.0.739659","version":"1.0","macAddr":"E8:2D:29:7C:45:40","serialNumber":"","deviceUid":"FA98F353DDFE707499E52529","imgList":[{"imgName":"hdmi","imgVersion":"71"},{"imgName":"moduleMulti","imgVersion":"Linkplay.5.0.739659"},{"imgName":"gc4a_zip","imgVersion":"Linkplay.5.0.739659"}]}

Responses

Successful response

application/json
JSON
{
  
"language": "en_us",
  
"projectId": "0fb639765679eb9a7cf7d68761e2d71b6a2d62ea47cc049db3c7df61d6816fc9",
  
"fwVersion": "Linkplay.5.0.739659",
  
"version": "1.0",
  
"macAddr": "E8:2D:29:7C:45:40",
  
"serialNumber": "",
  
"deviceUid": "FA98F353DDFE707499E52529",
  
"imgList": [
  
  
{
  
  
  
"imgName": "hdmi",
  
  
  
"imgVersion": "71"
  
  
}
  
]
}

Playground

Samples


Set TuneIn favorite state for a song

GET
/setTuneinFavoriteState:songId={songId}:statu={status}

...

songId: The ID of the song
status: 0 for not favorite, 1 for favorite

Parameters

Path Parameters

songId*

The ID of the song

Type
string
Required
status*

0 for not favorite, 1 for favorite

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set TuneIn location information

GET
/setTuneinLocation:latitude={latitude}:longitude={longitude}:serial={serial}

...

latitude: Latitude of the location
longitude: Longitude of the location
serial: Device serial number

Parameters

Path Parameters

latitude*

Latitude of the location

Type
string
Required
longitude*

Longitude of the location

Type
string
Required
serial*

Device serial number

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set TuneIn authentication token information

GET
/setTuneinToken:username={username}:token={token}:refreshToken={refreshToken}:expires_in={expires_in}:userid={userid}

...

username: TuneIn account username
token: Authentication token
refreshToken: Token used to refresh the authentication token
expires_in: Time in seconds until the token expires
userid: TuneIn user ID

Parameters

Path Parameters

username*

TuneIn account username

Type
string
Required
token*

Authentication token

Type
string
Required
refreshToken*

Token used to refresh the authentication token

Type
string
Required
expires_in*

Time in seconds until the token expires

Type
integer
Required
userid*

TuneIn user ID

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get streaming services capabilities

GET
/streamServicesCapability

...

Returns: { "version": "1.6", "encrypt": "1.0", "streamServices": [ { "id": "Prime", "version": "1.4", "quality": [ "SD", "HD", "UHD" ] }, { ... } ] }

Responses

Successful response

application/json
JSON
{
  
"version": "1.6",
  
"encrypt": "1.0",
  
"streamServices": [
  
  
{
  
  
  
"id": "Prime",
  
  
  
"version": "1.4",
  
  
  
"quality": [
  
  
  
  
"SD"
  
  
  
],
  
  
  
"replayGain": true,
  
  
  
"configurable": true,
  
  
  
"active": true,
  
  
  
"brand": "WiiM",
  
  
  
"model": "Amp"
  
  
}
  
]
}

Playground

Samples


Tidal login using OAuth code

GET
/tidallogin:oauthcode={str}

...

Parameters

Path Parameters

str*

The OAuth code obtained from Tidal authentication flow

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Powered by VitePress OpenAPI