package player

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc TogglePause (Empty, PlayState)

  player.proto:7

  Player Commands Toggle Pause/Play, returns the new state

• rpc SkipNext (Empty, Empty)

  player.proto:8

• rpc SkipPrevious (Empty, Empty)

  player.proto:9

• rpc GetProgress (Empty, GetProgressResponse)

  player.proto:10

  message GetProgressResponse

  player.proto:58

  • optional PlayerTime progress = 1

  • uint64 current_track_index = 3

  • uint32 status = 4

  • uint32 volume = 5

    actually a u16, but protobuf does not support types lower than 32 bits

  • int32 speed = 6

  • bool gapless = 7

  • bool current_track_updated = 8

    TODO: this is not necessary anymore, because of "UpdateTrackChanged"

  • string radio_title = 9

• rpc VolumeUp (Empty, VolumeReply)

  player.proto:11

• rpc VolumeDown (Empty, VolumeReply)

  player.proto:12

• rpc SpeedUp (Empty, SpeedReply)

  player.proto:13

• rpc SpeedDown (Empty, SpeedReply)

  player.proto:14

• rpc ToggleGapless (Empty, GaplessState)

  player.proto:16

  Toggle the gapless mdoe, returns the new state.

• rpc SeekForward (Empty, PlayerTime)

  player.proto:17

• rpc SeekBackward (Empty, PlayerTime)

  player.proto:18

• rpc PlaySpecific (PlaylistPlaySpecific, Empty)

  player.proto:23

  Playlist Commands Skip to a specific track in the playlist at the momemnt, the one set via "current_track_index"

  message PlaylistPlaySpecific

  player.proto:160

  Play a specific track in the playlist

  • uint64 track_index = 1

  • optional TrackId id = 2

• rpc CycleLoop (Empty, PlaylistLoopMode)

  player.proto:25

  Cycle the playlist loop mode, returns the new mode.

• rpc AddToPlaylist (PlaylistTracksToAdd, Empty)

  player.proto:27

  Add one or multiple tracks to the playlist

  message PlaylistTracksToAdd

  player.proto:233

  Add multiple tracks to a Playlist

  • uint64 at_index = 1

    The index the track(s) are added at. If this is not at the end, all tracks at that index and after need to be shifted to make place for this new one.

  • repeated TrackId tracks = 2

    All the Tracks to add at the index

• rpc RemoveFromPlaylist (PlaylistTracksToRemove, Empty)

  player.proto:29

  Remove one or multiple tracks from the playlist

  message PlaylistTracksToRemove

  player.proto:243

  Remove multiple track or clear the playlist

  • oneof type

    • PlaylistTracksToRemoveIndexed indexed = 1

    • PlaylistTracksToRemoveClear clear = 2

• rpc SwapTracks (PlaylistSwapTracks, Empty)

  player.proto:31

  Swap some tracks.

• rpc GetPlaylist (Empty, PlaylistTracks)

  player.proto:33

  Get all tracks of the playlist.

• rpc ShufflePlaylist (Empty, Empty)

  player.proto:35

  Shuffle the playlist, returns the new playlist tracks.

• rpc RemoveDeletedTracks (Empty, Empty)

  player.proto:38

  Check for and remove deleted items from the playlist. Unlike shuffle, this will send Removal events

• rpc ReloadConfig (Empty, Empty)

  player.proto:41

  Misc Commands

• rpc SubscribeServerUpdates (Empty, stream StreamUpdates)

  player.proto:42

  message StreamUpdates

  player.proto:94

  all updates that can happen from the server side, without the client to have to ask explicitly naming convention for the stream update specific messages is to add the "Update" prefix, even if it already exists

  • oneof type

    • UpdateMissedEvents missed_events = 1

    • UpdateVolumeChanged volume_changed = 2

    • UpdateSpeedChanged speed_changed = 3

    • UpdatePlayStateChanged play_state_changed = 4

    • UpdateTrackChanged track_changed = 5

    • UpdateGaplessChanged gapless_changed = 6

    • UpdatePlaylist playlist_changed = 7

using a custom Duration that matches rust's definition, as rust's may not fit into google's well-known Duration

Used in: PlayerTime, PlaylistAddTrack

• uint64 secs = 1

• uint32 nanos = 2

Used as request type in: MusicPlayer.CycleLoop, MusicPlayer.GetPlaylist, MusicPlayer.GetProgress, MusicPlayer.ReloadConfig, MusicPlayer.RemoveDeletedTracks, MusicPlayer.SeekBackward, MusicPlayer.SeekForward, MusicPlayer.ShufflePlaylist, MusicPlayer.SkipNext, MusicPlayer.SkipPrevious, MusicPlayer.SpeedDown, MusicPlayer.SpeedUp, MusicPlayer.SubscribeServerUpdates, MusicPlayer.ToggleGapless, MusicPlayer.TogglePause, MusicPlayer.VolumeDown, MusicPlayer.VolumeUp

Used as response type in: MusicPlayer.AddToPlaylist, MusicPlayer.PlaySpecific, MusicPlayer.ReloadConfig, MusicPlayer.RemoveDeletedTracks, MusicPlayer.RemoveFromPlaylist, MusicPlayer.ShufflePlaylist, MusicPlayer.SkipNext, MusicPlayer.SkipPrevious, MusicPlayer.SwapTracks

(message has no fields)

A Gapless state.

