settings > playerSettings

Player settings include volumeMode, volumeScalingFactor, monoMode, and wifiDisable. The player returns the playerSettings object type in the response to getPlayerSettings. Use setPlayerSettings to set player settings.

Parameters

See the table below for descriptions of parameters in this object.

Parameter Type Value
volumeMode enum
  • VARIABLE—the normal mode. The player enables volume controls and makes volume adjustments internally.
  • FIXED—disables volume controls. The player always outputs a fixed volume. This mode is useful for devices without a built-in amplifier, like the Sonos Connect.
  • PASS_THROUGH—enables volume controls in fixed output mode. When enabled, the player emits volume changes as playerVolume events, just as it would in the normal mode. However, the player doesn’t modify the audio signal. This currently works on the Sonos Amp and the Connect.
volumeScalingFactor float A scaling factor between 0.01 (1%) and 1.0 (100%) applied to compute the volume level. When set, this factor applies to each logical player. Only the primary player accepts this value. For example, the left speaker in a bonded pair or the main home theater speaker, such as the Playbar, in a 5.1 surround set.
monoMode Boolean When true, enables mono mode on supported devices. The Sonos Amp supports this setting when it is not powering surrounds as part of a home theater setup.
wifiDisable Boolean When true, disables the wireless radio for the device if it detects a valid Ethernet carrier.