engineer.nightowl.sonos.api.resource

Class PlayerVolumeResource

java.lang.Object

engineer.nightowl.sonos.api.resource.PlayerVolumeResource

All Implemented Interfaces:

Subscribable

public class PlayerVolumeResource
extends Object
implements Subscribable

Control player volume state

See Also:

Sonos docs

Constructor Summary

Constructors

Constructor and Description
PlayerVolumeResource(SonosApiClient apiClient) Constructor for PlayerVolumeResource.

Method Summary

Modifier and Type	Method and Description
SonosPlayerVolume	getVolume(String clientToken, String playerId) Get the volume properties for the specified player
SonosSuccess	setMute(String clientToken, String playerId, Boolean isMuted) Set the mute status of a player (not a toggle)
SonosSuccess	setRelativeVolume(String clientToken, String playerId, Integer volumeDelta, Boolean isMuted) Adjust the volume of a player by the specified amount
SonosSuccess	setVolume(String clientToken, String playerId, Integer volume, Boolean isMuted) Set a specific volume for a player
SonosSuccess	subscribe(String clientToken, String playerId) Subscribe to events for this resource.
SonosSuccess	unsubscribe(String clientToken, String playerId) Unsubscribe from events related to this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlayerVolumeResource

public PlayerVolumeResource(SonosApiClient apiClient)

Constructor for PlayerVolumeResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

getVolume

public SonosPlayerVolume getVolume(String clientToken,
                                   String playerId)
                            throws SonosApiClientException,
                                   SonosApiError

Get the volume properties for the specified player

Parameters:

clientToken - for the user

playerId - to fetch the volume properties for

Returns:

SonosPlayerVolume for the specified SonosPlayer

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API.

See Also:

Sonos docs

setMute

public SonosSuccess setMute(String clientToken,
                            String playerId,
                            Boolean isMuted)
                     throws SonosApiClientException,
                            SonosApiError

Set the mute status of a player (not a toggle)

Parameters:

clientToken - for the user

playerId - of the player to mute/unmute

isMuted - whether the player should be muted/unmuted

Returns:

whether the call was successful

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

See Also:

Sonos docs

setRelativeVolume

public SonosSuccess setRelativeVolume(String clientToken,
                                      String playerId,
                                      Integer volumeDelta,
                                      Boolean isMuted)
                               throws SonosApiClientException,
                                      SonosApiError

Adjust the volume of a player by the specified amount

Parameters:

clientToken - for the user

playerId - to set the volume for

volumeDelta - to adjust the volume by

isMuted - if the player should be muted

Returns:

whether the call was successful

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

See Also:

Sonos docs

setVolume

public SonosSuccess setVolume(String clientToken,
                              String playerId,
                              Integer volume,
                              Boolean isMuted)
                       throws SonosApiClientException,
                              SonosApiError

Set a specific volume for a player

Parameters:

clientToken - for the user

playerId - to modify the volume of

volume - to set the player to

isMuted - if the player should be muted

Returns:

whether the call was successful

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

See Also:

Sonos docs

subscribe

public SonosSuccess subscribe(String clientToken,
                              String playerId)
                       throws SonosApiClientException,
                              SonosApiError

Subscribe to events for this resource.

Subscribe to volume events for a player

Specified by:

subscribe in interface Subscribable

Parameters:

clientToken - for the user

playerId - of the resource to subscribe to

Returns:

whether the call was successful

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

unsubscribe

public SonosSuccess unsubscribe(String clientToken,
                                String playerId)
                         throws SonosApiClientException,
                                SonosApiError

Unsubscribe from events related to this resource.

Unsubscribe from volume events for a player

Specified by:

unsubscribe in interface Subscribable

Parameters:

clientToken - for the user

playerId - of the resource to unsubscribe from

Returns:

whether the call was successful

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API