Skip to main content

Interface: PluginSourceCatalogItem

A source item stored in the plugin-owned native catalog.

Extends​

Properties​

genreTmdbIds?​

optional genreTmdbIds?: number[]

TMDB genre IDs used by the native index. They are not exposed to the Media Hub item.

popularity?​

optional popularity?: number

Optional sort value for sources which already provide popularity.

id​

id: string

Stable source identifier. It is passed back to resolvePlayback.

Inherited from​

SourceMediaItem.id

type​

type: SourceMediaType

Shape of this item.

Inherited from​

SourceMediaItem.type

title​

title: string

User-facing title.

Inherited from​

SourceMediaItem.title

isContainer​

isContainer: boolean

Whether selecting the item should browse children instead of starting playback.

Inherited from​

SourceMediaItem.isContainer

tmdbId?​

optional tmdbId?: number

Authoritative TMDB identifier for this media. The host may use it for enrichment and exact cross-source reconciliation; omit it when only guessed.

Inherited from​

SourceMediaItem.tmdbId

imdbId?​

optional imdbId?: string

IMDb identifier when known.

Inherited from​

SourceMediaItem.imdbId

hash?​

optional hash?: string

Optional source-provided content or deduplication hash.

Inherited from​

SourceMediaItem.hash

runTimeTicks?​

optional runTimeTicks?: number

Duration in 100-nanosecond ticks.

Inherited from​

SourceMediaItem.runTimeTicks

thumbnailUrl?​

optional thumbnailUrl?: string

Compact image suitable for rows or source-specific lists.

Inherited from​

SourceMediaItem.thumbnailUrl

premiereDate?​

optional premiereDate?: string

ISO-8601 premiere or release date.

Inherited from​

SourceMediaItem.premiereDate

productionYear?​

optional productionYear?: number

Four-digit production year.

Inherited from​

SourceMediaItem.productionYear

originalTitle?​

optional originalTitle?: string

Original-language title.

Inherited from​

SourceMediaItem.originalTitle

overview?​

optional overview?: string

Plot or content summary.

Inherited from​

SourceMediaItem.overview

rating?​

optional rating?: number

Source-provided rating normalized to the inclusive 0-to-10 scale.

Inherited from​

SourceMediaItem.rating

genres?​

optional genres?: object[]

Human-readable genres.

name​

name: string

Inherited from​

SourceMediaItem.genres

posterUrl?​

optional posterUrl?: string

Portrait artwork URL.

Inherited from​

SourceMediaItem.posterUrl

backdropUrl?​

optional backdropUrl?: string

Landscape artwork URL.

Inherited from​

SourceMediaItem.backdropUrl

seasonNumber?​

optional seasonNumber?: number

Season number for season and episode items.

Inherited from​

SourceMediaItem.seasonNumber

episodeNumber?​

optional episodeNumber?: number

Episode number for episode items.

Inherited from​

SourceMediaItem.episodeNumber

seriesTmdbId?​

optional seriesTmdbId?: number

Authoritative TMDB series identifier used to enrich and reconcile a season or episode in its parent context; omit it when only guessed.

Inherited from​

SourceMediaItem.seriesTmdbId

seriesTitle?​

optional seriesTitle?: string

Parent series title for a season or episode.

Inherited from​

SourceMediaItem.seriesTitle

childrenCount?​

optional childrenCount?: number

Number of known direct children for a container.

Inherited from​

SourceMediaItem.childrenCount

qualityLabel?​

optional qualityLabel?: string

Composite or legacy quality label. Prefer the structured fields below when known.

Inherited from​

SourceMediaItem.qualityLabel

resolution?​

optional resolution?: string

Technical resolution such as 1920x1080.

Inherited from​

SourceMediaItem.resolution

source?​

optional source?: string

Human-readable distribution origin such as WEB-DL or BluRay.

Inherited from​

SourceMediaItem.source

encoding?​

optional encoding?: string

Codec or encoding label.

Inherited from​

SourceMediaItem.encoding

language?​

optional language?: string

Audio or content language label.

Inherited from​

SourceMediaItem.language

tags?​

optional tags?: SourceTag[]

Addon-defined badges for metadata that does not fit the structured technical fields.

Inherited from​

SourceMediaItem.tags

addedAt?​

optional addedAt?: string

ISO-8601 date at which the source added this item.

Inherited from​

SourceMediaItem.addedAt