Documentation

Application

Table of Contents

Interfaces

Exception
Custom exception for this library.
AlarmInterface
Provides an interface for managing the alarms on the network.
ControllerInterface
Allows interaction with the groups of speakers.
ControllerStateInterface
Representation of the current state of a controller.
CollectionInterface
Manage a group of devices.
DeviceInterface
FactoryInterface
NetworkInterface
Provides methods to locate speakers/controllers/playlists on the current network.
PlaylistInterface
Provides an interface for managing Sonos playlists on the current network.
QueueInterface
Provides an interface for managing the queue of a controller.
RadioInterface
SpeakerInterface
Represents an individual Sonos speaker, to allow volume, equalisation, and other settings to be managed.
StateInterface
Representation of the current state of a controller.
TrackInterface
Representation of a track.
FactoryInterface
Factory for creating Track instances.
UriInterface
An interface for objects that repsent some type of Uri.
DirectoryInterface
Represents a shared directory.
SocketInterface
TimeInterface
A class to represent amounts of time.

Classes

Alarm
Provides an interface for managing the alarms on the network.
Controller
Allows interaction with the groups of speakers.
ControllerState
Representation of the current state of a controller.
CachedCollection
Cache the collection of devices.
Collection
Device
Make http requests to a Sonos device.
Discovery
Factory
Speakers
Use discovery but only for known speaker models
InvalidArgumentException
An invalid argument was passed.
NetworkException
NotFoundException
SoapException
Provides extra information about upnp exceptions
UnexpectedValueException
UnknownGroupException
Network
Provides methods to locate speakers/controllers/playlists on the current network.
Playlist
Provides an interface for managing Sonos playlists on the current network.
Queue
Provides an interface for managing the queue of a controller.
Radio
Handle radio streams using TuneIn.
Speaker
Represents an individual Sonos speaker, to allow volume, equalisation, and other settings to be managed.
State
Representation of the current state of a controller.
Deezer
Representation of a Deezer track.
Factory
Factory for creating Track instances.
Spotify
Representation of a Spotify track.
Stream
Representation of a stream.
TextToSpeech
Convert a string of a text to spoken word audio.
Tidal
Representation of a track.
Track
Representation of a track.
Uri
Representation of a URI.
Directory
Represents a shared directory.
Socket
Time
A class to represent amounts of time.
Xml
AbstractLiveCase
AlarmTest
ControllerLiveTest
ControllerTest
CachedCollectionTest
CollectionTest
DeviceTest
DiscoveryTest
FactoryTest
SpeakersTest
HelperTest
MockFactory
NetworkLiveTest
NetworkTest
PlaylistLiveTest
QueueLiveTest
QueueTest
RadioTest
SpeakerLiveTest
SpeakerTest
StateTest
FactoryTest
StreamTest
TrackTest
DirectoryTest
TimeTest

Enums

PlayState
On this page

Search results