Skip to main content

Interface: PluginSourceCatalogQuery

Filters used when listing the addon's persisted source catalog.

Extends​

Properties​

pageToken?​

optional pageToken?: string | number

Opaque page token returned by the previous query.

mediaId?​

optional mediaId?: string

Direct logical-media lookup, primarily used by resolvePlayback.

query?​

optional query?: string

Free-text query entered by the user.

Inherited from​

SourceSearchCriteria.query

types?​

optional types?: SourceMediaType[]

Media types that may be returned.

Inherited from​

SourceSearchCriteria.types

genreTmdbIds?​

optional genreTmdbIds?: number[]

TMDB genre identifiers that returned items should match.

Inherited from​

SourceSearchCriteria.genreTmdbIds

year?​

optional year?: number

Four-digit production or release year.

Inherited from​

SourceSearchCriteria.year

sortBy?​

optional sortBy?: SourceSortOption

Sort mode requested by the host.

Inherited from​

SourceSearchCriteria.sortBy

limit?​

optional limit?: number

Maximum preferred number of logical items in the page.

Inherited from​

SourceSearchCriteria.limit

parentTmdbId?​

optional parentTmdbId?: number

TMDB identifier of the parent series or container.

Inherited from​

SourceSearchCriteria.parentTmdbId

parentSeason?​

optional parentSeason?: number

Season number of the requested parent context.

Inherited from​

SourceSearchCriteria.parentSeason

parentEpisode?​

optional parentEpisode?: number

Episode number of the requested parent context.

Inherited from​

SourceSearchCriteria.parentEpisode

parentTitle?​

optional parentTitle?: string

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

Inherited from​

SourceSearchCriteria.parentTitle

targetTmdbId?​

optional targetTmdbId?: number

Direct TMDB lookup target.

Inherited from​

SourceSearchCriteria.targetTmdbId

targetImdbId?​

optional targetImdbId?: string

Direct IMDb lookup target.

Inherited from​

SourceSearchCriteria.targetImdbId

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.

Inherited from​

SourceSearchCriteria.targetSourceItemId

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.

Inherited from​

SourceSearchCriteria.isSourceSelection

noEnrich?​

optional noEnrich?: boolean

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

Inherited from​

SourceSearchCriteria.noEnrich

noFacets?​

optional noFacets?: boolean

Whether the source may omit expensive facet computation.

Inherited from​

SourceSearchCriteria.noFacets