Skip to content

Multiroom

Get and set multirroom settings


Get a list of LinkPlay available

GET
/multiroom:getSlaveList

Example: http://10.10.10.254/httpapi.asp?command=multiroom:getSlaveList

Allows to obtain the list of the devices using the same communication protocol.

JSON output:
{
"Slaves": "1",
"Slave_list": [
{
"Name": "FA5100_a3f4",
"Mask": "0",
"Volume": "90",
"Mute": "0",
"Channel": "0",
"Ip": "10.10.10.100",
"Version": "WIFIAudio.1.2.2321"
}
]
}

Field Description
Slaves Number of LinkPlay available
Slave_list Information about each Sonoé iEast case available
name Name
mask Case already in Multi-Room mode, Yes = 1, No = 0
Volume Volume level
Mute Enable Mute mode, Yes = 1, Off = 0
Channel Wifi channel
ip IP address of the LinkPlay Boot
version firmware version

Responses

Successful response

Playground

Samples


Removing a LinkPlay from the multi-room

GET
/multiroom:SlaveKickout:{ip}

Example: http://10.10.10.254/httpapi.asp?command=multiroom:SlaveKickout:ip

Allows to remove from the multiroom mode a device Based on its IP address.

Parameters

Path Parameters

ip*

The IP address of the LinkPlay device to be removed from multi-room mode.

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Hide the IP address of a LinkPlay

GET
/multiroom:SlaveMask:{ip}

Example: http://10.10.10.254/httpapi.asp?command=multiroom:SlaveMask:ip

Allows to integrate a multi-room mode a device Based on its IP address. It is thus rendered invisible from the IP network.

Parameters

Path Parameters

ip*

The IP address of the LinkPlay device to be hidden from the IP network in multi-room mode.

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Releasing a Multi-Room Mode

GET
/multiroom:SlaveUnMask:{ip}

Example: http://10.10.10.254/httpapi.asp?command=multiroom:SlaveUnMask:ip

Allows to release from the multi-room mode based on its IP address. It is thus visible on the IP network.

Parameters

Path Parameters

ip*

The IP address of the LinkPlay device to be released from multi-room mode.

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Individual volume adjustment

GET
/multiroom:SlaveVolume:{ip}:{volume}

Example: http://10.10.10.254/httpapi.asp?command=multiroom:SlaveVolume:ip:volume

Allows you to adjust the individual volume of the each of the devicees via the IP address of the device and the definition of a value going from from 1 to 100. Note: these settings will be lost when deactivating multi-room mode (kickout)

Parameters

Path Parameters

ip*

The IP address of the LinkPlay device to adjust the volume for in multi-room mode.

Type
string
Required
volume*

The volume level to set for the specified LinkPlay device, ranging from 1 to 100.

Type
integer
Required
Minimum
1
Maximum
100

Responses

Successful response

Playground

Variables
Key
Value

Samples


General Volume Adjustment

GET
/setPlayerCmd:slave_vol:{volume}

Example: http://10.10.10.254/httpapi.asp?command=setPlayerCmd:slave_vol:volume

Adjusts the overal volume of the multi-room with the definition of a value ranging from 1 to 100. Note: thesis settings will be lost When disabling multi-room mode

Parameters

Path Parameters

volume*

The overall volume level to set for multi-room mode, ranging from 1 to 100.

Type
integer
Required
Minimum
1
Maximum
100

Responses

Successful response

Playground

Variables
Key
Value

Samples


Individual muting

GET
/multiroom:SlaveMute:{ip}:{mute}

Example: http://10.10.10.254/httpapi.asp?command=multiroom:SlaveMute:ip:mute

Enables the Mute on each device via the IP address of the device and by enabling (1) and disabling (0)

Parameters

Path Parameters

ip*

The IP address of the LinkPlay device to adjust the mute status for in multi-room mode.

Type
string
Required
mute*

Mute status to set for the specified LinkPlay device, where 1 enables mute and 0 disables mute.

Type
integer
Required
Valid values
01

Responses

Successful response

Playground

Variables
Key
Value

Samples


General activation Mute

GET
/setPlayerCmd:slave_mute:mute

Example: http://10.10.10.254/httpapi.asp?command=setPlayerCmd:slave_mute:mute

Enables the Mute on all devices

Responses

Successful response

Playground

Samples


General Mute Disabling

GET
/setPlayerCmd:slave_mute:unmute

Example: http://10.10.10.254/httpapi.asp?command=setPlayerCmd:slave_mute:unmute

To disable the mute mode overall the

Responses

Successful response

Playground

Samples


Individual management of the audio signal Right / left

GET
/multiroom:SlaveChannel:{ip}:{channel}

Example: http://10.10.10.254/httpapi.asp?command=multiroom:SlaveChannel:ip:channel

Enables the Mute on Each of the devices via the IP address of the device and by this parameter to signal right only Channe0 = left and only 1 = Channel signal

Parameters

Path Parameters

