engineer.nightowl.sonos.api.resource

Class GroupResource

java.lang.Object

engineer.nightowl.sonos.api.resource.GroupResource

All Implemented Interfaces:

Subscribable

public class GroupResource
extends Object
implements Subscribable

Get information about players and their groupings

See Also:

Sonos docs, SonosGroup, SonosGroups

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SonosGroupInfo	createGroup(String clientToken, String householdId, List<String> playerIds, String musicContextGroupId) Join players together into a group, optionally with an existing audio stream
SonosGroups	getGroups(String clientToken, String householdId) Get a list of SonosGroup and SonosPlayer
SonosGroupInfo	modifyGroupMembers(String clientToken, String groupId, List<String> playerIdsToAdd, List<String> playerIdsToRemove) Modify an existing group of players
SonosGroupInfo	setGroupMembers(String clientToken, String groupId, List<String> playerIds) Provide a list of player IDs to set in an existing group
SonosSuccess	subscribe(String clientToken, String householdId) Subscribe to events for this resource.
SonosSuccess	unsubscribe(String clientToken, String householdId) 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

GroupResource

public GroupResource(SonosApiClient apiClient)

Constructor for GroupResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

getGroups

public SonosGroups getGroups(String clientToken,
                             String householdId)
                      throws SonosApiClientException,
                             SonosApiError

Get a list of SonosGroup and SonosPlayer

Parameters:

clientToken - for the user

householdId - for the household you want to fetch groups and players

Returns:

the groups and players for the specified household

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

See Also:

Sonos docs

createGroup

public SonosGroupInfo createGroup(String clientToken,
                                  String householdId,
                                  List<String> playerIds,
                                  String musicContextGroupId)
                           throws SonosApiClientException,
                                  SonosApiError

Join players together into a group, optionally with an existing audio stream

Parameters:

clientToken - for the user

householdId - for the household you want to fetch groups and players

playerIds - that you want to join together

musicContextGroupId - if you want to start/continue playing an audio stream

Returns:

information about the newly created group as a SonosGroupInfo object

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

See Also:

Sonos docs

modifyGroupMembers

public SonosGroupInfo modifyGroupMembers(String clientToken,
                                         String groupId,
                                         List<String> playerIdsToAdd,
                                         List<String> playerIdsToRemove)
                                  throws SonosApiClientException,
                                         SonosApiError

Modify an existing group of players

Parameters:

clientToken - for the user

groupId - to modify

playerIdsToAdd - list of player IDs to add to the group (optional)

playerIdsToRemove - list of player IDs to remove from the group (optional)

Returns:

updated group information once the operation completes

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

See Also:

Sonos docs

setGroupMembers

public SonosGroupInfo setGroupMembers(String clientToken,
                                      String groupId,
                                      List<String> playerIds)
                               throws SonosApiClientException,
                                      SonosApiError

Provide a list of player IDs to set in an existing group

Parameters:

clientToken - for the user

groupId - to modify

playerIds - to be set as the players in this group

Returns:

updated group information once the operation completes

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

Subscribe to events for this resource.

Subscribe to group events in a specified household

Specified by:

subscribe in interface Subscribable

Parameters:

clientToken - for the user

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

Unsubscribe from events related to this resource.

Unsubscribe from group events in a specified household

Specified by:

unsubscribe in interface Subscribable

Parameters:

clientToken - for the user

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