engineer.nightowl.sonos.api.resource

Class PlaybackResource

java.lang.Object

engineer.nightowl.sonos.api.resource.PlaybackResource

All Implemented Interfaces:

Subscribable

public class PlaybackResource
extends Object
implements Subscribable

Control playback of groups in a household - play, pause, seek etc.

See Also:

Sonos docs

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SonosPlaybackStatus	getPlaybackStatus(String clientToken, String groupId) Get playback status for the specified group
SonosSuccess	loadLineIn(String clientToken, String groupId, String deviceId, Boolean playOnCompletion) Set a device in a group to use the line-in source.
SonosSuccess	pause(String clientToken, String groupId) Set a group to 'pause' (not a toggle, see togglePlayPause(String, String)
SonosSuccess	play(String clientToken, String groupId) Set a group to 'play' (not a toggle, see togglePlayPause(String, String)
SonosSuccess	seek(String clientToken, String groupId, String itemId, Integer positionMillis) Go to a specific point in a track
SonosSuccess	seekRelative(String clientToken, String groupId, String itemId, Integer deltaMillis) Seek to a relative position in a track.
SonosSuccess	setPlayModes(String clientToken, String groupId, SonosPlayMode playMode) Set playback options for a group (e.g.
SonosSuccess	skipToNextTrack(String clientToken, String groupId) Skip to the next track
SonosSuccess	skipToPreviousTrack(String clientToken, String groupId) Skip to the previous track
SonosSuccess	subscribe(String clientToken, String groupId) Subscribe to events for this resource.
SonosSuccess	togglePlayPause(String clientToken, String groupId) Toggle the play/pause state of a group
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

PlaybackResource

public PlaybackResource(SonosApiClient apiClient)

Constructor for PlaybackResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

getPlaybackStatus

public SonosPlaybackStatus getPlaybackStatus(String clientToken,
                                             String groupId)
                                      throws SonosApiClientException,
                                             SonosApiError

Get playback status for the specified group

Parameters:

clientToken - for the user

groupId - for the group you want to fetch the status for

Returns:

the favorites 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

loadLineIn

public SonosSuccess loadLineIn(String clientToken,
                               String groupId,
                               String deviceId,
                               Boolean playOnCompletion)
                        throws SonosApiClientException,
                               SonosApiError

Set a device in a group to use the line-in source.

Parameters:

clientToken - for the user

groupId - for the group the device belongs to

deviceId - of the device with a line-in source connected

playOnCompletion - whether to start or continue playback once switched to line-in (if not provided, false)

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

play

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

Set a group to 'play' (not a toggle, see togglePlayPause(String, String)

Parameters:

clientToken - for the user

groupId - to play

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

pause

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

Set a group to 'pause' (not a toggle, see togglePlayPause(String, String)

Parameters:

clientToken - for the user

groupId - to pause

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

seek

public SonosSuccess seek(String clientToken,
                         String groupId,
                         String itemId,
                         Integer positionMillis)
                  throws SonosApiClientException,
                         SonosApiError

Go to a specific point in a track

Parameters:

clientToken - for the user

groupId - of the group to seek

itemId - which should be targeted for the seek (optional - to ensure the right item is targeted)

positionMillis - to seek 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

See Also:

Sonos docs

seekRelative

public SonosSuccess seekRelative(String clientToken,
                                 String groupId,
                                 String itemId,
                                 Integer deltaMillis)
                          throws SonosApiClientException,
                                 SonosApiError

Seek to a relative position in a track. See seek(String, String, String, Integer)

Parameters:

clientToken - for the user

groupId - of the group to seek

itemId - to (optionally) target the seek

deltaMillis - to seek by

Returns:

if 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

setPlayModes

public SonosSuccess setPlayModes(String clientToken,
                                 String groupId,
                                 SonosPlayMode playMode)
                          throws SonosApiClientException,
                                 SonosApiError

Set playback options for a group (e.g. repeat, crossfade etc)

Parameters:

clientToken - for the user

groupId - to set play mods for

playMode - a SonosPlayMode object containing partial or full settings

Returns:

if the call was successful

Throws:

SonosApiClientException - if an error occurs during the call.

SonosApiError - if there is an error from the API.

See Also:

SonosPlayMode, Sonos docs

skipToNextTrack

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

Skip to the next track

Parameters:

clientToken - for the user

groupId - to skip within

Returns:

if 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

skipToPreviousTrack

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

Skip to the previous track

Parameters:

clientToken - for the user

groupId - to skip within

Returns:

if 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.

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

togglePlayPause

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

Toggle the play/pause state of a group

Parameters:

clientToken - for the user

groupId - to play/pause

Returns:

if 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, play(String, String), pause(String, String)

unsubscribe

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

Unsubscribe from events related to this resource.

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