Skip to content

Jellyfin - Plugins - "Subtitle Extract" - Config

Configuration options for jellyfin plugins "Subtitle Extract" config.

Available Options

This page documents 11 configuration options.

nixflix.jellyfin.plugins."Subtitle Extract".config

Plugin to automatically extract embedded subtitles.

Typesubmodule
Default
{ }
Declared inmodules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.AllSubtitleCodecs

Full list of all supported subtitle codecs with their display names. Only works when IsAdvancedMode = true;.

Typelist of (submodule)
Default
[
  {
    Text = "ASS (Advanced SSA) subtitle (.ass & .ssa files - often found on anime)";
    Value = "ass";
  }
  {
    Text = "DVD subtitles";
    Value = "DVDSUB";
  }
  {
    Text = "SubRip subtitle (.srt files - most common type of subtitles)";
    Value = "subrip";
  }
  {
    Text = "HDMV Presentation Graphic Stream subtitles (often found on Blu-ray)";
    Value = "PGSSUB";
  }
  {
    Text = "DVB subtitles";
    Value = "DVBSUB";
  }
  {
    Text = "EIA-608 closed captions";
    Value = "eia_608";
  }
  {
    Text = "JACOsub subtitle";
    Value = "jacosub";
  }
  {
    Text = "MicroDVD subtitle";
    Value = "microdvd";
  }
  {
    Text = "MOV text";
    Value = "mov_text";
  }
  {
    Text = "MPL2 subtitle";
    Value = "mpl2";
  }
  {
    Text = "PJS (Phoenix Japanimation Society) subtitle";
    Value = "pjs";
  }
  {
    Text = "RealText subtitle";
    Value = "realtext";
  }
  {
    Text = "SAMI subtitle";
    Value = "sami";
  }
  {
    Text = "Spruce subtitle format";
    Value = "stl";
  }
  {
    Text = "SubViewer subtitle";
    Value = "subviewer";
  }
  {
    Text = "SubViewer v1 subtitle";
    Value = "subviewer1";
  }
  {
    Text = "raw UTF-8 text";
    Value = "text";
  }
  {
    Text = "VPlayer subtitle";
    Value = "vplayer";
  }
  {
    Text = "WebVTT subtitle";
    Value = "webvtt";
  }
  {
    Text = "XSUB";
    Value = "xsub";
  }
]
Declared inmodules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.AllSubtitleCodecs.*.Text

Human-readable display name and description of the subtitle format.


nixflix.jellyfin.plugins."Subtitle Extract".config.AllSubtitleCodecs.*.Value

Codec identifier used internally to reference the subtitle format.


nixflix.jellyfin.plugins."Subtitle Extract".config.ExtractionDuringLibraryScan

Whether to extract embedded subtitles and attachments during a library scan.

Typeboolean
Default
false
Declared inmodules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.IncludeGraphicalSubtitles

Includes: DVD subtitles (VOBSUB), Blu-ray subtitles (PGS), and other image-based formats. It will extract subtitles from medias containing at least one graphical subtitle.

Typeboolean
Default
true
Declared inmodules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.IncludeTextSubtitles

Includes: SRT, ASS/SSA, WebVTT, and other text-based subtitle formats. It will extract subtitles from medias containing only text subtitles.

Typeboolean
Default
true
Declared inmodules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.IsAdvancedMode

Enable advanced codec selection for fine-grained control

Typeboolean
Default
false
Declared inmodules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.SelectedAttachmentsLibraries

List of libraries from which attachments will be extracted.

Typelist of string
Default
[ ]
Declared inmodules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.SelectedCodecs

Limit subtitle extraction to media with all subtitle streams matching the selected codecs. Only works when IsAdvancedMode = true;.

Typelist of string
Default
[
  "ass"
  "DVDSUB"
  "subrip"
  "PGSSUB"
  "DVBSUB"
  "eia_608"
  "jacosub"
  "microdvd"
  "mov_text"
  "mpl2"
  "pjs"
  "realtext"
  "sami"
  "stl"
  "subviewer"
  "subviewer1"
  "text"
  "vplayer"
  "webvtt"
  "xsub"
]
Declared inmodules/jellyfin/plugins/subtitleExtract.nix

nixflix.jellyfin.plugins."Subtitle Extract".config.SelectedSubtitlesLibraries

List of libraries from which subtitles will be extracted.

Typelist of string
Default
[ ]
Declared inmodules/jellyfin/plugins/subtitleExtract.nix