package cpb.remote

Get desktop application:
View/edit binary Protocol Buffers messages

Message request for downloading songs

Used in: RequestDownloadSongs

• CurrentItem = 1

• ItemAlbum = 2

• APlaylist = 3

• Urls = 4

Valid Engine states

Used in: ResponseClementineInfo, ResponseEngineStateChanged

• Empty = 0

• Idle = 1

• Playing = 2

• Paused = 3

Used in: ResponseListFiles

• optional string filename = 1

• optional bool is_dir = 2

Used in: ResponseGlobalSearchStatus

• GlobalSearchStarted = 1

• GlobalSearchFinished = 2

Used in: ResponseLyrics

• optional string id = 1

• optional string title = 2

• optional string content = 3

The message itself

• optional int32 version = 1

• optional MsgType type = 2

  What data is in the message?

• optional RequestConnect request_connect = 21

• optional RequestPlaylists request_playlists = 27

• optional RequestPlaylistSongs request_playlist_songs = 10

• optional RequestChangeSong request_change_song = 11

• optional RequestSetVolume request_set_volume = 12

• optional RequestSetTrackPosition request_set_track_position = 23

• optional RequestInsertUrls request_insert_urls = 25

• optional RequestRemoveSongs request_remove_songs = 26

• optional RequestOpenPlaylist request_open_playlist = 28

• optional RequestClosePlaylist request_close_playlist = 29

• optional RequestUpdatePlaylist request_update_playlist = 53

• optional RequestDownloadSongs request_download_songs = 31

• optional RequestRateSong request_rate_song = 35

• optional RequestGlobalSearch request_global_search = 37

• optional RequestListFiles request_list_files = 50

• optional RequestAppendFiles request_append_files = 51

• optional Repeat repeat = 13

• optional Shuffle shuffle = 14

• optional ResponseClementineInfo response_clementine_info = 15

• optional ResponseCurrentMetadata response_current_metadata = 16

• optional ResponsePlaylists response_playlists = 17

• optional ResponsePlaylistSongs response_playlist_songs = 18

• optional ResponseEngineStateChanged response_engine_state_changed = 19

• optional ResponseUpdateTrackPosition response_update_track_position = 20

• optional ResponseDisconnect response_disconnect = 22

• optional ResponseActiveChanged response_active_changed = 24

• optional ResponseLyrics response_lyrics = 30

• optional ResponseSongFileChunk response_song_file_chunk = 32

• optional ResponseSongOffer response_song_offer = 33

• optional ResponseLibraryChunk response_library_chunk = 34

• optional ResponseDownloadTotalSize response_download_total_size = 36

• optional ResponseGlobalSearch response_global_search = 38

• optional ResponseTranscoderStatus response_transcoder_status = 39

• optional ResponseGlobalSearchStatus response_global_search_status = 40

• optional ResponseListFiles response_list_files = 52

• optional ResponseSavedRadios response_saved_radios = 54

The supported message types

Used in: Message

• UNKNOWN = 0

• CONNECT = 1

  Messages generally send from client to server

• REQUEST_PLAYLISTS = 3

• REQUEST_PLAYLIST_SONGS = 4

• CHANGE_SONG = 5

• SET_VOLUME = 6

• SET_TRACK_POSITION = 7

• INSERT_URLS = 8

• REMOVE_SONGS = 9

• OPEN_PLAYLIST = 10

• CLOSE_PLAYLIST = 11

• UPDATE_PLAYLIST = 60

• GET_LYRICS = 14

• DOWNLOAD_SONGS = 15

• SONG_OFFER_RESPONSE = 16

• LOVE = 12

  Lastfm

• BAN = 13

• STOP_AFTER = 17

• GET_LIBRARY = 18

• RATE_SONG = 19

• GLOBAL_SEARCH = 100

• REQUEST_SAVED_RADIOS = 110

• REQUEST_FILES = 200

  access Files from remote control

• APPEND_FILES = 201

• DISCONNECT = 2

  Messages send by both

• PLAY = 20

• PLAYPAUSE = 21

• PAUSE = 22

• STOP = 23

• NEXT = 24

