@jellyfin/sdk
    Preparing search index...

    Interface ServerConfiguration

    Represents the server configuration.

    ServerConfiguration

    interface ServerConfiguration {
        ActivityLogRetentionDays?: number | null;
        AllowClientLogUpload?: boolean;
        CachePath?: string | null;
        CacheSize?: number;
        CastReceiverApplications?: CastReceiverApplication[];
        ChapterImageResolution?: ImageResolution;
        CodecsUsed?: string[];
        ContentTypes?: NameValuePair[];
        CorsHosts?: string[];
        DisableLiveTvChannelUserDataName?: boolean;
        DisplaySpecialsWithinSeasons?: boolean;
        DummyChapterDuration?: number;
        EnableCaseSensitiveItemIds?: boolean;
        EnableExternalContentInSuggestions?: boolean;
        EnableFolderView?: boolean;
        EnableGroupingMoviesIntoCollections?: boolean;
        EnableGroupingShowsIntoCollections?: boolean;
        EnableLegacyAuthorization?: boolean;
        EnableMetrics?: boolean;
        EnableNormalizedItemByNameIds?: boolean;
        EnableSlowResponseWarning?: boolean;
        ImageExtractionTimeoutMs?: number;
        ImageSavingConvention?: ImageSavingConvention;
        InactiveSessionThreshold?: number;
        IsPortAuthorized?: boolean;
        IsStartupWizardCompleted?: boolean;
        LibraryMetadataRefreshConcurrency?: number;
        LibraryMonitorDelay?: number;
        LibraryScanFanoutConcurrency?: number;
        LibraryUpdateDuration?: number;
        LogFileRetentionDays?: number;
        MaxAudiobookResume?: number;
        MaxResumePct?: number;
        MetadataCountryCode?: string;
        MetadataOptions?: MetadataOptions[];
        MetadataPath?: string;
        MinAudiobookResume?: number;
        MinResumeDurationSeconds?: number;
        MinResumePct?: number;
        ParallelImageEncodingLimit?: number;
        PathSubstitutions?: PathSubstitution[];
        PluginRepositories?: RepositoryInfo[];
        PreferredMetadataLanguage?: string;
        PreviousVersion?: string | null;
        PreviousVersionStr?: string | null;
        QuickConnectAvailable?: boolean;
        RemoteClientBitrateLimit?: number;
        SaveMetadataHidden?: boolean;
        ServerName?: string;
        SkipDeserializationForBasicTypes?: boolean;
        SlowResponseThresholdMs?: number;
        SortRemoveCharacters?: string[];
        SortRemoveWords?: string[];
        SortReplaceCharacters?: string[];
        TrickplayOptions?: TrickplayOptions;
        UICulture?: string;
    }
    Index

    Properties

    ActivityLogRetentionDays? AllowClientLogUpload? CachePath? CacheSize? CastReceiverApplications? ChapterImageResolution? CodecsUsed? ContentTypes? CorsHosts? DisableLiveTvChannelUserDataName? DisplaySpecialsWithinSeasons? DummyChapterDuration? EnableCaseSensitiveItemIds? EnableExternalContentInSuggestions? EnableFolderView? EnableGroupingMoviesIntoCollections? EnableGroupingShowsIntoCollections? EnableLegacyAuthorization? EnableMetrics? EnableNormalizedItemByNameIds? EnableSlowResponseWarning? ImageExtractionTimeoutMs? ImageSavingConvention? InactiveSessionThreshold? IsPortAuthorized? IsStartupWizardCompleted? LibraryMetadataRefreshConcurrency? LibraryMonitorDelay? LibraryScanFanoutConcurrency? LibraryUpdateDuration? LogFileRetentionDays? MaxAudiobookResume? MaxResumePct? MetadataCountryCode? MetadataOptions? MetadataPath? MinAudiobookResume? MinResumeDurationSeconds? MinResumePct? ParallelImageEncodingLimit? PathSubstitutions? PluginRepositories? PreferredMetadataLanguage? PreviousVersion? PreviousVersionStr? QuickConnectAvailable? RemoteClientBitrateLimit? SaveMetadataHidden? ServerName? SkipDeserializationForBasicTypes? SlowResponseThresholdMs? SortRemoveCharacters? SortRemoveWords? SortReplaceCharacters? TrickplayOptions? UICulture?

    Properties

    ActivityLogRetentionDays?: number | null

    Gets or sets the number of days we should retain activity logs.

    ServerConfiguration

    AllowClientLogUpload?: boolean

    Gets or sets a value indicating whether clients should be allowed to upload logs.

    ServerConfiguration

    CachePath?: string | null

    Gets or sets the cache path.

    ServerConfiguration

    CacheSize?: number

    Gets or sets the maximum amount of items to cache.

    ServerConfiguration

    CastReceiverApplications?: CastReceiverApplication[]

    Gets or sets the list of cast receiver applications.

    ServerConfiguration

    ChapterImageResolution?: ImageResolution

    ServerConfiguration

    CodecsUsed?: string[]

    ServerConfiguration

    ContentTypes?: NameValuePair[]

    ServerConfiguration

    CorsHosts?: string[]

    Gets or sets the cors hosts.

    ServerConfiguration

    DisableLiveTvChannelUserDataName?: boolean

    ServerConfiguration

    DisplaySpecialsWithinSeasons?: boolean

    ServerConfiguration

    DummyChapterDuration?: number

    Gets or sets the dummy chapter duration in seconds, use 0 (zero) or less to disable generation altogether.

    ServerConfiguration

    EnableCaseSensitiveItemIds?: boolean

    Gets or sets a value indicating whether [enable case-sensitive item ids].

    ServerConfiguration

    EnableExternalContentInSuggestions?: boolean

    ServerConfiguration

    EnableFolderView?: boolean

    ServerConfiguration

    EnableGroupingMoviesIntoCollections?: boolean

    ServerConfiguration

    EnableGroupingShowsIntoCollections?: boolean

    ServerConfiguration

    EnableLegacyAuthorization?: boolean

    Gets or sets a value indicating whether old authorization methods are allowed.

    ServerConfiguration

    EnableMetrics?: boolean

    Gets or sets a value indicating whether to enable prometheus metrics exporting.

    ServerConfiguration

    EnableNormalizedItemByNameIds?: boolean

    ServerConfiguration

    EnableSlowResponseWarning?: boolean

    Gets or sets a value indicating whether slow server responses should be logged as a warning.

    ServerConfiguration

    ImageExtractionTimeoutMs?: number

    ServerConfiguration

    ImageSavingConvention?: ImageSavingConvention

    ServerConfiguration

    InactiveSessionThreshold?: number

    Gets or sets the threshold in minutes after a inactive session gets closed automatically. If set to 0 the check for inactive sessions gets disabled.

    ServerConfiguration

    IsPortAuthorized?: boolean

    Gets or sets a value indicating whether this instance is port authorized.

    ServerConfiguration

    IsStartupWizardCompleted?: boolean

    Gets or sets a value indicating whether this instance is first run.

    ServerConfiguration

    LibraryMetadataRefreshConcurrency?: number

    Gets or sets the how many metadata refreshes can run concurrently.

    ServerConfiguration

    LibraryMonitorDelay?: number

    Gets or sets the delay in seconds that we will wait after a file system change to try and discover what has been added/removed Some delay is necessary with some items because their creation is not atomic. It involves the creation of several different directories and files.

    ServerConfiguration

    LibraryScanFanoutConcurrency?: number

    Gets or sets the how the library scan fans out.

    ServerConfiguration

    LibraryUpdateDuration?: number

    Gets or sets the duration in seconds that we will wait after a library updated event before executing the library changed notification.

    ServerConfiguration

    LogFileRetentionDays?: number

    Gets or sets the number of days we should retain log files.

    ServerConfiguration

    MaxAudiobookResume?: number

    Gets or sets the remaining minutes of a book that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.

    ServerConfiguration

    MaxResumePct?: number

    Gets or sets the maximum percentage of an item that can be played while still saving playstate. If this percentage is crossed playstate will be reset to the beginning and the item will be marked watched.

    ServerConfiguration

    MetadataCountryCode?: string

    Gets or sets the metadata country code.

    ServerConfiguration

    MetadataOptions?: MetadataOptions[]

    ServerConfiguration

    MetadataPath?: string

    Gets or sets the metadata path.

    ServerConfiguration

    MinAudiobookResume?: number

    Gets or sets the minimum minutes of a book that must be played in order for playstate to be updated.

    ServerConfiguration

    MinResumeDurationSeconds?: number

    Gets or sets the minimum duration that an item must have in order to be eligible for playstate updates..

    ServerConfiguration

    MinResumePct?: number

    Gets or sets the minimum percentage of an item that must be played in order for playstate to be updated.

    ServerConfiguration

    ParallelImageEncodingLimit?: number

    Gets or sets the limit for parallel image encoding.

    ServerConfiguration

    PathSubstitutions?: PathSubstitution[]

    ServerConfiguration

    PluginRepositories?: RepositoryInfo[]

    ServerConfiguration

    PreferredMetadataLanguage?: string

    Gets or sets the preferred metadata language.

    ServerConfiguration

    PreviousVersion?: string | null

    Gets or sets the last known version that was ran using the configuration.

    ServerConfiguration

    PreviousVersionStr?: string | null

    Gets or sets the stringified PreviousVersion to be stored/loaded, because System.Version itself isn't xml-serializable.

    ServerConfiguration

    QuickConnectAvailable?: boolean

    Gets or sets a value indicating whether quick connect is available for use on this server.

    ServerConfiguration

    RemoteClientBitrateLimit?: number

    ServerConfiguration

    SaveMetadataHidden?: boolean

    ServerConfiguration

    ServerName?: string

    ServerConfiguration

    SkipDeserializationForBasicTypes?: boolean

    ServerConfiguration

    SlowResponseThresholdMs?: number

    Gets or sets the threshold for the slow response time warning in ms.

    ServerConfiguration

    SortRemoveCharacters?: string[]

    Gets or sets characters to be removed from strings to create a sort name.

    ServerConfiguration

    SortRemoveWords?: string[]

    Gets or sets words to be removed from strings to create a sort name.

    ServerConfiguration

    SortReplaceCharacters?: string[]

    Gets or sets characters to be replaced with a ' ' in strings to create a sort name.

    ServerConfiguration

    TrickplayOptions?: TrickplayOptions

    ServerConfiguration

    UICulture?: string

    ServerConfiguration

    Settings

    Member Visibility

    On This Page

    Properties
    ActivityLogRetentionDaysAllowClientLogUploadCachePathCacheSizeCastReceiverApplicationsChapterImageResolutionCodecsUsedContentTypesCorsHostsDisableLiveTvChannelUserDataNameDisplaySpecialsWithinSeasonsDummyChapterDurationEnableCaseSensitiveItemIdsEnableExternalContentInSuggestionsEnableFolderViewEnableGroupingMoviesIntoCollectionsEnableGroupingShowsIntoCollectionsEnableLegacyAuthorizationEnableMetricsEnableNormalizedItemByNameIdsEnableSlowResponseWarningImageExtractionTimeoutMsImageSavingConventionInactiveSessionThresholdIsPortAuthorizedIsStartupWizardCompletedLibraryMetadataRefreshConcurrencyLibraryMonitorDelayLibraryScanFanoutConcurrencyLibraryUpdateDurationLogFileRetentionDaysMaxAudiobookResumeMaxResumePctMetadataCountryCodeMetadataOptionsMetadataPathMinAudiobookResumeMinResumeDurationSecondsMinResumePctParallelImageEncodingLimitPathSubstitutionsPluginRepositoriesPreferredMetadataLanguagePreviousVersionPreviousVersionStrQuickConnectAvailableRemoteClientBitrateLimitSaveMetadataHiddenServerNameSkipDeserializationForBasicTypesSlowResponseThresholdMsSortRemoveCharactersSortRemoveWordsSortReplaceCharactersTrickplayOptionsUICulture