Interface ServerConfiguration

Represents the server configuration.

Export

ServerConfiguration

interface ServerConfiguration {
    ActivityLogRetentionDays?: null | number;
    AllowClientLogUpload?: boolean;
    CachePath?: null | string;
    CastReceiverApplications?: CastReceiverApplication[];
    ChapterImageResolution?: ImageResolution;
    CodecsUsed?: string[];
    ContentTypes?: NameValuePair[];
    CorsHosts?: string[];
    DisableLiveTvChannelUserDataName?: boolean;
    DisplaySpecialsWithinSeasons?: boolean;
    DummyChapterDuration?: number;
    EnableCaseSensitiveItemIds?: boolean;
    EnableExternalContentInSuggestions?: boolean;
    EnableFolderView?: boolean;
    EnableGroupingIntoCollections?: 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?: null | string;
    PreviousVersionStr?: null | string;
    QuickConnectAvailable?: boolean;
    RemoteClientBitrateLimit?: number;
    RemoveOldPlugins?: boolean;
    SaveMetadataHidden?: boolean;
    ServerName?: string;
    SkipDeserializationForBasicTypes?: boolean;
    SlowResponseThresholdMs?: number;
    SortRemoveCharacters?: string[];
    SortRemoveWords?: string[];
    SortReplaceCharacters?: string[];
    TrickplayOptions?: TrickplayOptions;
    UICulture?: string;
}

Properties

ActivityLogRetentionDays? AllowClientLogUpload? CachePath? CastReceiverApplications? ChapterImageResolution? CodecsUsed? ContentTypes? CorsHosts? DisableLiveTvChannelUserDataName? DisplaySpecialsWithinSeasons? DummyChapterDuration? EnableCaseSensitiveItemIds? EnableExternalContentInSuggestions? EnableFolderView? EnableGroupingIntoCollections? 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? RemoveOldPlugins? SaveMetadataHidden? ServerName? SkipDeserializationForBasicTypes? SlowResponseThresholdMs? SortRemoveCharacters? SortRemoveWords? SortReplaceCharacters? TrickplayOptions? UICulture?

Properties

OptionalActivityLogRetentionDays

ActivityLogRetentionDays?: null | number

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

Memberof

ServerConfiguration

OptionalAllowClientLogUpload

AllowClientLogUpload?: boolean

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

Memberof

ServerConfiguration

OptionalCachePath

CachePath?: null | string

Gets or sets the cache path.

Memberof

ServerConfiguration

OptionalCastReceiverApplications

CastReceiverApplications?: CastReceiverApplication[]

Gets or sets the list of cast receiver applications.

Memberof

ServerConfiguration

OptionalChapterImageResolution

ChapterImageResolution?: ImageResolution

Memberof

ServerConfiguration

OptionalCodecsUsed

CodecsUsed?: string[]

Memberof

ServerConfiguration

OptionalContentTypes

ContentTypes?: NameValuePair[]

Memberof

ServerConfiguration

OptionalCorsHosts

CorsHosts?: string[]

Gets or sets the cors hosts.

Memberof

ServerConfiguration

OptionalDisableLiveTvChannelUserDataName

DisableLiveTvChannelUserDataName?: boolean

Memberof

ServerConfiguration

OptionalDisplaySpecialsWithinSeasons

DisplaySpecialsWithinSeasons?: boolean

Memberof

ServerConfiguration

OptionalDummyChapterDuration

DummyChapterDuration?: number

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

Memberof

ServerConfiguration

OptionalEnableCaseSensitiveItemIds

EnableCaseSensitiveItemIds?: boolean

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

Memberof

ServerConfiguration

OptionalEnableExternalContentInSuggestions

EnableExternalContentInSuggestions?: boolean

Memberof

ServerConfiguration

OptionalEnableFolderView

EnableFolderView?: boolean

Memberof

ServerConfiguration

OptionalEnableGroupingIntoCollections

EnableGroupingIntoCollections?: boolean

Memberof

ServerConfiguration

OptionalEnableMetrics

EnableMetrics?: boolean

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

Memberof

ServerConfiguration

OptionalEnableNormalizedItemByNameIds

EnableNormalizedItemByNameIds?: boolean

Memberof

ServerConfiguration

OptionalEnableSlowResponseWarning

EnableSlowResponseWarning?: boolean

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

Memberof

ServerConfiguration

OptionalImageExtractionTimeoutMs

ImageExtractionTimeoutMs?: number

Memberof

ServerConfiguration

OptionalImageSavingConvention

ImageSavingConvention?: ImageSavingConvention

Memberof

ServerConfiguration

OptionalInactiveSessionThreshold

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.

Memberof

ServerConfiguration

OptionalIsPortAuthorized

IsPortAuthorized?: boolean

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

Memberof

ServerConfiguration

OptionalIsStartupWizardCompleted

IsStartupWizardCompleted?: boolean

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

Memberof

ServerConfiguration

OptionalLibraryMetadataRefreshConcurrency

LibraryMetadataRefreshConcurrency?: number

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

Memberof

