WiiM HTTP API Docs
Search K

Appearance

Audio output control​

Get and set audio output mode

Get audio output mode​

GET
/getNewAudioOutputHardwareMode

JSON Response:
{"hardware":"2","source":"0","audiocast":"0"}

Description:
Field Description
hardware Hardware Interface output mode:
1: AUDIO_OUTPUT_SPDIF_MODE
2: AUDIO_OUTPUT_AUX_MODE
3: AUDIO_OUTPUT_COAX_MODE
source BT source output mode:
0: disable
1: active
audiocast Audio cast output mode:
0: disable
1: active

Responses​

Successful response

text/html
JSON
{
  
"hardware": "2",
  
"source": "0",
  
"audiocast": "0"
}

Playground​

Samples​

Set audio output mode​

GET
/setAudioOutputHardwareMode:{n}

Field Description
Hardware Interface output mode:
1: AUDIO_OUTPUT_SPDIF_MODE
2: AUDIO_OUTPUT_AUX_MODE
3: AUDIO_OUTPUT_COAX_MODE
Response is 'OK'

Parameters​

Path Parameters

n*

Hardware Interface output mode:
1: AUDIO_OUTPUT_SPDIF_MODE
2: AUDIO_OUTPUT_AUX_MODE
3: AUDIO_OUTPUT_COAX_MODE

Type
integer
Required
Valid values
123

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Get SPDIF sample rate switch latency​

GET
/getSpdifOutSwitchDelayMs

Example: https://10.10.10.254/httpapi.asp?command=getSpdifOutSwitchDelayMs

Observations:

  • This value only makes sense if the output interface is SPDIF (optical out).
  • Value can be retrieved even if output is not SPDIF

Responses​

Successful response

text/html
JSON
800

Playground​

Samples​

Set SPDIF sample rate switch latency​

GET
/setSpdifOutSwitchDelayMs:{Delay}

Example: https://10.10.10.254/httpapi.asp?command=setSpdifOutSwitchDelayMs:800

Observations:

  • Delay is in milliseconds
  • Value can be set even if output is not SPDIF
  • Delay is upper bound to 3000 milliseconds

Parameters​

Path Parameters

Delay*

The delay in milliseconds

Type
integer
Required

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Get left/right channel balance​

GET
/getChannelBalance

Example: https://10.10.10.254/httpapi.asp?command=getChannelBalance

Observations:

  • The value will be a number ranging from -1.0 (fully panned left) to 1.0 (fully panned right).

Responses​

Successful response

text/html
JSON
0

Playground​

Samples​

Set left/right channel balance​

GET
/setChannelBalance:{n}

Example: https://10.10.10.254/httpapi.asp?command=setChannelBalance:0

Observations:

  • The value must be a number ranging from -1.0 (fully panned left) to 1.0 (fully panned right).

Parameters​

Path Parameters

n*

Balance from -1.0 (left) to 1.0 (right)

Type
number
Required
Example0

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Get fade in/out feature status​

GET
/GetFadeFeature

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

Returns {"FadeFeature": 1}

Responses​

Successful response

text/html
JSON
{
  
"FadeFeature": 1
}

Playground​

Samples​

Set fade in/out feature​

GET
/SetFadeFeature:{n}

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

Parameters​

Path Parameters

n*

Fade feature value (0 or 1)

Type
integer
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Powered by VitePress OpenAPI