Skip to content

MediaPlayerInterfaceConfiguration

HTTP API schema

Advertise only implemented media controls.

MediaPlayerInterfaceConfiguration fields

supportedMediaResourcesarray<SupportedMediaResource>

Accepted play-media URIs for this route only, not member or endpoint unions.

supportedAudioProvidersarray<MediaProvider>

Search-and-play audio services, not active subscriptions.

uniqueItems: true

supportedVideoProvidersarray<MediaProvider>

Search-and-play video services, not installed apps/subscriptions.

uniqueItems: true

defaultAudioProviderstring

Default service for an audio search. Must be in supportedAudioProviders.

defaultVideoProviderstring

Default service for a video search. Must be in supportedVideoProviders.

supportedPlaybackStatesarray<PlaybackState>
supportedPlaybackSpeedsarray<number>

Supported playback speeds (e.g., 0.5, 1.0, 1.5, 2.0)

seekRangeMeasurementRange

Seek range in seconds

supportedMediaTypesarray<string>
Itemstring

Allowed values

  • AUDIO
  • VIDEO
  • IMAGE
  • PLAYLIST
supportedFormatsarray<string>

Command-specific formats; FILE/LIVE_STREAM can differ. See supportedMediaResources (catalog), supportedAudioMimeTypes (play-audio), supportedVideoMimeTypes (play-video) and supportedImageMimeTypes (show-images).

Itemstring
maxPlaylistSizeinteger

Maximum number of items in a playlist

minimum: 1

maximum: 10000

defaultQualitystring

Default quality setting for media playback

Allowed values

  • LOW
  • MEDIUM
  • HIGH
  • LOSSLESS
supportsPlayURIboolean

Whether the endpoint can play an audio URI.

supportedURISourceTypesarray<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

supportedAudioMimeTypesarray<string>

Audio MIME types accepted by play-audio. Advertise play-audio only when audio output is supported.

supportedVideoMimeTypesarray<string>

Video MIME types accepted by play-video. Advertise play-video only when the endpoint has a screen that plays them.

uniqueItems: true

supportedImageMimeTypesarray<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

maxAudioDurationSecondsinteger

Maximum encoded duration accepted by play-audio. Longer inputs are rejected without truncation.

minimum: 1

maximum: 86400

audioPlaybackModestring

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

  • CLIP
  • QUEUE
View source specification ↗