\duncan3dc\Sonos\CloudHousehold

Summary

Methods
Properties
Constants
__construct()
getPlayers()
getPlayersByRoom()
getPlayerByRoom()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
getData()
$id
$api
$cache
N/A

Properties

$id

$id : string

Type

string

$cache

$cache : \Psr\SimpleCache\CacheInterface

Type

\Psr\SimpleCache\CacheInterface

Methods

__construct()

__construct(string  $id, \duncan3dc\Sonos\Cloud\Interfaces\ClientInterface  $api, \Psr\SimpleCache\CacheInterface|null  $cache = null) 

Create a new instance.

Parameters

string $id
\duncan3dc\Sonos\Cloud\Interfaces\ClientInterface $api
\Psr\SimpleCache\CacheInterface|null $cache

getPlayers()

getPlayers() : \duncan3dc\Sonos\Cloud\Interfaces\iterable|array<mixed,\duncan3dc\Sonos\Cloud\Interfaces\PlayerInterface>

Get all the speakers on the network.

Returns

\duncan3dc\Sonos\Cloud\Interfaces\iterable|array<mixed,\duncan3dc\Sonos\Cloud\Interfaces\PlayerInterface>

getPlayersByRoom()

getPlayersByRoom(\duncan3dc\Sonos\Cloud\string  $room) : \duncan3dc\Sonos\Cloud\Interfaces\iterable|array<mixed,\duncan3dc\Sonos\Cloud\Interfaces\PlayerInterface>

Get all the speakers with the specified room name.

Parameters

\duncan3dc\Sonos\Cloud\string $room

The name of the room to look for

Returns

\duncan3dc\Sonos\Cloud\Interfaces\iterable|array<mixed,\duncan3dc\Sonos\Cloud\Interfaces\PlayerInterface>

getPlayerByRoom()

getPlayerByRoom(\duncan3dc\Sonos\Cloud\string  $room) : \duncan3dc\Sonos\Cloud\Interfaces\PlayerInterface

Get a speaker with the specified room name.

Parameters

\duncan3dc\Sonos\Cloud\string $room

The name of the room to look for

Returns

\duncan3dc\Sonos\Cloud\Interfaces\PlayerInterface

getData()

getData() : \stdClass

Get the data for this household.

Returns

\stdClass