API¶
-
subliminal.api.
PROVIDERS_ENTRY_POINT
= u'subliminal.providers'¶ Entry point for the providers
-
subliminal.api.
list_subtitles
(videos, languages, providers=None, provider_configs=None)¶ List subtitles for videos with the given languages using the specified providers
Parameters: - videos (set of
Video
) – videos to list subtitles for - languages (set of
babelfish.Language
) – languages of subtitles to search for - providers (list of string or None) – providers to use for the search, if not all
- provider_configs (dict of provider name => provider constructor kwargs) – configuration for providers
Returns: found subtitles
Return type: - videos (set of
-
subliminal.api.
download_subtitles
(subtitles, provider_configs=None, single=False)¶ Download subtitles
Parameters:
-
subliminal.api.
download_best_subtitles
(videos, languages, providers=None, provider_configs=None, single=False, min_score=0, hearing_impaired=False, hi_score_adjust=0)¶ Download the best subtitles for videos with the given languages using the specified providers
Parameters: - videos (set of
Video
) – videos to download subtitles for - languages (set of
babelfish.Language
) – languages of subtitles to download - providers (list of string or None) – providers to use for the search, if not all
- provider_configs (dict of provider name => provider constructor kwargs) – configuration for providers
- single (bool) – download with .srt extension if True, add language identifier otherwise
- min_score (int) – minimum score for subtitles to download
- hearing_impaired (bool) – download hearing impaired subtitles
- hi_score_adjust (int) – Adjust hearing_impaired_scores if matched.
- videos (set of