groupVolume > setMute

Use the setMute command in the groupVolume namespace to mute and unmute the group.

The group’s mute state is independent of its group volume. For example a group’s mute state can be true although its group volume is still 20, and the user will not hear any audio coming from the group of players. Individual player volume values are stored by each player in the group while muted, which allows the group to retain the relative volume of players in the group. That is important information to preserve, since users may have carefully configured the individual player volumes in the group with a Sonos controller. Your app should not mute the group by calling setVolume with zero volume, otherwise the relative volume of players in the group will be lost.

If some players in the group are muted and others are not, calling setMute to mute the group will mute all the players in the group. The individual player’s mute state prior to calling setMute is not preserved.

To get the current group’s mute state, use the getVolume command or subscribe to the groupVolume event.



Request Parameters

This command requires a groupId to determine the target of the command. See the Control documentation for details.

See the table below for a description of the parameter in the body.

Parameter Type Value
muted boolean The desired mute state of the group: true for muted and false for not muted.


Returns an empty body with a success value of true if successful. The player generates a groupVolume event if the mute state was changed. In the event of a failure, returns a globalError.