Refiners

Refiners enrich a Video object by adding information to it.

A refiner is a simple function:

subliminal.refiners.refine(video, **kwargs)

Parameters:

• video (Video) – the video to refine.

• kwargs – additional parameters for refiners.

Metadata

subliminal.refiners.metadata.refine(video: Video, *, embedded_subtitles: bool = True, **kwargs: Any) → Video

Refine a video by searching its metadata.

Several Video attributes can be found:

• resolution

• video_codec

• audio_codec

• subtitle_languages

Parameters:

embedded_subtitles (bool) – search for embedded subtitles.

TVDB

subliminal.refiners.tvdb.refine(video: Video, *, apikey: str | None = None, force: bool = False, **kwargs: Any) → Video

Refine a video by searching TheTVDB.

Note

This refiner only work for instances of Episode.

Several attributes can be found:

• series

• year

• series_imdb_id

• series_tvdb_id

• title

• imdb_id

• tvdb_id

OMDb

subliminal.refiners.omdb.refine(video: Video, *, apikey: str | None = None, force: bool = False, **kwargs: Any) → Video

Refine a video by searching OMDb API.

Several Episode attributes can be found:

• series

• year

• series_imdb_id

Similarly, for a Movie:

• title

• year

• imdb_id

TMDB

subliminal.refiners.tmdb.refine(video: Video, *, apikey: str | None = None, force: bool = False, **kwargs: Any) → Video

Refine a video by searching TMDB API.

Several Episode attributes can be found:

• series

• year

• series_tmdb_id

• tmdb_id

• series_imdb_id

• imdb_id

Similarly, for a Movie:

• title

• year

• tmdb_id

• imdb_id