Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias LibraryOptions

    type LibraryOptions = {
        Enabled?: boolean;
        EnablePhotos?: boolean;
        EnableRealtimeMonitor?: boolean;
        EnableLUFSScan?: boolean;
        EnableChapterImageExtraction?: boolean;
        ExtractChapterImagesDuringLibraryScan?: boolean;
        EnableTrickplayImageExtraction?: boolean;
        ExtractTrickplayImagesDuringLibraryScan?: boolean;
        PathInfos?: MediaPathInfo[];
        SaveLocalMetadata?: boolean;
        EnableInternetProviders?: boolean;
        EnableAutomaticSeriesGrouping?: boolean;
        EnableEmbeddedTitles?: boolean;
        EnableEmbeddedExtrasTitles?: boolean;
        EnableEmbeddedEpisodeInfos?: boolean;
        AutomaticRefreshIntervalDays?: number;
        PreferredMetadataLanguage?: string | null;
        MetadataCountryCode?: string | null;
        SeasonZeroDisplayName?: string;
        MetadataSavers?: string[] | null;
        DisabledLocalMetadataReaders?: string[];
        LocalMetadataReaderOrder?: string[] | null;
        DisabledSubtitleFetchers?: string[];
        SubtitleFetcherOrder?: string[];
        DisabledMediaSegmentProviders?: string[];
        MediaSegmentProviderOrder?: string[];
        SkipSubtitlesIfEmbeddedSubtitlesPresent?: boolean;
        SkipSubtitlesIfAudioTrackMatches?: boolean;
        SubtitleDownloadLanguages?: string[] | null;
        RequirePerfectSubtitleMatch?: boolean;
        SaveSubtitlesWithMedia?: boolean;
        SaveLyricsWithMedia?: boolean;
        SaveTrickplayWithMedia?: boolean;
        DisabledLyricFetchers?: string[];
        LyricFetcherOrder?: string[];
        PreferNonstandardArtistsTag?: boolean;
        UseCustomTagDelimiters?: boolean;
        CustomTagDelimiters?: string[];
        DelimiterWhitelist?: string[];
        AutomaticallyAddToCollection?: boolean;
        AllowEmbeddedSubtitles?:
            | "AllowAll"
            | "AllowText"
            | "AllowImage"
            | "AllowNone";
        TypeOptions?: TypeOptions[];
    }
    Index
    Enabled?: boolean
    EnablePhotos?: boolean
    EnableRealtimeMonitor?: boolean
    EnableLUFSScan?: boolean
    EnableChapterImageExtraction?: boolean
    ExtractChapterImagesDuringLibraryScan?: boolean
    EnableTrickplayImageExtraction?: boolean
    ExtractTrickplayImagesDuringLibraryScan?: boolean
    PathInfos?: MediaPathInfo[]
    SaveLocalMetadata?: boolean
    EnableInternetProviders?: boolean
    EnableAutomaticSeriesGrouping?: boolean
    EnableEmbeddedTitles?: boolean
    EnableEmbeddedExtrasTitles?: boolean
    EnableEmbeddedEpisodeInfos?: boolean
    AutomaticRefreshIntervalDays?: number
    PreferredMetadataLanguage?: string | null

    Gets or sets the preferred metadata language.

    MetadataCountryCode?: string | null

    Gets or sets the metadata country code.

    SeasonZeroDisplayName?: string
    MetadataSavers?: string[] | null
    DisabledLocalMetadataReaders?: string[]
    LocalMetadataReaderOrder?: string[] | null
    DisabledSubtitleFetchers?: string[]
    SubtitleFetcherOrder?: string[]
    DisabledMediaSegmentProviders?: string[]
    MediaSegmentProviderOrder?: string[]
    SkipSubtitlesIfEmbeddedSubtitlesPresent?: boolean
    SkipSubtitlesIfAudioTrackMatches?: boolean
    SubtitleDownloadLanguages?: string[] | null
    RequirePerfectSubtitleMatch?: boolean
    SaveSubtitlesWithMedia?: boolean
    SaveLyricsWithMedia?: boolean
    SaveTrickplayWithMedia?: boolean
    DisabledLyricFetchers?: string[]
    LyricFetcherOrder?: string[]
    PreferNonstandardArtistsTag?: boolean
    UseCustomTagDelimiters?: boolean
    CustomTagDelimiters?: string[]
    DelimiterWhitelist?: string[]
    AutomaticallyAddToCollection?: boolean
    AllowEmbeddedSubtitles?: "AllowAll" | "AllowText" | "AllowImage" | "AllowNone"

    An enum representing the options to disable embedded subs.

    TypeOptions?: TypeOptions[]