engineer.nightowl.sonos.api

Class SonosApiClient

java.lang.Object

engineer.nightowl.sonos.api.SonosApiClient

public class SonosApiClient
extends Object

Constructor Summary

Constructors

Constructor and Description
SonosApiClient(SonosApiConfiguration configuration) Main client for Sonos API.

Method Summary

Modifier and Type	Method and Description
AuthorizeResource	authorize() Authorization methods to connect a user with the Sonos API.
void	closeHttpClient() Close the HTTP client.
FavoriteResource	favorite() Manage a household's favorites.
SonosApiConfiguration	getConfiguration() Get the configured options for this client.
org.apache.http.impl.client.CloseableHttpClient	getHttpClient() Get the configured HTTP client for this API client instance.
GroupResource	group() Manage a household's groups.
GroupVolumeResource	groupVolumeResource() Manage the volume of a group
HomeTheaterResource	homeTheater() Manage home theater features
HouseholdResource	household() Manage a user's household(s)
MusicServiceAccountsResource	musicServiceAccounts() Match music service accounts
PlaybackResource	playback() Manage the playback of the system.
PlaybackMetadataResource	playbackMetadata() Subscribe/unsubscribe to playback events
PlaybackSessionResource	playbackSession() Manage playback sessions.
PlayerVolumeResource	playerVolume() Manage player volume.
void	setConfiguration(SonosApiConfiguration configuration) Set a new SonosApiConfiguration.
void	setHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient) Set a custom HTTP client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SonosApiClient

public SonosApiClient(SonosApiConfiguration configuration)

Main client for Sonos API.

Parameters:

configuration - - a SonosApiConfiguration containing integration information such as API keys

Method Detail

closeHttpClient

public void closeHttpClient()

Close the HTTP client.

getHttpClient

public org.apache.http.impl.client.CloseableHttpClient getHttpClient()

Get the configured HTTP client for this API client instance.

Returns:

the configured HTTP client

setHttpClient

public void setHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)

Set a custom HTTP client.

Parameters:

httpClient - custom client to set

getConfiguration

public SonosApiConfiguration getConfiguration()

Get the configured options for this client.

Returns:

the SonosApiConfiguration for this client

setConfiguration

public void setConfiguration(SonosApiConfiguration configuration)

Set a new SonosApiConfiguration.

Parameters:

configuration - - the new SonosApiConfiguration

authorize

public AuthorizeResource authorize()

Authorization methods to connect a user with the Sonos API.

Returns:

the AuthorizationResource

favorite

public FavoriteResource favorite()

Manage a household's favorites.

Returns:

the FavoriteResource

group

public GroupResource group()

Manage a household's groups.

Returns:

the GroupResource

groupVolumeResource

public GroupVolumeResource groupVolumeResource()

Manage the volume of a group

Returns:

the GroupVolumeResource

homeTheater

public HomeTheaterResource homeTheater()

Manage home theater features

Returns:

the HomeTheaterResource

household

public HouseholdResource household()

Manage a user's household(s)

Returns:

the HouseholdResource

musicServiceAccounts

public MusicServiceAccountsResource musicServiceAccounts()

Match music service accounts

Returns:

the MusicServiceAccountsResource

playbackMetadata

public PlaybackMetadataResource playbackMetadata()

Subscribe/unsubscribe to playback events

Returns:

the PlaybackMetadataResource

playback

public PlaybackResource playback()

Manage the playback of the system.

Returns:

the PlaybackResource

playbackSession

public PlaybackSessionResource playbackSession()

Manage playback sessions.

Returns:

the PlaybackSessionResource

playerVolume

public PlayerVolumeResource playerVolume()

Manage player volume.

Returns:

the PlayerVolumeResource