engineer.nightowl.sonos.api.resource

Class PlaybackSessionResource

java.lang.Object

engineer.nightowl.sonos.api.resource.PlaybackSessionResource

All Implemented Interfaces:

Subscribable

public class PlaybackSessionResource
extends Object
implements Subscribable

PlaybackSessionResource class.

See Also:

Sonos docs

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SonosPlaybackSessionStatus	createSession(String clientToken, String groupId, SonosSessionRequest request) Create a new playback session (removing any existing playback session)
SonosPlaybackSessionStatus	joinOrCreateSession(String clientToken, String groupId, SonosSessionRequest request) Join an existing session, or create a new one if there is no existing session
SonosPlaybackSessionStatus	joinSession(String clientToken, String groupId, SonosSessionRequest request) Join an existing playback session
SonosSuccess	loadCloudQueue(String clientToken, String sessionId, SonosCloudQueueRequest request) Load a cloud queue into a playback session (see docs)
SonosSuccess	loadStreamUrl(String clientToken, String sessionId, SonosStreamUrlRequest request) Load a URL as a playback session (see docs)
SonosSuccess	refreshCloudQueue(String clientToken, String sessionId) Trigger a re-fetch of items from the cloud queue server
SonosSuccess	seek(String clientToken, String sessionId, String itemId, String positionMillis) Seek within a track
SonosSuccess	seekRelative(String clientToken, String sessionId, String itemId, String deltaMillis) Seek by a relative amount (optionally target a specific track)
SonosSuccess	skipToItem(String clientToken, String sessionId, SonosSessionRequest request) Skip to a specific item
SonosSuccess	subscribe(String clientToken, String sessionId) Subscribe to events for this resource.
SonosSuccess	suspend(String clientToken, String sessionId, String queueVersion) Suspend a named session (feature appears to still be in development)
SonosSuccess	unsubscribe(String clientToken, String sessionId) 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

PlaybackSessionResource

public PlaybackSessionResource(SonosApiClient apiClient)

Constructor for PlaybackSessionResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

createSession

public SonosPlaybackSessionStatus createSession(String clientToken,
                                                String groupId,
                                                SonosSessionRequest request)
                                         throws SonosApiClientException,
                                                SonosApiError

Create a new playback session (removing any existing playback session)

Parameters:

clientToken - for the user

groupId - to create the session in

request - a SonosSessionRequest object.

Returns:

a SonosPlaybackSessionStatus object.

Throws:

SonosApiClientException - if an error occurs during the call.

SonosApiError - if there is an error from the API.

See Also:

Sonos docs, SonosSessionRequest, joinOrCreateSession(String, String, SonosSessionRequest)

joinSession

public SonosPlaybackSessionStatus joinSession(String clientToken,
                                              String groupId,
                                              SonosSessionRequest request)
                                       throws SonosApiClientException,
                                              SonosApiError

Join an existing playback session

Parameters:

clientToken - for the user

groupId - to join the session in

request - of the session you're joining - appId and appContext

Returns:

a SonosPlaybackSessionStatus object.

Throws:

SonosApiClientException - if an error occurs during the call.

SonosApiError - if there is an error from the API.

See Also:

Sonos docs, createSession(String, String, SonosSessionRequest), joinOrCreateSession(String, String, SonosSessionRequest)

joinOrCreateSession

public SonosPlaybackSessionStatus joinOrCreateSession(String clientToken,
                                                      String groupId,
                                                      SonosSessionRequest request)
                                               throws SonosApiClientException,
                                                      SonosApiError

Join an existing session, or create a new one if there is no existing session

Parameters:

clientToken - for the user

groupId - a String object.

request - a SonosSessionRequest object.

Returns:

a SonosPlaybackSessionStatus object.

Throws:

SonosApiClientException - if an error occurs during the call.

SonosApiError - if there is an error from the API.

See Also:

Sonos docs, createSession(String, String, SonosSessionRequest), joinSession(String, String, SonosSessionRequest)

loadCloudQueue

public SonosSuccess loadCloudQueue(String clientToken,
                                   String sessionId,
                                   SonosCloudQueueRequest request)
                            throws SonosApiClientException,
                                   SonosApiError

Load a cloud queue into a playback session (see docs)

Parameters:

clientToken - for the user

sessionId - a String object.

request - a SonosCloudQueueRequest object.

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

loadStreamUrl

public SonosSuccess loadStreamUrl(String clientToken,
                                  String sessionId,
                                  SonosStreamUrlRequest request)
                           throws SonosApiClientException,
                                  SonosApiError

Load a URL as a playback session (see docs)

Parameters:

clientToken - for the user

sessionId - a String object.

request - a SonosStreamUrlRequest object.

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

refreshCloudQueue

public SonosSuccess refreshCloudQueue(String clientToken,
                                      String sessionId)
                               throws SonosApiClientException,
                                      SonosApiError

Trigger a re-fetch of items from the cloud queue server

Parameters:

clientToken - for the user

sessionId - a String object.

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

skipToItem

public SonosSuccess skipToItem(String clientToken,
                               String sessionId,
                               SonosSessionRequest request)
                        throws SonosApiClientException,
                               SonosApiError

Skip to a specific item

Parameters:

clientToken - for the user

sessionId - a String object.

request - a SonosSessionRequest object.

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

seek

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

Seek within a track

Parameters:

clientToken - for the user

sessionId - a String object.

itemId - a String object.

positionMillis - a String object.

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

seekRelative

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

Seek by a relative amount (optionally target a specific track)

Parameters:

clientToken - for the user

sessionId - a String object.

itemId - a String object.

deltaMillis - a String object.

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

Subscribe to events for this resource.

Specified by:

subscribe in interface Subscribable

Parameters:

clientToken - for the user

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

suspend

public SonosSuccess suspend(String clientToken,
                            String sessionId,
                            String queueVersion)
                     throws SonosApiClientException,
                            SonosApiError

Suspend a named session (feature appears to still be in development)

Parameters:

clientToken - for the user

sessionId - a String object.

queueVersion - a String object.

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

unsubscribe

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

Unsubscribe from events related to this resource.

Specified by:

unsubscribe in interface Subscribable

Parameters:

clientToken - for the user

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