Skip to main content

Interface: SourceMediaItem

Logical media or container returned by a source addon.

Extended by

Properties

id

id: string

Stable source identifier. It is passed back to resolvePlayback.


type

type: SourceMediaType

Shape of this item.


title

title: string

User-facing title.


isContainer

isContainer: boolean

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


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.


imdbId?

optional imdbId?: string

IMDb identifier when known.


hash?

optional hash?: string

Optional source-provided content or deduplication hash.


runTimeTicks?

optional runTimeTicks?: number

Duration in 100-nanosecond ticks.


thumbnailUrl?

optional thumbnailUrl?: string

Compact image suitable for rows or source-specific lists.


premiereDate?

optional premiereDate?: string

ISO-8601 premiere or release date.


productionYear?

optional productionYear?: number

Four-digit production year.


originalTitle?

optional originalTitle?: string

Original-language title.


overview?

optional overview?: string

Plot or content summary.


rating?

optional rating?: number

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


genres?

optional genres?: object[]

Human-readable genres.

name

name: string


posterUrl?

optional posterUrl?: string

Portrait artwork URL.


backdropUrl?

optional backdropUrl?: string

Landscape artwork URL.


seasonNumber?

optional seasonNumber?: number

Season number for season and episode items.


episodeNumber?

optional episodeNumber?: number

Episode number for episode items.


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.


seriesTitle?

optional seriesTitle?: string

Parent series title for a season or episode.


childrenCount?

optional childrenCount?: number

Number of known direct children for a container.


qualityLabel?

optional qualityLabel?: string

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


resolution?

optional resolution?: string

Technical resolution such as 1920x1080.


source?

optional source?: string

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


encoding?

optional encoding?: string

Codec or encoding label.


language?

optional language?: string

Audio or content language label.


tags?

optional tags?: SourceTag[]

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


addedAt?

optional addedAt?: string

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