engineer.nightowl.sonos.api.resource

Class PlaybackMetadataResource

java.lang.Object

engineer.nightowl.sonos.api.resource.PlaybackMetadataResource

All Implemented Interfaces:

Subscribable

public class PlaybackMetadataResource
extends Object
implements Subscribable

PlaybackMetadataResource class.

See Also:

Sonos docs

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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

PlaybackMetadataResource

public PlaybackMetadataResource(SonosApiClient apiClient)

Constructor for PlaybackMetadataResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

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

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