| Package | Description |
|---|---|
| engineer.nightowl.sonos.api.domain | |
| engineer.nightowl.sonos.api.resource | |
| engineer.nightowl.sonos.api.specs |
| Modifier and Type | Method and Description |
|---|---|
void |
SonosSessionRequest.validate()
Hook to validate an object
|
void |
SonosMusicServiceAccountMatchRequest.validate()
Hook to validate an object
|
| Modifier and Type | Method and Description |
|---|---|
SonosGroupInfo |
GroupResource.createGroup(String clientToken,
String householdId,
List<String> playerIds,
String musicContextGroupId)
Join players together into a group, optionally with an existing audio stream
|
SonosPlaybackSessionStatus |
PlaybackSessionResource.createSession(String clientToken,
String groupId,
SonosSessionRequest request)
Create a new playback session (removing any existing playback session)
|
SonosToken |
AuthorizeResource.createToken(String redirectUri,
String authorizeCode)
Generate a token from an authorization code (see getAuthorizeCode methods in the same class)
|
SonosFavoriteList |
FavoriteResource.getFavorites(String clientToken,
String householdId)
Get favorites for the specified household
|
SonosGroups |
GroupResource.getGroups(String clientToken,
String householdId)
Get a list of
SonosGroup and SonosPlayer |
SonosHouseholdList |
HouseholdResource.getHouseholds(String clientToken)
Get a user's households.
|
SonosPlaybackStatus |
PlaybackResource.getPlaybackStatus(String clientToken,
String groupId)
Get playback status for the specified group
|
SonosPlayerVolume |
PlayerVolumeResource.getVolume(String clientToken,
String playerId)
Get the volume properties for the specified player
|
SonosGroupVolume |
GroupVolumeResource.getVolume(String clientToken,
String groupId)
Get the volume properties for the specified group
|
SonosPlaybackSessionStatus |
PlaybackSessionResource.joinOrCreateSession(String clientToken,
String groupId,
SonosSessionRequest request)
Join an existing session, or create a new one if there is no existing session
|
SonosPlaybackSessionStatus |
PlaybackSessionResource.joinSession(String clientToken,
String groupId,
SonosSessionRequest request)
Join an existing playback session
|
SonosSuccess |
PlaybackSessionResource.loadCloudQueue(String clientToken,
String sessionId,
SonosCloudQueueRequest request)
Load a cloud queue into a playback session (see docs)
|
SonosSuccess |
FavoriteResource.loadFavorite(String clientToken,
String groupId,
String favoriteId,
Boolean playOnCompletion,
SonosPlayMode playMode)
Activate a favorite in a group
|
SonosSuccess |
HomeTheaterResource.loadHomeTheater(String clientToken,
String playerId)
Set the specified player to use its optical or HDMI input.
|
SonosSuccess |
PlaybackResource.loadLineIn(String clientToken,
String groupId,
String deviceId,
Boolean playOnCompletion)
Set a device in a group to use the line-in source.
|
SonosSuccess |
PlaybackSessionResource.loadStreamUrl(String clientToken,
String sessionId,
SonosStreamUrlRequest request)
Load a URL as a playback session (see docs)
|
SonosMusicServiceAccount |
MusicServiceAccountsResource.match(String clientToken,
String householdId,
SonosMusicServiceAccountMatchRequest request)
Match a music service account using provided information.
|
SonosGroupInfo |
GroupResource.modifyGroupMembers(String clientToken,
String groupId,
List<String> playerIdsToAdd,
List<String> playerIdsToRemove)
Modify an existing group of players
|
SonosSuccess |
PlaybackResource.pause(String clientToken,
String groupId)
Set a group to 'pause' (not a toggle, see
PlaybackResource.togglePlayPause(String, String) |
SonosSuccess |
PlaybackResource.play(String clientToken,
String groupId)
Set a group to 'play' (not a toggle, see
PlaybackResource.togglePlayPause(String, String) |
SonosSuccess |
PlaybackSessionResource.refreshCloudQueue(String clientToken,
String sessionId)
Trigger a re-fetch of items from the cloud queue server
|
SonosToken |
AuthorizeResource.refreshToken(String refreshToken)
Generate a token from a previously issued refresh token
|
SonosSuccess |
PlaybackResource.seek(String clientToken,
String groupId,
String itemId,
Integer positionMillis)
Go to a specific point in a track
|
SonosSuccess |
PlaybackSessionResource.seek(String clientToken,
String sessionId,
String itemId,
String positionMillis)
Seek within a track
|
SonosSuccess |
PlaybackResource.seekRelative(String clientToken,
String groupId,
String itemId,
Integer deltaMillis)
Seek to a relative position in a track.
|
SonosSuccess |
PlaybackSessionResource.seekRelative(String clientToken,
String sessionId,
String itemId,
String deltaMillis)
Seek by a relative amount (optionally target a specific track)
|
SonosGroupInfo |
GroupResource.setGroupMembers(String clientToken,
String groupId,
List<String> playerIds)
Provide a list of player IDs to set in an existing group
|
SonosSuccess |
PlayerVolumeResource.setMute(String clientToken,
String playerId,
Boolean isMuted)
Set the mute status of a player (not a toggle)
|
SonosSuccess |
GroupVolumeResource.setMute(String clientToken,
String groupId,
Boolean isMuted)
Set the mute status of a group (not a toggle)
|
SonosSuccess |
PlaybackResource.setPlayModes(String clientToken,
String groupId,
SonosPlayMode playMode)
Set playback options for a group (e.g.
|
SonosSuccess |
GroupVolumeResource.setRelativeVolume(String clientToken,
String groupId,
Integer volumeDelta)
Adjust the volume of a group by the specified amount
|
SonosSuccess |
PlayerVolumeResource.setRelativeVolume(String clientToken,
String playerId,
Integer volumeDelta,
Boolean isMuted)
Adjust the volume of a player by the specified amount
|
SonosSuccess |
HomeTheaterResource.setTvPowerState(String clientToken,
String playerId,
SonosTvPowerState tvPowerState)
Instruct the specified player to set the attached device to the specified power state using HDMI.
|
SonosSuccess |
GroupVolumeResource.setVolume(String clientToken,
String groupId,
Integer volume)
Set a specific volume for a group
Sonos docs
|
SonosSuccess |
PlayerVolumeResource.setVolume(String clientToken,
String playerId,
Integer volume,
Boolean isMuted)
Set a specific volume for a player
|
SonosSuccess |
PlaybackSessionResource.skipToItem(String clientToken,
String sessionId,
SonosSessionRequest request)
Skip to a specific item
|
SonosSuccess |
PlaybackResource.skipToNextTrack(String clientToken,
String groupId)
Skip to the next track
|
SonosSuccess |
PlaybackResource.skipToPreviousTrack(String clientToken,
String groupId)
Skip to the previous track
|
SonosSuccess |
PlayerVolumeResource.subscribe(String clientToken,
String playerId)
Subscribe to events for this resource.
|
SonosSuccess |
PlaybackSessionResource.subscribe(String clientToken,
String sessionId)
Subscribe to events for this resource.
|
SonosSuccess |
PlaybackResource.subscribe(String clientToken,
String groupId)
Subscribe to events for this resource.
|
SonosSuccess |
PlaybackMetadataResource.subscribe(String clientToken,
String groupId)
Subscribe to events for this resource.
|
SonosSuccess |
GroupVolumeResource.subscribe(String clientToken,
String groupId)
Subscribe to events for this resource.
|
SonosSuccess |
GroupResource.subscribe(String clientToken,
String householdId)
Subscribe to events for this resource.
|
SonosSuccess |
FavoriteResource.subscribe(String clientToken,
String householdId)
Subscribe to events for this resource.
|
SonosSuccess |
PlaybackSessionResource.suspend(String clientToken,
String sessionId,
String queueVersion)
Suspend a named session (feature appears to still be in development)
|
SonosSuccess |
PlaybackResource.togglePlayPause(String clientToken,
String groupId)
Toggle the play/pause state of a group
|
SonosSuccess |
PlayerVolumeResource.unsubscribe(String clientToken,
String playerId)
Unsubscribe from events related to this resource.
|
SonosSuccess |
PlaybackSessionResource.unsubscribe(String clientToken,
String sessionId)
Unsubscribe from events related to this resource.
|
SonosSuccess |
PlaybackResource.unsubscribe(String clientToken,
String groupId)
Unsubscribe from events related to this resource.
|
SonosSuccess |
PlaybackMetadataResource.unsubscribe(String clientToken,
String groupId)
Unsubscribe from events related to this resource.
|
SonosSuccess |
GroupVolumeResource.unsubscribe(String clientToken,
String groupId)
Unsubscribe from events related to this resource.
|
SonosSuccess |
GroupResource.unsubscribe(String clientToken,
String householdId)
Unsubscribe from events related to this resource.
|
SonosSuccess |
FavoriteResource.unsubscribe(String clientToken,
String householdId)
Unsubscribe from events related to this resource.
|
| Modifier and Type | Method and Description |
|---|---|
SonosSuccess |
Subscribable.subscribe(String clientToken,
String resourceId)
Subscribe to events for this resource.
|
SonosSuccess |
Subscribable.unsubscribe(String clientToken,
String resourceId)
Unsubscribe from events related to this resource.
|
void |
Validatable.validate()
Hook to validate an object
|
Copyright © 2018. All rights reserved.