MediaPlayerInterfaceConfiguration
HTTP API schema
Advertise only implemented media controls.
MediaPlayerInterfaceConfiguration fields
- supportedMediaResources
array<SupportedMediaResource> Accepted play-media URIs for this route only, not member or endpoint unions.
- supportedAudioProviders
array<MediaProvider> Search-and-play audio services, not active subscriptions.
uniqueItems: true
- ItemMediaProvider
- supportedVideoProviders
array<MediaProvider> Search-and-play video services, not installed apps/subscriptions.
uniqueItems: true
- ItemMediaProvider
- defaultAudioProviderstring
Default service for an audio search. Must be in supportedAudioProviders.
Allowed values
SPOTIFYAMAZON_MUSICAPPLE_MUSICAUDIBLETUNE_INPANDORAIHEART_RADIOSIRIUSXMDEEZERTIDALYOUTUBENETFLIXPRIME_VIDEODAILYMOTION
- defaultVideoProviderstring
Default service for a video search. Must be in supportedVideoProviders.
Allowed values
SPOTIFYAMAZON_MUSICAPPLE_MUSICAUDIBLETUNE_INPANDORAIHEART_RADIOSIRIUSXMDEEZERTIDALYOUTUBENETFLIXPRIME_VIDEODAILYMOTION
- supportedPlaybackStates
array<PlaybackState> - ItemPlaybackState
- supportedPlaybackSpeeds
array<number> Supported playback speeds (e.g., 0.5, 1.0, 1.5, 2.0)
- seekRangeMeasurementRange
Seek range in seconds
- supportedMediaTypes
array<string> - Item
string Allowed values
AUDIOVIDEOIMAGEPLAYLIST
- Item
- supportedFormats
array<string> Command-specific formats; FILE/LIVE_STREAM can differ. See supportedMediaResources (catalog), supportedAudioMimeTypes (play-audio), supportedVideoMimeTypes (play-video) and supportedImageMimeTypes (show-images).
- Item
string Allowed values
MP3WAVFLACAACOGGMP4AVIMKVJPGPNGGIF
- Item
- maxPlaylistSize
integer Maximum number of items in a playlist
minimum: 1
maximum: 10000
- defaultQuality
string Default quality setting for media playback
Allowed values
LOWMEDIUMHIGHLOSSLESS
- supportsPlayURI
boolean Whether the endpoint can play an audio URI.
- supportedURISourceTypes
array<AudioUriSourceType> Exact source kinds accepted by play-uri on this route. With URI support, omission admits FILE only; an empty list admits none. LIVE_STREAM must be explicitly listed. This does not resolve provider catalog identities.
uniqueItems: true
- supportedAudioMimeTypes
array<string> Audio MIME types accepted by play-audio. Advertise play-audio only when audio output is supported.
- supportedVideoMimeTypes
array<string> Video MIME types accepted by play-video. Advertise play-video only when the endpoint has a screen that plays them.
uniqueItems: true
- supportedImageMimeTypes
array<string> Image MIME types accepted by show-images and add-images. Advertise those messages only when the endpoint has a screen that shows them.
uniqueItems: true
- maxAudioDurationSeconds
integer Maximum encoded duration accepted by play-audio. Longer inputs are rejected without truncation.
minimum: 1
maximum: 86400
- audioPlaybackMode
string CLIP means finite immediate play-audio playback, which may interrupt or duck current content. QUEUE means finite controllable play-audio playback that replaces the current playback session. Neither mode appends to an existing queue, resolves a provider track, or establishes a live stream.
Allowed values
CLIPQUEUE