• PREVIOUS = 25

• SHUFFLE_PLAYLIST = 26

• REPEAT = 27

  Messages that contain the repeat or random mode Either set by client or clementine

• SHUFFLE = 28

• INFO = 40

  Messages send from server to client

• CURRENT_METAINFO = 41

• PLAYLISTS = 42

• PLAYLIST_SONGS = 43

• ENGINE_STATE_CHANGED = 44

• KEEP_ALIVE = 45

• UPDATE_TRACK_POSITION = 46

• ACTIVE_PLAYLIST_CHANGED = 47

• FIRST_DATA_SENT_COMPLETE = 48

• LYRICS = 49

• SONG_FILE_CHUNK = 50

• DOWNLOAD_QUEUE_EMPTY = 51

• LIBRARY_CHUNK = 52

• DOWNLOAD_TOTAL_SIZE = 53

• GLOBAL_SEARCH_RESULT = 54

• TRANSCODING_FILES = 55

• GLOBAL_SEARCH_STATUS = 56

• LIST_FILES = 202

  access Files from remote control

Playlist information

Used in: ResponsePlaylistSongs, ResponsePlaylists

• optional int32 id = 1

• optional string name = 2

• optional int32 item_count = 3

• optional bool active = 4

• optional bool closed = 5

• optional bool favorite = 6

Respone, why the connection was closed

Used in: ResponseDisconnect

• Server_Shutdown = 1

• Wrong_Auth_Code = 2

• Not_Authenticated = 3

• Download_Forbidden = 4

Repeat and Random messages

Used in: Message

• optional RepeatMode repeat_mode = 1

Valid Repeatmodes

Used in: Repeat

• Repeat_Off = 0

• Repeat_Track = 1

• Repeat_Album = 2

• Repeat_Playlist = 3

• Repeat_OneByOne = 4

• Repeat_Intro = 5

Used in: Message

• optional int32 playlist_id = 1

  where to append the files

• optional string new_playlist_name = 2

  or we create a new playlist

• optional string relative_path = 3

• repeated string files = 4

• optional bool play_now = 5

• optional bool clear_first = 6

Client want to change track

Used in: Message

• optional int32 playlist_id = 1

  In which playlist is the song?

• optional int32 song_index = 2

  And on which position?

Used in: Message

• optional int32 playlist_id = 1

The connect message containing the authentication code

Used in: Message

• optional int32 auth_code = 1

• optional bool send_playlist_songs = 2

• optional bool downloader = 3

Used in: Message

• optional DownloadItem download_item = 1

• optional int32 playlist_id = 2

• repeated string urls = 3

• repeated int32 songs_ids = 4

  within a Playlist, download only requested songs

• optional string relative_path = 5

  download from the FileSystem remotely using the defined root directory and the urls (filenames)

Used in: Message

• optional string query = 1

Used in: Message

• optional int32 playlist_id = 1

  In which playlist should the urls be inserted?

• repeated string urls = 2

• optional int32 position = 3

• optional bool play_now = 4

• optional bool enqueue = 5

• repeated SongMetadata songs = 6

• optional string new_playlist_name = 7

  if we wish to create a new playlist

access the FileSystem remotely from a defined root directory

Used in: Message

• optional string relative_path = 1

Messages for opening / closing playlists

Used in: Message

• optional int32 playlist_id = 1

A Client requests songs from a specific playlist

Used in: Message

• optional int32 id = 1

Used in: Message

• optional bool include_closed = 1

Used in: Message

• optional float rating = 1

  0 to 1

Client want to change track

Used in: Message

• optional int32 playlist_id = 1

  In which playlist is the songs?

• repeated int32 songs = 2

  And on which position?

A client requests a new track position position in seconds!

Used in: Message

• optional int32 position = 1

Set the volume

Used in: Message

• optional int32 volume = 1

Used in: Message

• optional int32 playlist_id = 1

• optional string new_playlist_name = 2

• optional bool favorite = 3

• optional bool create_new_playlist = 4

• optional bool clear_playlist = 5

Used in: Message

• optional int32 id = 1

Response from server General info

Used in: Message

