3pp-mirror/snapcast
1
0
Fork 0
mirror of https://github.com/badaix/snapcast.git synced 2025-06-02 10:51:45 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update documentation

Browse source
This commit is contained in:
badaix 2021-12-17 10:54:04 +01:00
parent 636b24a074
commit 96b55c9b24
3 changed files with 149 additions and 132 deletions
Download patch file Download diff file Expand all files Collapse all files

181
doc/json_rpc_api/stream_plugin.md
View file

@ -2,27 +2,28 @@
# Stream plugin
A stream plugin is (this might change in future) an executable binary or script that is started by the server for a specific stream and offers playback control capabilities and provides information about the stream's state, as well as metadata for the currently playing track.
The Snapcast server communicates via stdin/stdout with the plugin and sends newline delimited JSON-RPC commands and receives responses and notifications from the plugin, as described below. In upcoming releases shared library plugins might be supported as well.
The Snapcast server communicates via stdin/stdout with the plugin and sends newline delimited JSON-RPC> commands and receives responses and notifications from the plugin, as described below. In upcoming releases shared library plugins might be supported as well.
## Requests
A Stream plugin must support and handle the following requests, sent by the Snapcast server
A Stream plugin must support and handle the following [requests](#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)
The following [notifications](#notifications) 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)
## Requests
The following requests will be sent by the Snapserver to the stream plugin. Upon startup Snapserver will wait for the plugin's [ready notification](#pluginstreamready) to [query the supported properties](Plugin.Stream.Player.GetProperties). The controlling capabilities are encoded into these boolean properties: `canGoNext`, `canGoPrevious`, `canPlay`, `canPause`, `canSeek`, `canControl`.
If `canControl` is `false`, the server will not send any control commands to the plugin.
### Plugin.Stream.Player.Control
Used to control the player
Used to control the player. The property `canControl` must be `true`.
```json
{"id": 1, "jsonrpc": "2.0", "method": "Plugin.Stream.Player.Control", "params": {"command": "<command>", "params": { "<param 1>": <value 1>, "<param 2>": <value 2>}}}
@ -30,22 +31,22 @@ Used to control the player
#### Supported `command`s
* `Play`: Start playback
* `Play`: Start playback (if `canPlay` is `true`)
* `params`: none
* `Pause`: Stop playback
* `Pause`: Stop playback (if `canPause` is `true`)
* `params`: none
* `PlayPause`: Toggle play/pause
* `PlayPause`: Toggle play/pause (if `canPause` is `true`)
* `params`: none
* `Stop`: Stop playback
* `Stop`: Stop playback (if `canControl` is `true`)
* `params`: none
* `Next`: Skip to next track
* `Next`: Skip to next track (if `canGoNext` is `true`)
* `params`: none
* `Previous`: Skip to previous track
* `Previous`: Skip to previous track (if `canGoPrevious` is `true`)
* `params`: none
* `Seek`: Seek forward or backward in the current track
* `Seek`: Seek forward or backward in the current track (if `canSeek` is `true`)
* `params`:
* `Offset`: [float] seek offset in seconds
* `SetPosition`: Set the current track position in seconds
* `SetPosition`: Set the current track position in seconds (if `canSeek` is `true`)
* `params`:
* `Position`: [float] the new track position
* `TrackId`: [string] the optional currently playing track's identifier
@ -66,12 +67,12 @@ Success:
Error:
```json
todo
```
Any [json-rpc 2.0 conformant error](https://www.jsonrpc.org/specification#error_object) with an error message that helps the user to diagnose the error
### Plugin.Stream.Player.SetProperty
Snapserver will send the `SetProperty` command to the plugin, if `canControl` is `true`.
```json
{"id": 1, "jsonrpc": "2.0", "method": "Plugin.Stream.Player.SetProperty", "params": {"<property>", <value>}}
```
@ -88,17 +89,15 @@ todo
#### Expected response
Success:
##### Success
```json
{"id": 1, "jsonrpc": "2.0", "result": "ok"}
```
Error:
##### Error
```json
todo
```
Any [json-rpc 2.0 conformant error](https://www.jsonrpc.org/specification#error_object) with an error message that helps the user to diagnose the error
### Plugin.Stream.Player.GetProperties
@ -106,16 +105,6 @@ todo
{"id": 1, "jsonrpc": "2.0", "method": "Plugin.Stream.Player.GetProperties"}
```
#### Expected response
Success:
```json
{"id": 1, "jsonrpc": "2.0", "result": {"canControl":true,"canGoNext":true,"canGoPrevious":true,"canPause":true,"canPlay":true,"canSeek":false,"loopStatus":"none","playbackStatus":"playing","position":93.394,"shuffle":false,"volume":86}}
{"id": 1, "jsonrpc": "2.0", "result": {"canControl":true,"canGoNext":true,"canGoPrevious":true,"canPause":true,"canPlay":true,"canSeek":true,"loopStatus":"none","metadata":{"album":"Doldinger","albumArtist":["Klaus Doldinger's Passport"],"artUrl":"http://coverartarchive.org/release/0d4ff56b-2a2b-43b5-bf99-063cac1599e5/16940576164-250.jpg","artist":["Klaus Doldinger's Passport feat. Nils Landgren"],"contentCreated":"2016","duration":305.2929992675781,"genre":["Jazz"],"musicbrainzAlbumId":"0d4ff56b-2a2b-43b5-bf99-063cac1599e5","title":"Soul Town","trackId":"7","trackNumber":6,"url":"Klaus Doldinger's Passport - Doldinger (2016)/06 - Soul Town.mp3"},"playbackStatus":"playing","position":72.79499816894531,"shuffle":false,"volume":97}}
```
#### Supported `property`s
* `playbackStatus`: [string] The current playback status, one of:
@ -130,83 +119,81 @@ Success:
* `volume`: [int] Voume in percent, valid range [0..100]
* `rate`: [float] The current playback rate, valid range (0..)
* `position`: [float] Current playback position in seconds
* `canGoNext`: [bool] Whether the client can call the Next method on this interface and expect the current track to change
* `canGoPrevious`: [bool] Whether the client can call the Previous method on this interface and expect the current track to change
* `canPlay`: [bool] Whether playback can be started using Play or PlayPause
* `canPause`: [bool] Whether playback can be paused using Pause or PlayPause
* `canSeek`: [bool] Whether the client can control the playback position using Seek and SetPosition
* `canGoNext`: [bool] Whether the client can call the `Next` method on this interface and expect the current track to change
* `canGoPrevious`: [bool] Whether the client can call the `Previous` method on this interface and expect the current track to change
* `canPlay`: [bool] Whether playback can be started using `Play` or `PlayPause`
* `canPause`: [bool] Whether playback can be paused using `Pause` or `PlayPause`
* `canSeek`: [bool] Whether the client can control the playback position using `Seek` and `SetPosition`
* `canControl`: [bool] Whether the media player may be controlled over this interface
* `metadata`: [json] message with the following (optional) fields:
* `trackId`: [string] A unique identity for this track within the context of an MPRIS object (eg: tracklist).
* `file`: [string] The current song.
* `duration`: [float] The duration of the song in seconds; may contain a fractional part.
* `artist`: [list of strings] The track artist(s).
* `artistSort`: [list of strings] Same as artist, but for sorting. This usually omits prefixes such as “The”.
* `album`: [string] The album name.
* `albumSort`: [string] Same as album, but for sorting.
* `albumArtist`: [list of strings] The album artist(s).
* `albumArtistSort`: [list of strings] Same as albumartist, but for sorting.
* `name`: [string] A name for this song. This is not the song title. The exact meaning of this tag is not well-defined. It is often used by badly configured internet radio stations with broken tags to squeeze both the artist name and the song title in one tag.
* `date`: [string] The song’s release date. This is usually a 4-digit year.
* `originalDate`: [string] The song’s original release date.
* `composer`: [list of strings] The composer(s) of the track.
* `performer`: [string] The artist who performed the song.
* `conductor`: [string] The conductor who conducted the song.
* `work`: [string] “a work is a distinct intellectual or artistic creation, which can be expressed in the form of one or more audio recordings”
* `grouping`: [string] “used if the sound belongs to a larger category of sounds/music” (from the IDv2.4.0 TIT1 description).
* `comment`: [list of string] A (list of) freeform comment(s)
* `label`: [string] The name of the label or publisher.
* `musicbrainzArtistId`: [string] The artist id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `musicbrainzAlbumId`: [string] The album id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `musicbrainzAlbumArtistId`: [string] The album artist id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `musicbrainzTrackId`: [string] The track id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `musicbrainzReleaseTrackId`: [string] The release track id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `musicbrainzWorkId`: [string] The work id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `lyrics`: [list of strings] The lyricist(s) of the track
* `bpm`: [integer] The speed of the music, in beats per minute.
* `autoRating`: [float] An automatically-generated rating, based on things such as how often it has been played. This should be in the range 0.0 to 1.0.
* `comment`: [list of strings] A (list of) freeform comment(s).
* `composer`: [list of strings] The composer(s) of the track.
* `contentCreated`: [string] Date/Time: When the track was created. Usually only the year component will be useful.
* `discNumber`: [integer] The disc number on the album that this track is from.
* `firstUsed`: [string] Date/Time: When the track was first played.
* `genre`: [list of strings] List of Strings: The genre(s) of the track.
* `lastUsed`: [string] Date/Time: When the track was last played.
* `lyricist`: [list of strings] List of Strings: The lyricist(s) of the track.
* `title`: [string] The track title.
* `trackNumber`: [string] The track number on the album disc.
* `url`: [string uri] The location of the media file.
* `artUrl`: [string uri] The location of an image representing the track or album. Clients should not assume this will continue to exist when the media player stops giving out the URL.
* `useCount`: [integer] The number of times the track has been played.
* `userRating`: [float] A user-specified rating. This should be in the range 0.0 to 1.0.
* `spotifyArtistId`: [string] The [Spotify Artist ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)
* `spotifyTrackId`: [string] The [Spotify Track ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)
Error:
#### Expected response
##### Success
```json
todo
{"id": 1, "jsonrpc": "2.0", "result": {"canControl":true,"canGoNext":true,"canGoPrevious":true,"canPause":true,"canPlay":true,"canSeek":false,"loopStatus":"none","playbackStatus":"playing","position":93.394,"shuffle":false,"volume":86}}
{"id": 1, "jsonrpc": "2.0", "result": {"canControl":true,"canGoNext":true,"canGoPrevious":true,"canPause":true,"canPlay":true,"canSeek":true,"loopStatus":"none","metadata":{"album":"Doldinger","albumArtist":["Klaus Doldinger's Passport"],"artUrl":"http://coverartarchive.org/release/0d4ff56b-2a2b-43b5-bf99-063cac1599e5/16940576164-250.jpg","artist":["Klaus Doldinger's Passport feat. Nils Landgren"],"contentCreated":"2016","duration":305.2929992675781,"genre":["Jazz"],"musicbrainzAlbumId":"0d4ff56b-2a2b-43b5-bf99-063cac1599e5","title":"Soul Town","trackId":"7","trackNumber":6,"url":"Klaus Doldinger's Passport - Doldinger (2016)/06 - Soul Town.mp3"},"playbackStatus":"playing","position":72.79499816894531,"shuffle":false,"volume":97}}
```
##### Error
Any [json-rpc 2.0 conformant error](https://www.jsonrpc.org/specification#error_object) with an error message that helps the user to diagnose the error
## Notifications
### Plugin.Stream.Player.Metadata
TODO: Metadata are part of the properties
```json
{"jsonrpc": "2.0", "method": "Plugin.Stream.Player.Metadata", "params": {"artist":["Travis Scott & HVME"],"file":"http://wdr-1live-live.icecast.wdr.de/wdr/1live/live/mp3/128/stream.mp3","name":"1Live, Westdeutscher Rundfunk Koeln","title":"Goosebumps (Remix)","trackId":"3"}}
```
#### Supported `tag`s
* `trackId`: [string] A unique identity for this track within the context of an MPRIS object (eg: tracklist).
* `file`: [string] The current song.
* `duration`: [float] The duration of the song in seconds; may contain a fractional part.
* `artist`: [list of strings] The track artist(s).
* `artistSort`: [list of strings] Same as artist, but for sorting. This usually omits prefixes such as “The”.
* `album`: [string] The album name.
* `albumSort`: [string] Same as album, but for sorting.
* `albumArtist`: [list of strings] The album artist(s).
* `albumArtistSort`: [list of strings] Same as albumartist, but for sorting.
* `name`: [string] A name for this song. This is not the song title. The exact meaning of this tag is not well-defined. It is often used by badly configured internet radio stations with broken tags to squeeze both the artist name and the song title in one tag.
* `date`: [string] The song’s release date. This is usually a 4-digit year.
* `originalDate`: [string] The song’s original release date.
* `composer`: [list of strings] The composer(s) of the track.
* `performer`: [string] The artist who performed the song.
* `conductor`: [string] The conductor who conducted the song.
* `work`: [string] “a work is a distinct intellectual or artistic creation, which can be expressed in the form of one or more audio recordings”
* `grouping`: [string] “used if the sound belongs to a larger category of sounds/music” (from the IDv2.4.0 TIT1 description).
* `comment`: [list of string] A (list of) freeform comment(s)
* `label`: [string] The name of the label or publisher.
* `musicbrainzArtistId`: [string] The artist id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `musicbrainzAlbumId`: [string] The album id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `musicbrainzAlbumArtistId`: [string] The album artist id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `musicbrainzTrackId`: [string] The track id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `musicbrainzReleaseTrackId`: [string] The release track id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `musicbrainzWorkId`: [string] The work id in the [MusicBrainz](https://picard-docs.musicbrainz.org/en/appendices/tag_mapping.html) database.
* `lyrics`: [list of strings] The lyricist(s) of the track
* `bpm`: [integer] The speed of the music, in beats per minute.
* `autoRating`: [float] An automatically-generated rating, based on things such as how often it has been played. This should be in the range 0.0 to 1.0.
* `comment`: [list of strings] A (list of) freeform comment(s).
* `composer`: [list of strings] The composer(s) of the track.
* `contentCreated`: [string] Date/Time: When the track was created. Usually only the year component will be useful.
* `discNumber`: [integer] The disc number on the album that this track is from.
* `firstUsed`: [string] Date/Time: When the track was first played.
* `genre`: [list of strings] List of Strings: The genre(s) of the track.
* `lastUsed`: [string] Date/Time: When the track was last played.
* `lyricist`: [list of strings] List of Strings: The lyricist(s) of the track.
* `title`: [string] The track title.
* `trackNumber`: [string] The track number on the album disc.
* `url`: [string uri] The location of the media file.
* `artUrl`: [string uri] The location of an image representing the track or album. Clients should not assume this will continue to exist when the media player stops giving out the URL.
* `useCount`: [integer] The number of times the track has been played.
* `userRating`: [float] A user-specified rating. This should be in the range 0.0 to 1.0.
* `spotifyArtistId`: [string] The [Spotify Artist ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)
* `spotifyTrackId`: [string] The [Spotify Track ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)
### Plugin.Stream.Player.Properties
```json
{"jsonrpc": "2.0", "method": "Plugin.Stream.Player.Properties", "params": {"canControl":true,"canGoNext":true,"canGoPrevious":true,"canPause":true,"canPlay":true,"canSeek":false,"loopStatus":"none","playbackStatus":"playing","position":593.394,"shuffle":false,"volume":86}}
```
[Supported `property`s](#supported-propertys)
Same format as in [GetProperties](#pluginstreamplayergetproperties). If `metadata` is missing, the last known metadata will be used, so the plugin must not send the complete metadata if one of the properties is updated.
### Plugin.Stream.Log