Download the PHP package sharkydog/snapcast-client without Composer

snapcast-client

Snapcast JSON-RPC api wrapper in PHP

This library provides basic connectivity to the Snapcast server using its JSON-RPC api and a raw TCP socket. Commands and responses are linked using ReactPHP promises, notifications are available as EventEmitter events.

The client class has an automatic reconnect feature which can be adjusted or stopped during runtime.

Usage

By default client will connect with 2 seconds timeout and try to reconnect after 5 seconds if connect failed, connection was dropped or closed by the remote side. This can be changed.

SharkyDog\Snapcast\Client reference

Events

event [parameter1, parameter2, ...]

• connect - connect attempt is being made
• reconnect - connect attempt will be made after reconnect interval
• error-connect [\Throwable $error] - connect error
• open - connection established
• close [bool $remote] - connection closed, $remote = true when closed by remote side or dropped
• notify [string $method, \stdClass $params] - notification

Notifications will also be emitted with method as event and params as single parameter, like: Stream.OnUpdate [\stdClass $params]

Helpers

There is an abstract class (SharkyDog\Snapcast\ClientApp) that helps create additional and more specific logic by binding events to class methods.

Restore player stream

SharkyDog\Snapcast\App\RestorePlayerStream is one such class. It will monitor the snapcast server for players being added to or removed from groups and will remember the set stream when a player is alone in a group. Then, when the player is removed from a group and is placed alone in a new group, the stream will be restored to the remembered one or to a configured default per player.

Data directory provided in the constructor is where player state is saved and where config is read from. After client has been set and it connects, RestorePlayerStream will start monitoring the server for stream changes and will save the last used stream for every player when it is alone in a group, but will not do anything else until some configuration is done in the data directory.

For every player there will be a file like stat_name_id, ex.: stat_Snapclient_on_Server_aa_bb_cc_dd_ee_ff. Filename is formed from player name and id after non alphanumeric characters are replaced with underscore. If player name is not set, used name for the stat filename will be noname. Content of this file is the last saved stream id.

In the same directory, a config file will be read when the player is removed from a group. These files must be created and managed by you, RestorePlayerStream will not write or delete them.

The config file is per player and can be named conf_name_id or conf_id or conf_name or conf_default. RestorePlayerStream will look for them in that order. The file conf_default would be picked last for any player, but obviously can also be picked by a player with name or id "default".

• If a file is not present, nothing will be done.
• If content of the file is empty, player stream will be restored to the one in the stat file.
• If the file is not empty, its content will be used as the stream to restore.

If you want the player to be restored to the last used stream:

If you want to set the current saved stream as default: