3pp-mirror/snapcast
1
0
Fork 0
mirror of https://github.com/badaix/snapcast.git synced 2025-08-03 16:48:52 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add summary of plugin requests and notifications

Browse source
This commit is contained in:
badaix 2021-10-21 17:55:57 +02:00
parent e1eef690b4
commit 783c1f5fb2
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/json_rpc_api/stream_plugin.md
View file

@ -8,6 +8,19 @@ The Snapcast server communicates via stdin/stdout with the plugin and sends newl
A Stream plugin must support and handle the following requests, sent by the Snapcast server
* [Plugin.Stream.Player.Control](#pluginstreamplayercontrol)
* [Plugin.Stream.Player.SetProperty](#pluginstreamplayersetproperty)
* [Plugin.Stream.Player.GetProperties](#pluginstreamplayergetproperties)
## Notifications
The following messages can be sent by the plugin to notify the server about changes. The `Plugin.Stream.Ready` should be fired as soon as the plugin is ready to receive commands, upon reception, the server will query the stream's [properties](#pluginstreamplayergetproperties)
* [Plugin.Stream.Player.Properties](#pluginstreamplayerproperties)
* [Plugin.Stream.Log](#pluginstreamlog)
* [Plugin.Stream.Ready](#pluginstreamready)
### Plugin.Stream.Player.Control
Used to control the player