engineer.nightowl.sonos.api.resource

Class GroupVolumeResource

java.lang.Object

engineer.nightowl.sonos.api.resource.GroupVolumeResource

All Implemented Interfaces:

Subscribable

public class GroupVolumeResource
extends Object
implements Subscribable

Manage the volume of groups in a household

See Also:

Sonos docs

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SonosGroupVolume	getVolume(String clientToken, String groupId) Get the volume properties for the specified group
SonosSuccess	setMute(String clientToken, String groupId, Boolean isMuted) Set the mute status of a group (not a toggle)
SonosSuccess	setRelativeVolume(String clientToken, String groupId, Integer volumeDelta) Adjust the volume of a group by the specified amount
SonosSuccess	setVolume(String clientToken, String groupId, Integer volume) Set a specific volume for a group Sonos docs
SonosSuccess	subscribe(String clientToken, String groupId) Subscribe to events for this resource.
SonosSuccess	unsubscribe(String clientToken, String groupId) 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

GroupVolumeResource

public GroupVolumeResource(SonosApiClient apiClient)

Constructor for GroupVolumeResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

getVolume

public SonosGroupVolume getVolume(String clientToken,
                                  String groupId)
                           throws SonosApiClientException,
                                  SonosApiError

Get the volume properties for the specified group

Parameters:

clientToken - for the user

groupId - to fetch the volume properties for

Returns:

SonosGroupVolume for the specified SonosGroup

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 groupId,
                              Integer volume)
                       throws SonosApiClientException,
                              SonosApiError

Set a specific volume for a group Sonos docs

Parameters:

clientToken - for the user

groupId - to modify the volume of

volume - to set the group 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

setRelativeVolume

public SonosSuccess setRelativeVolume(String clientToken,
                                      String groupId,
                                      Integer volumeDelta)
                               throws SonosApiClientException,
                                      SonosApiError

Adjust the volume of a group by the specified amount

Parameters:

clientToken - for the user

groupId - to set the volume for

volumeDelta - to adjust the volume by

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

setMute

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

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

Parameters:

clientToken - for the user

groupId - of the group to mute/unmute

isMuted - whether the group 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

subscribe

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

Subscribe to events for this resource.

Subscribe to volume events for a group

Specified by:

subscribe in interface Subscribable

Parameters:

clientToken - for the user

groupId - 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 groupId)
                         throws SonosApiClientException,
                                SonosApiError

Unsubscribe from events related to this resource.

Unsubscribe from volume events for a group

Specified by:

unsubscribe in interface Subscribable

Parameters:

clientToken - for the user

groupId - 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