\duncan3dc\Sonos\Cloud\InterfacesHouseholdInterface

Provides methods to locate players/groups on the household.

Summary

Methods
Constants
getPlayers()
getPlayersByRoom()
getPlayerByRoom()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

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(string  $room) : \duncan3dc\Sonos\Cloud\Interfaces\iterable|array<mixed,\duncan3dc\Sonos\Cloud\Interfaces\PlayerInterface>

Get all the speakers with the specified room name.

Parameters

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(string  $room) : \duncan3dc\Sonos\Cloud\Interfaces\PlayerInterface

Get a speaker with the specified room name.

Parameters

string $room

The name of the room to look for

Returns

\duncan3dc\Sonos\Cloud\Interfaces\PlayerInterface