Skip to content

response_schemas.md

Latest commit

 

History

History
168 lines (122 loc) · 3.8 KB

response_schemas.md

File metadata and controls

168 lines (122 loc) · 3.8 KB

Schemas

Service Schemas

GetQueueItemsResponseSchema

[player_name: str]: QueueItemSchema[]

GetGroupVolumeResponseSchema

volume_level: int

SendCommandResponseSchema

response: any

GetRecommendationsResponseSchema

response: RecommendationFolder[]

GetAlbumResponseSchema

See music_assistant_models.media_items.Album

GetArtistResponseSchema

See music_assistant_models.media_items.Artist

GetPlaylistResponseSchema

See music_assistant_models.media_items.Playlist

GetPodcastResponseSchema

See music_assistant_models.media_items.Podcast

GetAlbumTracksResponseSchema

tracks: TrackSchema[]

GetArtistTracksResponseSchema

tracks: TrackSchema[]

GetPlaylistTracksResponseSchema

tracks: PlaylistTrackSchema[]

GetPodcastEpisodesResponseSchema

episodes: PodcastEpisodeSchema[]

WebSocket Schemas

GetInfoResponseSchema

available: bool
can_group_with: str[]       # List of player IDs that can be natively synced using `media_player.join`
connection:
  configuration_url: str    # URL to configure the player from Music Assistant
  url: str                  # IP Address for player
entries:                    # Config Entry IDs for the player's HA integrations
  music_assistant: str
  mass_queue: str
features: str[]             # List of features which the player supports
manufacturer: str
model: str
name: str
player_id: str              # ID of player in Music Assistant
provider: str
queue_id: str               # ID for queue currently playing on player
server:
  connection:
    url: str                # URL to access Music Assistant integration
    websocket: str          # WebSocket address to interact with player
synced_to: str| None        # Player(s) which are currently synced/grouped/joined with the player
type: str

GetUser

See music_assistant_models.auth.User

DownloadAndEncodeImageResponseSchema

<Base64 encoded string representation of image>

Sub-schemas

QueueItemSchema

queue_item_id: str
media_title: str
media_album_name: str
media_artist: str
media_content_id: str
media_image: str
favorite: bool

TrackSchema

media_title: str
media_content_id: str
duration?: int
media_image: str
local_image_encoded?: str
favorite: bool
media_album_name: str
media_artist: str

PlaylistTrackSchema

media_title: str
media_content_id: str
duration?: int
media_image: str
local_image_encoded?: str
favorite: bool
media_album_name: str
media_artist: str
position: int

PodcastEpisodeSchema

media_title: str
media_content_id: str
duration?: int
media_image: str
local_image_encoded?: str
favorite: bool
media_album_name: str
media_artist: str
release_date: str

Note: release date is a string representation of a date, formatted as YYYY-MM-DDTHH:MM:SS.

RecommendationFolder

See music_assistant_models.media_items.RecommendationFolder