ip*

The IP address of the LinkPlay device to adjust the audio channel for in multi-room mode.

Type
string
Required
channel*

Audio channel to set for the specified LinkPlay device, where 0 signals right only and 1 signals left only.

Type
integer
Required
Valid values
01

Responses

Successful response

Playground

Variables
Key
Value

Samples


Overal management of the audio signal Right / left

GET
/setPlayerCmd:{slave_channel}:{channel}

Example: http://10.10.10.254/httpapi.asp?command=setPlayerCmd:slave_channel:channel

Enables the Mute on Each of devices via the IP address of the device and by this parameter to signal right only Channel= 0 and left signal only 1 = Channel

Parameters

Path Parameters

slave_channel*

IP address of the device

Type
string
Required
channel*

Audio channel to set for all devices in multi-room mode, where 0 signals right only and 1 signals left only.

Type
integer
Required
Valid values
01

Responses

Successful response

Playground

Variables
Key
Value

Samples


Individual definition of the device Name

GET
/multiroom:SlaveSetDeviceName:{ip}:{s}

Example: http://10.10.10.254/httpapi.asp?command=multiroom:SlaveSetDeviceName:%ip:%s

Individual settings of the name of the square in mode UPnP / Airplay

Parameters

Path Parameters

ip*

The IP address of the LinkPlay device to set the device name for in multi-room mode.

Type
string
Required
s*

The device name to set for the specified LinkPlay device in multi-room mode.

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Disabling Multi-Room

GET
/multiroom:Ungroup

Example: http://10.10.10.254/httpapi.asp?command=multiroom:Ungroup

Disables the multi-room mode

Responses

Successful response

Playground

Samples


Get the real-time cache limit

GET
/multiroom:ConfigGet:realtime_cache_limit

Example: http://10.10.10.254/httpapi.asp?command=multiroom:ConfigGet:realtime_cache_limit

Get the real-time cache limit in multi-room mode. The value is in seconds.

Responses

Successful response

Playground

Samples


Set the real-time cache limit

GET
/multiroom:ConfigSet:realtime_cache_limit:{value}

Example: http://10.10.10.254/httpapi.asp?command=multiroom:ConfigSet:realtime_cache_limit:%d

Set the real-time cache limit in multi-room mode. The value is in seconds.

Parameters

Path Parameters

value*

The real-time cache limit to set for multi-room mode, in seconds.

Type
integer
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Start WPS on a LinkPlay device

GET
/multiroom:SlaveStartWPS:{ip}

Example: http://10.10.10.254/httpapi.asp?command=multiroom:SlaveStartWPS:%s

Start WPS on a LinkPlay device based on its IP address. This can be used to connect the device to a new Wi-Fi network.

Parameters

Path Parameters

ip*

The IP address of the LinkPlay device to start WPS on.

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get the list of group names in multi-room mode

GET
/multiroom:getnamegrouplist

Example: http://10.10.10.254/httpapi.asp?command=multiroom:getnamegrouplist

Get the list of group names in multi-room mode. The output is a JSON array of strings, where each string is a group name.

Response example:
{ "grouplist": [ ], "current_group_id": "" }

Responses

Successful response

text/html
JSON
{
  
"grouplist": [
  
],
  
"current_group_id": "string"
}

Playground

Samples


Leaving the multi-room mode

GET
/multiroom:LeaveGroup

...

Responses

Successful response

Playground

Samples


Joining a multi-room group

GET
/multiroom:JoinGroup:IP={IP}:uuid={uuid}

...

Parameters

Path Parameters

IP*

The IP address of the multi-room group to join.

Type
string
Required
uuid*

The UUID of the multi-room group to join.

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Multi-room get slave device name

GET
/multiroom:SlaveDeviceName:{ip}:{str}

...

Parameters

Path Parameters

ip*

The IP address of the slave device

Type
string
Required
str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Multi-room subwoofer forget

GET
/multiroom:subwooferForget:%7B%22uuid%22:%22{uuid}%22%7D

...

Parameters

Path Parameters

uuid*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Multi-room subwoofer get pair info

GET
/multiroom:subwooferGetPairInfo

...

Responses

Successful response

Playground

Samples


Multi-room get lead time

GET
/multiroom:ConfigGet:leadtime

...

Responses

Successful response

Playground

Samples


Multi-room subwoofer pair

GET
/multiroom:subwooferPair:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Multi-room set lead time

GET
/multiroom:ConfigSet:leadtime:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Set multiroom subwoofer LPF

GET
/setMRMSubLPF:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get subwoofer LPF

GET
/getSubLPF

...

Responses

Successful response

Playground

Samples


Set subwoofer LPF

GET
/setSubLPF:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Get multi-room sub LPF

GET
/getMRMSubLPF:{str}

...

Parameters

Path Parameters

str*

Unknown

Type
string
Required

Responses

Successful response

Playground

Variables
Key
Value

Samples


Powered by VitePress OpenAPI