package termusic.queue

Get desktop application:
View/edit binary Protocol Buffers messages

Control the Queue (also know that the playlist)

• rpc AddToPlaylist (PlaylistTracksToAddRequest, common.Empty)

  queue.proto:16

  Add one or multiple tracks to the playlist

  message PlaylistTracksToAddRequest

  queue.proto:69

  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 common.TrackId tracks = 2

    All the Tracks to add at the index

• rpc CycleLoop (common.Empty, PlaylistLoopMode)

  queue.proto:14

  Cycle the playlist loop mode, returns the new mode.

• rpc GetPlaylist (common.Empty, PlaylistState)

  queue.proto:9

  Get all tracks of the playlist.

• rpc PlaySpecific (PlaylistPlaySpecificRequest, common.Empty)

  queue.proto:12

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

  message PlaylistPlaySpecificRequest

  queue.proto:44

  Play a specific track in the playlist

  • uint64 track_index = 1

    The track index to play

  • optional common.TrackId id = 2

    The id to check that the track index is actually the one requested

• rpc RemoveDeletedTracks (common.Empty, common.Empty)

  queue.proto:27

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

• rpc RemoveFromPlaylist (PlaylistTracksToRemoveRequest, common.Empty)

  queue.proto:18

  Remove one or multiple tracks from the playlist

  message PlaylistTracksToRemoveRequest

  queue.proto:79

  Remove multiple track or clear the playlist

  • oneof type

    • PlaylistTracksToRemoveIndexed indexed = 1

    • common.Empty clear = 2

      Clear the entire playlist

• rpc ShufflePlaylist (common.Empty, common.Empty)

  queue.proto:22

  Shuffle the playlist, returns the new playlist tracks.

• rpc SortPlaylist (SortPlaylistRequest, common.Empty)

  queue.proto:24

  Sort the playlist by criterion and direction, emits PlaylistShuffled event.

  message SortPlaylistRequest

  queue.proto:98

  A request to sort the Playlist.

  • SortCriterion criterion = 1

  • SortDirection direction = 2

• rpc SwapTracks (PlaylistSwapTracksRequest, common.Empty)

  queue.proto:20

  Swap some tracks.

  message PlaylistSwapTracksRequest

  queue.proto:36

  • uint64 index_a = 1

    The first index to swap

  • uint64 index_b = 2

    The second index to swap

The current Loop mode for the playlist

Used as response type in: QueueControl.CycleLoop

Used as field type in: stream.PlaylistLoopMode

• uint32 mode = 1

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

The State of the playlist

Used as response type in: QueueControl.GetPlaylist

Used as field type in: stream.PlaylistShuffled

• uint64 current_track_index = 1

  The currently playing index

• repeated PlaylistTrack tracks = 2

  All the tracks in the playlist

A Track in the playlist

Used in: PlaylistState

• uint64 at_index = 1

  The index the track is at in the playlist

• optional common.TrackId id = 4

  The Track itself

Remove multiple tracks from a playlist at position

Used in: PlaylistTracksToRemoveRequest

• 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 common.TrackId tracks = 2

  All the Tracks to remove at the index

All the sort methods available.

Used in: SortPlaylistRequest

• ALPHANUMERIC = 0

• FIRST_ADDED = 1

• DURATION = 2

• MOST_PLAYED = 3

• RECENCY = 4

• FRECENCY = 5

All the orderings a sort can take.

Used in: SortPlaylistRequest

• ASC = 0

• DESC = 1