ServerConfiguration

OptionalLibraryMonitorDelay

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.

Memberof

ServerConfiguration

OptionalLibraryScanFanoutConcurrency

LibraryScanFanoutConcurrency?: number

Gets or sets the how the library scan fans out.

Memberof

ServerConfiguration

OptionalLibraryUpdateDuration

LibraryUpdateDuration?: number

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

Memberof

ServerConfiguration

OptionalLogFileRetentionDays

LogFileRetentionDays?: number

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

Memberof

ServerConfiguration

OptionalMaxAudiobookResume

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.

Memberof

ServerConfiguration

OptionalMaxResumePct

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.

Memberof

ServerConfiguration

OptionalMetadataCountryCode

MetadataCountryCode?: string

Gets or sets the metadata country code.

Memberof

ServerConfiguration

OptionalMetadataOptions

MetadataOptions?: MetadataOptions[]

Memberof

ServerConfiguration

OptionalMetadataPath

MetadataPath?: string

Gets or sets the metadata path.

Memberof

ServerConfiguration

OptionalMinAudiobookResume

MinAudiobookResume?: number

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

Memberof

ServerConfiguration

OptionalMinResumeDurationSeconds

MinResumeDurationSeconds?: number

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

Memberof

ServerConfiguration

OptionalMinResumePct

MinResumePct?: number

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

Memberof

ServerConfiguration

OptionalParallelImageEncodingLimit

ParallelImageEncodingLimit?: number

Gets or sets the limit for parallel image encoding.

Memberof

ServerConfiguration

OptionalPathSubstitutions

PathSubstitutions?: PathSubstitution[]

Memberof

ServerConfiguration

OptionalPluginRepositories

PluginRepositories?: RepositoryInfo[]

Memberof

ServerConfiguration

OptionalPreferredMetadataLanguage

PreferredMetadataLanguage?: string

Gets or sets the preferred metadata language.

Memberof

ServerConfiguration

OptionalPreviousVersion

PreviousVersion?: null | string

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

Memberof

ServerConfiguration

OptionalPreviousVersionStr

PreviousVersionStr?: null | string

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

Memberof

ServerConfiguration

OptionalQuickConnectAvailable

QuickConnectAvailable?: boolean

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

Memberof

ServerConfiguration

OptionalRemoteClientBitrateLimit

RemoteClientBitrateLimit?: number

Memberof

ServerConfiguration

OptionalRemoveOldPlugins

RemoveOldPlugins?: boolean

Gets or sets a value indicating whether older plugins should automatically be deleted from the plugin folder.

Memberof

ServerConfiguration

OptionalSaveMetadataHidden

SaveMetadataHidden?: boolean

Memberof

ServerConfiguration

OptionalServerName

ServerName?: string

Memberof

ServerConfiguration

OptionalSkipDeserializationForBasicTypes

SkipDeserializationForBasicTypes?: boolean

Memberof

ServerConfiguration

OptionalSlowResponseThresholdMs

SlowResponseThresholdMs?: number

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

Memberof

ServerConfiguration

OptionalSortRemoveCharacters

SortRemoveCharacters?: string[]

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

Memberof

ServerConfiguration

OptionalSortRemoveWords

SortRemoveWords?: string[]

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

Memberof

ServerConfiguration

OptionalSortReplaceCharacters

SortReplaceCharacters?: string[]

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

Memberof

ServerConfiguration

OptionalTrickplayOptions

TrickplayOptions?: TrickplayOptions

Memberof

ServerConfiguration

OptionalUICulture

UICulture?: string

Memberof

ServerConfiguration

Settings

Member Visibility

On This Page

Properties
ActivityLogRetentionDaysAllowClientLogUploadCachePathCastReceiverApplicationsChapterImageResolutionCodecsUsedContentTypesCorsHostsDisableLiveTvChannelUserDataNameDisplaySpecialsWithinSeasonsDummyChapterDurationEnableCaseSensitiveItemIdsEnableExternalContentInSuggestionsEnableFolderViewEnableGroupingIntoCollectionsEnableMetricsEnableNormalizedItemByNameIdsEnableSlowResponseWarningImageExtractionTimeoutMsImageSavingConventionInactiveSessionThresholdIsPortAuthorizedIsStartupWizardCompletedLibraryMetadataRefreshConcurrencyLibraryMonitorDelayLibraryScanFanoutConcurrencyLibraryUpdateDurationLogFileRetentionDaysMaxAudiobookResumeMaxResumePctMetadataCountryCodeMetadataOptionsMetadataPathMinAudiobookResumeMinResumeDurationSecondsMinResumePctParallelImageEncodingLimitPathSubstitutionsPluginRepositoriesPreferredMetadataLanguagePreviousVersionPreviousVersionStrQuickConnectAvailableRemoteClientBitrateLimitRemoveOldPluginsSaveMetadataHiddenServerNameSkipDeserializationForBasicTypesSlowResponseThresholdMsSortRemoveCharactersSortRemoveWordsSortReplaceCharactersTrickplayOptionsUICulture