package music.v1alpha1
Get desktop application:
View/edit binary Protocol Buffers messages
service AddonsService
addons.proto:19rpc GetAddonDetails (, )
addons.proto:21message
addons.proto:11(message has no fields)
message
addons.proto:13optional addon = 1
rpc GetAddons (, )
addons.proto:20message
addons.proto:7(message has no fields)
message
addons.proto:9repeated addons = 1
rpc SetAddonEnabled (, )
addons.proto:23message
addons.proto:15(message has no fields)
message
addons.proto:17(message has no fields)
rpc AnalyzeLibrary (, )
analysis.proto:116message
analysis.proto:50Analyse tracks that have not been analysed yet, in the background.
int32 limit = 1
How many to work through. Analysis is slow and this returns immediately, so a caller asking for the whole library gets a long-running background job rather than a long-running request.
message
analysis.proto:57uint64 queued = 1
How many were queued. Fewer than asked for means the rest are done.
rpc GetAnalysisStatus (, )
analysis.proto:117message
analysis.proto:62(message has no fields)
message
analysis.proto:64uint64 analyzed = 1
Analysed tracks in the connected library.
bool running = 2
Whether a background pass is running.
uint64 remaining = 3
Still to do in the running pass.
rpc GetAutoDj (, )
analysis.proto:121message
analysis.proto:101(message has no fields)
message
analysis.proto:103optional state = 1
rpc GetTrackAnalysis (, )
analysis.proto:114message
analysis.proto:40string track_id = 1
bool analyze_if_missing = 2
Analyse it now if it has not been. Off by default: a client drawing a waveform wants whatever is ready, not a decode blocking the response.
message
analysis.proto:47optional analysis = 1
rpc SetAutoDj (, )
analysis.proto:120message
analysis.proto:92bool enabled = 1
optional target = 2
Absent leaves the current target alone; present replaces it whole, so clearing a target means sending an empty one rather than omitting it.
message
analysis.proto:99optional state = 1
rpc SimilarTracks (, )
analysis.proto:119message
analysis.proto:106Tracks that would sound good after a given one, best first.
string track_id = 1
int32 limit = 2
message
analysis.proto:111repeated tracks = 1
rpc GetClock (, )
analytics.proto:196message
analytics.proto:84optional scope = 1
message
analytics.proto:97repeated cells = 1
rpc GetDrift (, )
analytics.proto:199message
analytics.proto:135optional scope = 1
string bucket = 2
day, week, month, quarter or year.
message
analytics.proto:151repeated points = 1
rpc GetOverview (, )
analytics.proto:194message
analytics.proto:28optional scope = 1
message
analytics.proto:32int64 listens = 1
int64 distinct_tracks = 2
int64 distinct_artists = 3
int64 distinct_albums = 4
double hours_played = 5
A floor, not an estimate: sources that record no duration (a bare scrobble) contribute nothing.
int64 sessions = 6
string first_listen = 7
string last_listen = 8
int64 active_days = 9
int64 longest_streak = 10
repeated sources = 11
rpc GetRotation (, )
analytics.proto:201message
analytics.proto:172optional scope = 1
uint32 limit = 2
message
analytics.proto:177double top_1_percent_share = 1
double top_10_percent_share = 2
double gini = 3
int64 library_tracks = 4
int64 library_played = 5
repeated rediscover = 6
rpc GetSessions (, )
analytics.proto:197message
analytics.proto:101optional scope = 1
uint32 limit = 2
message
analytics.proto:106int64 sessions = 1
double avg_tracks = 2
double median_minutes = 3
double longest_minutes = 4
repeated openers = 5
Tracks that most often open a session.
rpc GetSkips (, )
analytics.proto:198message
analytics.proto:115optional scope = 1
uint32 limit = 2
int64 min_listens = 3
message
analytics.proto:131repeated rows = 1
rpc GetTop (, )
analytics.proto:195message
analytics.proto:65TopKind kind = 1
optional scope = 2
uint32 limit = 3
message
analytics.proto:80repeated ranks = 1
rpc GetTransitions (, )
analytics.proto:200message
analytics.proto:155optional scope = 1
uint32 limit = 2
message
analytics.proto:168repeated transitions = 1
rpc Sync (, )
analytics.proto:204Mirror anything the player has recorded since the last call. Safe to call often — it is incremental and does nothing when there is nothing new.
message
analytics.proto:186(message has no fields)
message
analytics.proto:188uint64 listens = 1
uint64 tracks = 2
service CoreService
core.proto:9rpc GetVersion (, )
core.proto:10message
core.proto:5(message has no fields)
message
core.proto:7string version = 1
service HistoryService
history.proto:9rpc GetHistory (, )
history.proto:10message
history.proto:5(message has no fields)
message
history.proto:7(message has no fields)
service LibraryService
library.proto:86rpc GetAlbumDetails (, )
library.proto:91message
library.proto:45string id = 1
message
library.proto:49optional album = 1
rpc GetAlbums (, )
library.proto:90message
library.proto:21int32 limit = 1
int32 offset = 2
string filter = 3
message
library.proto:27repeated albums = 1
rpc GetArtistDetails (, )
library.proto:98message
library.proto:65string id = 1
message
library.proto:69optional artist = 1
rpc GetArtists (, )
library.proto:97message
library.proto:29int32 limit = 1
int32 offset = 2
string filter = 3
message
library.proto:35repeated artists = 1
rpc GetLikedTracks (, )
library.proto:94message
library.proto:56The tracks the user has liked. On a remote provider these are *its* likes — Subsonic's starred songs, Jellyfin's favourites. There is no fallback to the local list: those ids belong to a different library, so the rows would render but not play.
uint32 offset = 1
uint32 limit = 2
message
library.proto:61repeated tracks = 1
rpc GetTrackDetails (, )
library.proto:95message
library.proto:71string id = 1
message
library.proto:75optional track = 1
rpc GetTracks (, )
library.proto:93message
library.proto:37int32 limit = 1
int32 offset = 2
string filter = 3
message
library.proto:43repeated tracks = 1
rpc LikeTrack (, )
library.proto:87message
library.proto:79Like/unlike a track. The like itself lives with the client; the daemon forwards it to Rocksky (no-op without a `rocksky login` token).
string id = 1
bool like = 2
message
library.proto:84(message has no fields)
rpc Scan (, )
library.proto:88message
library.proto:9(message has no fields)
message
library.proto:11(message has no fields)
rpc Search (, )
library.proto:89message
library.proto:13string query = 1
message
library.proto:15repeated tracks = 1
repeated albums = 2
repeated artists = 3
service MixerService
mixer.proto:87rpc GetAudioSettings (, )
mixer.proto:92message
mixer.proto:25(message has no fields)
message
mixer.proto:33Snapshot of the DSP chain settings. Integer enums follow the Rockbox firmware conventions used by the desktop UI: - replaygain_type: 0 track, 1 album, 2 track (shuffle), 3 off - crossfade: 0 off, 1 auto track change, 2 manual track change, 3 shuffle, 4 shuffle or manual skip, 5 always - fade_out_mixmode: 0 crossfade, 2 mix
bool eq_enabled = 1
int32 eq_precut = 2
dB x10, 0..240
repeated eq_bands = 3
int32 bass = 4
dB
int32 bass_min = 5
int32 bass_max = 6
int32 treble = 7
dB
int32 treble_min = 8
int32 treble_max = 9
int32 balance = 10
-100..100
int32 replaygain_type = 11
int32 replaygain_preamp = 12
dB x10, -120..120
bool replaygain_noclip = 13
int32 crossfade = 14
int32 fade_in_delay = 15
s, 0..7
int32 fade_in_duration = 16
s, 0..15
int32 fade_out_delay = 17
s, 0..7
int32 fade_out_duration = 18
s, 0..15
int32 fade_out_mixmode = 19
bool dithering = 20
rpc GetMute (, )
mixer.proto:88message
mixer.proto:5(message has no fields)
message
mixer.proto:7bool mute = 1
rpc GetVolume (, )
mixer.proto:90message
mixer.proto:75(message has no fields)
message
mixer.proto:77uint32 volume = 1
rpc SetAudioSetting (, )
mixer.proto:93message
mixer.proto:61Set a single audio setting by name; `name` is one of: eq_enabled, eq_precut, bass, treble, balance, rg_type, rg_preamp, rg_noclip, crossfade, fade_in_delay, fade_in_duration, fade_out_delay, fade_out_duration, fade_out_mixmode, dithering. Booleans use 0/1; eq_precut and rg_preamp are dB x10.
string name = 1
int32 value = 2
message
mixer.proto:66(message has no fields)
rpc SetEqBandGain (, )
mixer.proto:94message
mixer.proto:68uint32 band = 1
0..9 (32 Hz .. 16 kHz)
int32 gain = 2
dB x10, -240..240
message
mixer.proto:73(message has no fields)
rpc SetMute (, )
mixer.proto:89message
mixer.proto:11bool mute = 1
message
mixer.proto:15(message has no fields)
rpc SetVolume (, )
mixer.proto:91message
mixer.proto:81uint32 volume = 1
message
mixer.proto:85(message has no fields)
service PlaybackService
playback.proto:70message
playback.proto:7(message has no fields)
message
playback.proto:9optional track = 1
uint32 index = 2
uint32 position_ms = 3
bool is_playing = 4
bool shuffle = 5
The playback modes, so a client can restore its own controls to what the daemon is actually doing rather than assuming "off".
int32 repeat_mode = 6
0 off, 1 all, 2 one.
rpc GetPlaybackState (, )
playback.proto:76message
playback.proto:36(message has no fields)
message
playback.proto:38(message has no fields)
rpc GetTimePosition (, )
playback.proto:78message
playback.proto:40(message has no fields)
message
playback.proto:42(message has no fields)
rpc Next (, )
playback.proto:80message
playback.proto:44(message has no fields)
message
playback.proto:46(message has no fields)
rpc Pause (, )
playback.proto:81message
playback.proto:48(message has no fields)
message
playback.proto:50(message has no fields)
rpc Play (, )
playback.proto:82message
playback.proto:52(message has no fields)
message
playback.proto:54(message has no fields)
rpc Previous (, )
playback.proto:83message
playback.proto:56(message has no fields)
message
playback.proto:58(message has no fields)
rpc Seek (, )
playback.proto:84message
playback.proto:60uint32 position_ms = 1
message
playback.proto:64(message has no fields)
rpc Stop (, )
playback.proto:85message
playback.proto:66(message has no fields)
message
playback.proto:68(message has no fields)
rpc StreamLevels (, stream )
playback.proto:75A meter needs tens of updates a second, which is no way to poll — the daemon pushes instead, and stops when the client goes away.
message
playback.proto:34(message has no fields)
message
playback.proto:22Output levels for a meter, measured on the PCM leaving the device.
float left = 1
0..1 RMS over one output buffer.
float right = 2
float low_left = 3
The same signal below roughly 200 Hz, which is what makes a meter move with the bass rather than with whatever is loudest.
float low_right = 4
repeated float bands = 5
Coarse spectrum, low band to high — what a bar visualiser draws.
rpc AddItem (, )
playlist.proto:166message
playlist.proto:72string id = 1
string track_id = 2
message
playlist.proto:77string id = 1
string name = 2
repeated tracks = 3
rpc Create (, )
playlist.proto:161message
playlist.proto:8string name = 1
repeated tracks = 2
optional smart = 3
Present for a smart playlist: the tracks are generated from this filter rather than taken from `tracks`, and regenerated whenever the library changes. Absent creates an ordinary hand-picked playlist.
message
playlist.proto:30string id = 1
string name = 2
repeated tracks = 3
rpc CreateFolder (, )
playlist.proto:170message
playlist.proto:99string name = 1
message
playlist.proto:103string id = 1
string name = 2
rpc Delete (, )
playlist.proto:162message
playlist.proto:36string id = 1
message
playlist.proto:38string id = 1
string name = 2
rpc DeleteFolder (, )
playlist.proto:171message
playlist.proto:118string id = 1
message
playlist.proto:120string id = 1
string name = 2
rpc FindAll (, )
playlist.proto:167message
playlist.proto:83(message has no fields)
message
playlist.proto:85repeated playlists = 1
rpc FindAllFolders (, )
playlist.proto:173message
playlist.proto:125(message has no fields)
message
playlist.proto:127repeated folders = 1
rpc GetFolderDetails (, )
playlist.proto:181message
playlist.proto:131string id = 1
rpc GetItems (, )
playlist.proto:163message
playlist.proto:43string id = 1
message
playlist.proto:45string id = 1
string name = 2
repeated tracks = 3
rpc GetPlaylistDetails (, )
playlist.proto:168message
playlist.proto:87string id = 1
How many tracks a filter would match, without saving anything — what the "N tracks match" line under a filter box calls.
message
playlist.proto:147optional smart = 1
message
playlist.proto:151uint32 count = 1
How many tracks the filter matches.
repeated tracks = 2
The first few, so a form can show what it caught.
string error = 3
Why the filter did not compile; empty when it did.
Re-run a smart playlist's filter against the library as it is now.
message
playlist.proto:139string id = 1
message
playlist.proto:143uint32 count = 1
rpc RemoveItem (, )
playlist.proto:165message
playlist.proto:61string id = 1
string track_id = 2
message
playlist.proto:66string id = 1
string name = 2
repeated tracks = 3
rpc Rename (, )
playlist.proto:164message
playlist.proto:51string id = 1
string name = 2
message
playlist.proto:56string id = 1
string name = 2
rpc RenameFolder (, )
playlist.proto:172message
playlist.proto:108string id = 1
string name = 2
message
playlist.proto:113string id = 1
string name = 2
service ServersService
servers.proto:89Saved servers, and which one the library is read from. Connecting cannot interrupt playback: a provider is where the screens read, and nothing here can reach the player.
rpc AddServer (, )
servers.proto:93message
servers.proto:53string kind = 1
string name = 2
string url = 3
string username = 4
string password = 5
Omit to keep whatever is stored: the password is never handed back, so a blank field cannot mean "clear it".
message
servers.proto:62optional server = 1
rpc ConnectServer (, )
servers.proto:95message
servers.proto:73string id = 1
message
servers.proto:76optional server = 1
rpc DeleteServer (, )
servers.proto:94message
servers.proto:66string id = 1
message
servers.proto:69bool deleted = 1
rpc DisconnectServer (, )
servers.proto:96message
servers.proto:80(message has no fields)
message
servers.proto:81optional server = 1
rpc GetConnectedServer (, )
servers.proto:92message
servers.proto:47(message has no fields)
message
servers.proto:48optional server = 1
Absent means the daemon's own library.
rpc ListServers (, )
servers.proto:90message
servers.proto:37(message has no fields)
message
servers.proto:38repeated servers = 1
rpc ListSourceKinds (, )
servers.proto:91message
servers.proto:42(message has no fields)
message
servers.proto:43repeated kinds = 1
rpc AddTrack (, )
tracklist.proto:81message
tracklist.proto:7optional track = 1
message
tracklist.proto:9(message has no fields)
rpc AddTracks (, )
tracklist.proto:82message
tracklist.proto:11repeated tracks = 1
message
tracklist.proto:13(message has no fields)
rpc ClearTracklist (, )
tracklist.proto:84message
tracklist.proto:22(message has no fields)
message
tracklist.proto:24(message has no fields)
rpc FilterTracklist (, )
tracklist.proto:85message
tracklist.proto:26(message has no fields)
message
tracklist.proto:28(message has no fields)
rpc GetNextTrack (, )
tracklist.proto:90message
tracklist.proto:64(message has no fields)
message
tracklist.proto:36optional track = 1
rpc GetPreviousTrack (, )
tracklist.proto:91message
tracklist.proto:66(message has no fields)
message
tracklist.proto:38optional track = 1
rpc GetRandom (, )
tracklist.proto:87message
tracklist.proto:58(message has no fields)
message
tracklist.proto:30(message has no fields)
rpc GetRepeat (, )
tracklist.proto:88message
tracklist.proto:60(message has no fields)
message
tracklist.proto:32(message has no fields)
rpc GetSingle (, )
tracklist.proto:89message
tracklist.proto:62(message has no fields)
message
tracklist.proto:34(message has no fields)
rpc GetTracklistTracks (, )
tracklist.proto:96message
tracklist.proto:70(message has no fields)
message
tracklist.proto:53repeated next_tracks = 1
repeated previous_tracks = 2
rpc LoadTracks (, )
tracklist.proto:83message
tracklist.proto:15repeated tracks = 1
int32 start_index = 2
message
tracklist.proto:20(message has no fields)
rpc PlayNext (, )
tracklist.proto:98message
tracklist.proto:72optional track = 1
message
tracklist.proto:74(message has no fields)
rpc PlayTrackAt (, )
tracklist.proto:99message
tracklist.proto:76uint32 index = 1
message
tracklist.proto:78(message has no fields)
rpc RemoveTrackAt (, )
tracklist.proto:93message
tracklist.proto:40uint32 position = 1
message
tracklist.proto:44(message has no fields)
rpc SetRepeat (, )
tracklist.proto:95message
tracklist.proto:470 off, 1 all, 2 one.
int32 mode = 1
message
tracklist.proto:49(message has no fields)
rpc Shuffle (, )
tracklist.proto:94message
tracklist.proto:68bool enabled = 1
message
tracklist.proto:51(message has no fields)
message
analysis.proto:81Used in: ,
bool enabled = 1
optional target = 2
uint32 queued_ahead = 3
Tracks queued after the current one. Auto-DJ tops this up rather than choosing one track at a time, so the next few are always visible.
uint64 candidates = 4
How many tracks it has to choose between. Zero means nothing in the library has been analysed yet, and auto-DJ can do nothing until it has.
message
analysis.proto:75Where auto-DJ should steer the set. Absent fields mean "wherever the music goes" — the set still flows, it just is not being pushed in any direction.
Used in: ,
optional float bpm = 1
optional float valence = 2
optional float arousal = 3
message
analytics.proto:88Used in:
int32 weekday = 1
0 = Sunday.
int32 hour = 2
int64 listens = 3
optional double avg_bpm = 4
optional double avg_valence = 5
message
analytics.proto:141Used in:
string bucket = 1
int64 listens = 2
optional double avg_bpm = 3
optional double avg_valence = 4
optional double avg_arousal = 5
optional double median_year = 6
double discovery_rate = 7
message
mixer.proto:19One parametric-EQ band. `q` is the Q factor x10, `gain` is dB x10 (so the wire format stays integer while the UI works in 0.1 dB steps).
Used in:
int32 cutoff = 1
Hz
int32 q = 2
Q x10
int32 gain = 3
dB x10
message
playlist.proto:133Used as response type in: PlaylistService.GetFolderDetails
Used as field type in:
string id = 1
string name = 2
repeated playlists = 3
message
playlist.proto:89Used as response type in: PlaylistService.GetPlaylistDetails
Used as field type in:
string id = 1
string name = 2
string description = 3
repeated tracks = 4
uint32 track_count = 5
Present when the server reported one; a detail call carries the entries anyway, so this is for consistency with the listing.
message
analysis.proto:12Used in:
string name = 1
float confidence = 2
message
analytics.proto:71Used in: , ,
string name = 1
string secondary = 2
The artist, for a track or album row; empty otherwise.
int64 listens = 3
double hours = 4
string last_played = 5
message
analytics.proto:16Which listens a question is about. `since`/`until` unset means all of recorded history, which may span years once an export has been imported.
Used in: , , , , , , ,
optional int64 since = 1
Unix seconds, inclusive.
optional int64 until = 2
Unix seconds, exclusive.
bool local_only = 3
Count only tracks the local library has. Matched on title+artist, so a play imported from Spotify still counts when the same track is in the library — the question is "my history, for music I own", not "plays that went through this player".
message
servers.proto:10A remote music server the user has saved. This is where a library is *read from* — a different question from where the audio comes out, which is a cast device. The password is stored but never returned; callers are told only whether one is set.
Used in: , , , ,
string id = 1
string kind = 2
The provider-registry key: "subsonic", "jellyfin", "music-player", ...
string name = 3
string url = 4
Absolute, scheme included.
string username = 5
bool has_password = 6
bool connected = 7
The library screens are currently reading from this one.
message
analytics.proto:121Used in:
string name = 1
string secondary = 2
int64 listens = 3
int64 skips = 4
double skip_rate = 5
optional double median_completion = 6
Median fraction of the track heard before moving on.
message
playlist.proto:19A smart playlist's rule: an RSQL filter over the track fields, plus how to order and cap the result.
Used in: ,
string filter = 1
e.g. `genre==rock;year>2000`. Empty matches the whole library.
string sort_by = 2
A track field to order by, or `random`.
string sort_order = 3
`asc` or `desc`.
uint32 limit = 4
Maximum tracks. 0 is unlimited.
message
analytics.proto:49Where the history came from, and how much of it survived deduplication.
Used in:
string origin = 1
int64 raw = 2
int64 canonical = 3
string first = 4
string last = 5
message
servers.proto:26One kind of server this build can talk to, straight from the provider registry — so a newly registered backend offers itself to every client without any of them being changed.
Used in:
string kind = 1
string display_name = 2
bool needs_credentials = 3
False for backends with no login, so a form can hide those fields.
uint32 default_port = 4
optional string fixed_url = 5
Set for a backend that always talks to one address, so a form can drop the url field instead of asking for something it ignores.
Used in:
TOP_KIND_UNSPECIFIED = 0
TOP_KIND_ARTISTS = 1
TOP_KIND_TRACKS = 2
TOP_KIND_ALBUMS = 3
TOP_KIND_GENRES = 4
message
analysis.proto:17Used in:
string track_id = 1
bytes waveform = 2
Peak per display bar, 0-255, left to right. Empty when the track has not been analysed.
optional float bpm = 3
optional float bpm_confidence = 4
How much to believe the bpm, 0-1.
optional float valence = 5
-1 dark to 1 bright.
optional float arousal = 6
0 calm to 1 driving.
repeated moods = 7
optional float lufs = 8
Integrated loudness, LUFS.
optional float true_peak_db = 9
float duration = 10
Seconds, as decoded rather than as the tags claim.
bool analyzed = 11
False means nothing has been computed yet; every other field is then empty rather than zero.
message
analytics.proto:160Used in:
string from_title = 1
string from_artist = 2
string to_title = 3
string to_artist = 4
int64 times = 5