Used as response type in: MusicPlayer.ToggleGapless

Used as field type in: UpdateGaplessChanged

• bool gapless = 1

A play status.

Used as response type in: MusicPlayer.TogglePause

Used as field type in: UpdatePlayStateChanged

• uint32 status = 1

  The actual status, mapped to [`playback::playlist::Status`]

Used as response type in: MusicPlayer.SeekBackward, MusicPlayer.SeekForward

Used as field type in: GetProgressResponse, UpdateTrackChanged

• optional Duration position = 1

• optional Duration total_duration = 2

A Track got added to the playlist, this message contains where it was added and all the metadata required for display.

Used in: PlaylistTracks, UpdatePlaylist

• uint64 at_index = 1

  The index the track was added to the playlist. If this is not at the end, all tracks at that index and after need to be shifted to make place for this new one.

• oneof optional_title

  all values below should be moved into their own "Track" message at some point instead of having the TUI fetch everything from the file itself radio title, track title the following is (linux protobuf) 3.15, ubuntu 2204 still has (linux protobuf) 3.12 optional string title = 3; the following "oneof" is wire equivalent to the above "optional"

  • string title = 2

• optional Duration duration = 3

• optional TrackId id = 4

  The Id of the track that was added

The Playlist got completely cleared

empty as there are no values, but not using "Empty" to have a unique message id

Used in: UpdatePlaylist

(message has no fields)

The current Loop mode for the playlist

Used as response type in: MusicPlayer.CycleLoop

Used as field type in: UpdatePlaylist

• uint32 mode = 1

  The actual mode, mapped to [`config::v2::server::LoopMode`]

A Track got removed from the playlist.

Used in: UpdatePlaylist

• uint64 at_index = 1

  The index of the track that was removed.

• optional TrackId id = 2

  The Id of the track that was removed

/ Indicate that the playlist has been shuffled and should be re-fetched

Used in: UpdatePlaylist

• optional PlaylistTracks shuffled = 1

Some track needs to be swapped.

Used as request type in: MusicPlayer.SwapTracks

Used as field type in: UpdatePlaylist

• uint64 index_a = 1

  The first index to swap

• uint64 index_b = 2

  The second index to swap

All tracks in the current playlist, they *should* be ordered from lowest to highest index.

Used as response type in: MusicPlayer.GetPlaylist

Used as field type in: PlaylistShuffled

• uint64 current_track_index = 1

• repeated PlaylistAddTrack tracks = 2

/ Clear the entire playlist

empty as there are no values, but not using "Empty" to have a unique message id

Used in: PlaylistTracksToRemove

(message has no fields)

Remove multiple tracks from a playlist

Used in: PlaylistTracksToRemove

• uint64 at_index = 1

  The index the track(s) that are removed This is the starting index, and x amount of elements are removed after

• repeated TrackId tracks = 2

  All the Tracks to remove at the index

Used as response type in: MusicPlayer.SpeedDown, MusicPlayer.SpeedUp

Used as field type in: UpdateSpeedChanged

• int32 speed = 1

A Identifier for a track.

Used in: PlaylistAddTrack, PlaylistPlaySpecific, PlaylistRemoveTrack, PlaylistTracksToAdd, PlaylistTracksToRemoveIndexed

• oneof source

  • string path = 1

    Path on the system bytes *could* be used, but it way more complex and platform dependant

  • string url = 2

    Url (ex. radio)

  • string podcastUrl = 3

    A podcast episode

The Gapless state changed, send new information.

Used in: StreamUpdates

• optional GaplessState msg = 1

  reuse the existing message

Indicate that some events could not be send Like a "Lagged" Error from tokio-stream

Used in: StreamUpdates

• uint64 amount = 1

TODO: is play-state (playing / paused / ??) the only things this should do?

Used in: StreamUpdates

• optional PlayState msg = 1

  reuse the existing message

Used in: StreamUpdates

• oneof type

  • PlaylistAddTrack add_track = 1

  • PlaylistRemoveTrack remove_track = 2

  • PlaylistCleared cleared = 3

  • PlaylistLoopMode loop_mode = 4

  • PlaylistSwapTracks swap_tracks = 5

  • PlaylistShuffled shuffled = 6

The Speed changed, send new information

Used in: StreamUpdates

• optional SpeedReply msg = 1

  reuse the existing message

The track changed in some way, send new information This includes everything from changing to a new track, new radio title, etc This is *not* used for regular track progress updates NOTE: this may or may not be sent for the initial track after startup as the client may connect after the track started

Used in: StreamUpdates

• uint64 current_track_index = 1

  The index into the playlist of which track changed.

• bool current_track_updated = 2

  Indicates if this update is a change to a new track (not just metadata change)

• oneof optional_title

  all values below should be moved into their own "Track" message at some point instead of having the TUI fetch everything from the file itself radio title, track title the following is (linux protobuf) 3.15, ubuntu 2204 still has (linux protobuf) 3.12 optional string title = 3; the following "oneof" is wire equivalent to the above "optional"

  • string title = 3

• optional PlayerTime progress = 4

The Volume changed, send new information

Used in: StreamUpdates

• optional VolumeReply msg = 1

  reuse the existing message

Used as response type in: MusicPlayer.VolumeDown, MusicPlayer.VolumeUp

Used as field type in: UpdateVolumeChanged

• uint32 volume = 1

  actually a u16, but protobuf does not support types lower than 32 bits