• optional string version = 1

• optional EngineState state = 2

• optional bool allow_downloads = 3

• repeated string files_music_extensions = 4

  allowed extensions for REQUEST_FILES and LIST_FILES

The current song played

Used in: Message

• optional SongMetadata song_metadata = 1

Used in: Message

• optional ReasonDisconnect reason_disconnect = 1

Used in: Message

• optional int32 total_size = 1

• optional int32 file_count = 2

The current state of the play engine

Used in: Message

• optional EngineState state = 1

Used in: Message

• optional int32 id = 1

• optional string query = 2

• optional string search_provider = 3

• repeated SongMetadata song_metadata = 4

• optional bytes search_provider_icon = 5

Used in: Message

• optional int32 id = 1

• optional string query = 2

• optional GlobalSearchStatus status = 3

Used in: Message

• optional int32 chunk_number = 1

• optional int32 chunk_count = 2

• optional bytes data = 3

• optional int32 size = 4

• optional bytes file_hash = 5

Used in: Message

• optional string relative_path = 1

• repeated FileMetadata files = 2

• optional ResponseListFiles.Error error = 3

Used in: ResponseListFiles

• NONE = 0

• ROOT_DIR_NOT_SET = 1

• DIR_NOT_ACCESSIBLE = 2

• DIR_NOT_EXIST = 3

• UNKNOWN = 4

Message containing lyrics

Used in: Message

• repeated Lyric lyrics = 1

A list of songs in a playlist

Used in: Message

• optional Playlist requested_playlist = 1

• repeated SongMetadata songs = 2

  The songs that are in the playlist

The playlists in clementine

Used in: Message

• repeated Playlist playlist = 1

• optional bool include_closed = 2

Used in: Message

• repeated Stream streams = 1

Used in: Message

• optional int32 chunk_number = 1

• optional int32 chunk_count = 2

• optional int32 file_number = 3

• optional int32 file_count = 4

• optional SongMetadata song_metadata = 6

  only sent with first chunk!

• optional bytes data = 7

• optional int32 size = 8

• optional bytes file_hash = 9

Used in: Message

• optional bool accepted = 1

  true = client wants to download item

Used in: Message

• optional int32 processed = 1

• optional int32 total = 2

Sends the current position of the track

Used in: Message

• optional int32 position = 1

Used in: Message

• optional ShuffleMode shuffle_mode = 1

Valid Shuffle modes

Used in: Shuffle

• Shuffle_Off = 0

• Shuffle_All = 1

• Shuffle_InsideAlbum = 2

• Shuffle_Albums = 3

Song Metadata

Used in: RequestInsertUrls, ResponseCurrentMetadata, ResponseGlobalSearch, ResponsePlaylistSongs, ResponseSongFileChunk

• optional int32 id = 1

  unique id of the song

• optional int32 index = 2

  Index of the current row of the active playlist

• optional string title = 3

• optional string album = 4

• optional string artist = 5

• optional string albumartist = 6

• optional int32 track = 7

• optional int32 disc = 8

• optional string pretty_year = 9

• optional string genre = 10

• optional int32 playcount = 11

• optional string pretty_length = 12

• optional bytes art = 13

• optional int32 length = 14

• optional bool is_local = 15

• optional string filename = 16

• optional int32 file_size = 17

• optional float rating = 18

  0 (0 stars) to 1 (5 stars)

• optional string url = 19

• optional string art_automatic = 20

• optional string art_manual = 21

• optional SongMetadata.Type type = 22

Used in: SongMetadata

• UNKNOWN = 0

• ASF = 1

• FLAC = 2

• MP4 = 3

• MPC = 4

• MPEG = 5

• OGGFLAC = 6

• OGGSPEEX = 7

• OGGVORBIS = 8

• AIFF = 9

• WAV = 10

• TRUEAUDIO = 11

• CDDA = 12

• OGGOPUS = 13

• WAVPACK = 14

• SPC = 15

• VGM = 16

• APE = 17

• STREAM = 99

Used in: ResponseSavedRadios

• optional string name = 1

• optional string url = 2

• optional string url_logo = 3