Skip to main content

Interface: SourceSearchCriteria

Search, filtering, and lookup values passed to a source addon.

Properties​

query?​

optional query?: string

Free-text query entered by the user.

types?​

optional types?: SourceMediaType[]

Media types that may be returned.

genreTmdbIds?​

optional genreTmdbIds?: number[]

TMDB genre identifiers that returned items should match.

year?​

optional year?: number

Four-digit production or release year.

sortBy?​

optional sortBy?: SourceSortOption

Sort mode requested by the host.

limit?​

optional limit?: number

Maximum preferred number of logical items in the page.

parentTmdbId?​

optional parentTmdbId?: number

TMDB identifier of the parent series or container.

parentSeason?​

optional parentSeason?: number

Season number of the requested parent context.

parentEpisode?​

optional parentEpisode?: number

Episode number of the requested parent context.

parentTitle?​

optional parentTitle?: string

Human-readable parent title for sources without a stable metadata ID.

targetTmdbId?​

optional targetTmdbId?: number

Direct TMDB lookup target.

targetImdbId?​

optional targetImdbId?: string

Direct IMDb lookup target.

targetSourceItemId?​

optional targetSourceItemId?: string

Opaque item ID previously returned by this source for the selected media. During source selection, prefer this value over an enriched or localized title when it belongs to the receiving source.

isSourceSelection?​

optional isSourceSelection?: boolean

Whether the request is selecting playback for a known item. Sources that advertise playback variants should return one playable item per variant.

noEnrich?​

optional noEnrich?: boolean

Whether the host asks the source to avoid optional metadata enrichment.

noFacets?​

optional noFacets?: boolean

Whether the source may omit expensive facet computation.