Support new resource for 'player' settings - e.g. volume mode, scaling factor, mono, and wifi disabling

Author: nightowlengineer

src/main/java/engineer/nightowl/sonos/api/domain/SonosPlayerSettings.java

@@ -0,0 +1,104 @@
+package engineer.nightowl.sonos.api.domain;
+
+import engineer.nightowl.sonos.api.enums.SonosVolumeMode;
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+
+public class SonosPlayerSettings
+{
+    private SonosVolumeMode volumeMode;
+    private Float volumeScalingFactor;
+    private Boolean monoMode;
+    private Boolean wifiDisable;
+
+    public SonosPlayerSettings()
+    {
+    }
+
+    public SonosPlayerSettings(SonosVolumeMode volumeMode, Float volumeScalingFactor, Boolean monoMode, Boolean wifiDisable)
+    {
+        this.volumeMode = volumeMode;
+        this.volumeScalingFactor = volumeScalingFactor;
+        this.monoMode = monoMode;
+        this.wifiDisable = wifiDisable;
+    }
+
+    public SonosVolumeMode getVolumeMode()
+    {
+        return volumeMode;
+    }
+
+    public void setVolumeMode(SonosVolumeMode volumeMode)
+    {
+        this.volumeMode = volumeMode;
+    }
+
+    public Float getVolumeScalingFactor()
+    {
+        return volumeScalingFactor;
+    }
+
+    public void setVolumeScalingFactor(Float volumeScalingFactor)
+    {
+        this.volumeScalingFactor = volumeScalingFactor;
+    }
+
+    public Boolean getMonoMode()
+    {
+        return monoMode;
+    }
+
+    public void setMonoMode(Boolean monoMode)
+    {
+        this.monoMode = monoMode;
+    }
+
+    public Boolean getWifiDisable()
+    {
+        return wifiDisable;
+    }
+
+    public void setWifiDisable(Boolean wifiDisable)
+    {
+        this.wifiDisable = wifiDisable;
+    }
+
+    @Override
+    public String toString()
+    {
+        return "SonosPlayerSettings{" +
+                "volumeMode=" + volumeMode +
+                ", volumeScalingFactor=" + volumeScalingFactor +
+                ", monoMode=" + monoMode +
+                ", wifiDisable=" + wifiDisable +
+                '}';
+    }
+
+    @Override
+    public boolean equals(Object o)
+    {
+        if (this == o) return true;
+
+        if (o == null || getClass() != o.getClass()) return false;
+
+        SonosPlayerSettings that = (SonosPlayerSettings) o;
+
+        return new EqualsBuilder()
+                .append(volumeMode, that.volumeMode)
+                .append(volumeScalingFactor, that.volumeScalingFactor)
+                .append(monoMode, that.monoMode)
+                .append(wifiDisable, that.wifiDisable)
+                .isEquals();
+    }
+
+    @Override
+    public int hashCode()
+    {
+        return new HashCodeBuilder(17, 37)
+                .append(volumeMode)
+                .append(volumeScalingFactor)
+                .append(monoMode)
+                .append(wifiDisable)
+                .toHashCode();
+    }
+}

src/main/java/engineer/nightowl/sonos/api/enums/SonosVolumeMode.java

@@ -0,0 +1,8 @@
+package engineer.nightowl.sonos.api.enums;
+
+public enum SonosVolumeMode
+{
+    VARIABLE,
+    FIXED,
+    PASS_THROUGH
+}

src/main/java/engineer/nightowl/sonos/api/resource/SettingsResource.java

@@ -0,0 +1,51 @@
+package engineer.nightowl.sonos.api.resource;
+
+import engineer.nightowl.sonos.api.SonosApiClient;
+import engineer.nightowl.sonos.api.domain.SonosPlayerSettings;
+import engineer.nightowl.sonos.api.domain.SonosSuccess;
+import engineer.nightowl.sonos.api.exception.SonosApiClientException;
+import engineer.nightowl.sonos.api.exception.SonosApiError;
+
+public class SettingsResource extends BaseResource
+{
+    /**
+     * <p>Constructor for SettingsResource.</p>
+     *
+     * @param apiClient a {@link engineer.nightowl.sonos.api.SonosApiClient} object.
+     */
+    public SettingsResource(final SonosApiClient apiClient)
+    {
+        super(apiClient);
+    }
+
+    /**
+     * Get a player's settings
+     *
+     * @see <a href="https://developer.sonos.com/reference/control-api/settings/getplayersettings/">Sonos docs</a>
+     * @param clientToken for the user
+     * @param playerId to fetch settings for
+     * @return SonosPlayerSettings for the specified player
+     * @throws engineer.nightowl.sonos.api.exception.SonosApiClientException if an error occurs during the call.
+     * @throws engineer.nightowl.sonos.api.exception.SonosApiError if there is an error from the API
+     */
+    public SonosPlayerSettings getSettings(final String clientToken, final String playerId) throws SonosApiClientException, SonosApiError
+    {
+        return getFromApi(SonosPlayerSettings.class, clientToken, String.format("/v1/players/%s/settings/player", playerId));
+    }
+
+    /**
+     * Set settings for a specified player
+     *
+     * @see <a href="https://developer.sonos.com/reference/control-api/settings/setplayersettings/">Sonos docs</a>
+     * @param clientToken  for the user
+     * @param playerId     to set the options for
+     * @param sonosPlayerSettings configured {@link engineer.nightowl.sonos.api.domain.SonosPlayerSettings}
+     * @return if successful
+     * @throws engineer.nightowl.sonos.api.exception.SonosApiClientException if an error occurs during the call
+     * @throws engineer.nightowl.sonos.api.exception.SonosApiError if there is an error from the API
+     */
+    public SonosSuccess setSettings(final String clientToken, final String playerId, final SonosPlayerSettings sonosPlayerSettings) throws SonosApiClientException, SonosApiError
+    {
+        return postToApi(SonosSuccess.class, clientToken, String.format("/v1/players/%s/settings/player", playerId), sonosPlayerSettings);
+    }
+}