Skip to content

MediaSearchCapabilityInterfaceConfiguration

HTTP API schema

Configuration schema for media search capability interface

MediaSearchCapabilityInterfaceConfiguration fields

supportedSearchTypesarray<string>Required

List of supported search types, in upper case. The search-media type field takes the same kind in lower case (TRACK means send track).

Itemstring

Allowed values

  • TRACK
  • ALBUM
  • ARTIST
  • PLAYLIST
  • GENRE
  • YEAR
  • SHOW
  • EPISODE
maxResultsintegerRequired

Maximum number of search results to return

minimum: 1

maximum: 1000

Default: 50

supportedProvidersarray<string>Required

List of supported media providers

Itemstring

Allowed values

  • SPOTIFY
  • YOUTUBE
  • APPLE_MUSIC
  • LOCAL
  • ALL
searchTimeoutMsintegerRequired

Timeout for search operations in milliseconds

minimum: 1000

maximum: 30000

Default: 10000

View source specification ↗