jellyfin-model/org.jellyfin.sdk.model.api/ServerConfiguration

ServerConfiguration

data class ServerConfiguration(val logFileRetentionDays: Int, val isStartupWizardCompleted: Boolean, val cachePath: String? = null, val previousVersion: String? = null, val previousVersionStr: String? = null, val enableMetrics: Boolean, val enableNormalizedItemByNameIds: Boolean, val isPortAuthorized: Boolean, val quickConnectAvailable: Boolean, val enableCaseSensitiveItemIds: Boolean, val disableLiveTvChannelUserDataName: Boolean, val metadataPath: String, val preferredMetadataLanguage: String, val metadataCountryCode: String, val sortReplaceCharacters: List<String>, val sortRemoveCharacters: List<String>, val sortRemoveWords: List<String>, val minResumePct: Int, val maxResumePct: Int, val minResumeDurationSeconds: Int, val minAudiobookResume: Int, val maxAudiobookResume: Int, val inactiveSessionThreshold: Int, val libraryMonitorDelay: Int, val libraryUpdateDuration: Int, val imageSavingConvention: ImageSavingConvention, val metadataOptions: List<MetadataOptions>, val skipDeserializationForBasicTypes: Boolean, val serverName: String, val uiCulture: String, val saveMetadataHidden: Boolean, val contentTypes: List<NameValuePair>, val remoteClientBitrateLimit: Int, val enableFolderView: Boolean, val enableGroupingIntoCollections: Boolean, val displaySpecialsWithinSeasons: Boolean, val codecsUsed: List<String>, val pluginRepositories: List<RepositoryInfo>, val enableExternalContentInSuggestions: Boolean, val imageExtractionTimeoutMs: Int, val pathSubstitutions: List<PathSubstitution>, val enableSlowResponseWarning: Boolean, val slowResponseThresholdMs: Long, val corsHosts: List<String>, val activityLogRetentionDays: Int? = null, val libraryScanFanoutConcurrency: Int, val libraryMetadataRefreshConcurrency: Int, val removeOldPlugins: Boolean, val allowClientLogUpload: Boolean, val dummyChapterDuration: Int, val chapterImageResolution: ImageResolution, val parallelImageEncodingLimit: Int, val castReceiverApplications: List<CastReceiverApplication>, val trickplayOptions: TrickplayOptions)

Represents the server configuration.

Constructors

ServerConfiguration

constructor(logFileRetentionDays: Int, isStartupWizardCompleted: Boolean, cachePath: String? = null, previousVersion: String? = null, previousVersionStr: String? = null, enableMetrics: Boolean, enableNormalizedItemByNameIds: Boolean, isPortAuthorized: Boolean, quickConnectAvailable: Boolean, enableCaseSensitiveItemIds: Boolean, disableLiveTvChannelUserDataName: Boolean, metadataPath: String, preferredMetadataLanguage: String, metadataCountryCode: String, sortReplaceCharacters: List<String>, sortRemoveCharacters: List<String>, sortRemoveWords: List<String>, minResumePct: Int, maxResumePct: Int, minResumeDurationSeconds: Int, minAudiobookResume: Int, maxAudiobookResume: Int, inactiveSessionThreshold: Int, libraryMonitorDelay: Int, libraryUpdateDuration: Int, imageSavingConvention: ImageSavingConvention, metadataOptions: List<MetadataOptions>, skipDeserializationForBasicTypes: Boolean, serverName: String, uiCulture: String, saveMetadataHidden: Boolean, contentTypes: List<NameValuePair>, remoteClientBitrateLimit: Int, enableFolderView: Boolean, enableGroupingIntoCollections: Boolean, displaySpecialsWithinSeasons: Boolean, codecsUsed: List<String>, pluginRepositories: List<RepositoryInfo>, enableExternalContentInSuggestions: Boolean, imageExtractionTimeoutMs: Int, pathSubstitutions: List<PathSubstitution>, enableSlowResponseWarning: Boolean, slowResponseThresholdMs: Long, corsHosts: List<String>, activityLogRetentionDays: Int? = null, libraryScanFanoutConcurrency: Int, libraryMetadataRefreshConcurrency: Int, removeOldPlugins: Boolean, allowClientLogUpload: Boolean, dummyChapterDuration: Int, chapterImageResolution: ImageResolution, parallelImageEncodingLimit: Int, castReceiverApplications: List<CastReceiverApplication>, trickplayOptions: TrickplayOptions)

Properties

activityLogRetentionDays

val activityLogRetentionDays: Int? = null

The number of days we should retain activity logs.

allowClientLogUpload

val allowClientLogUpload: Boolean

A value indicating whether clients should be allowed to upload logs.

cachePath

val cachePath: String? = null

The cache path.

castReceiverApplications

val castReceiverApplications: List<CastReceiverApplication>

The list of cast receiver applications.

chapterImageResolution

val chapterImageResolution: ImageResolution

The chapter image resolution.

codecsUsed

val codecsUsed: List<String>

contentTypes

val contentTypes: List<NameValuePair>

corsHosts

val corsHosts: List<String>

The cors hosts.

disableLiveTvChannelUserDataName

val disableLiveTvChannelUserDataName: Boolean

displaySpecialsWithinSeasons

val displaySpecialsWithinSeasons: Boolean

dummyChapterDuration

val dummyChapterDuration: Int

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

enableCaseSensitiveItemIds

val enableCaseSensitiveItemIds: Boolean

A value indicating whether enable case sensitive item ids.

enableExternalContentInSuggestions

val enableExternalContentInSuggestions: Boolean

enableFolderView

val enableFolderView: Boolean

enableGroupingIntoCollections

val enableGroupingIntoCollections: Boolean

enableMetrics

val enableMetrics: Boolean

A value indicating whether to enable prometheus metrics exporting.

enableNormalizedItemByNameIds

val enableNormalizedItemByNameIds: Boolean

enableSlowResponseWarning

val enableSlowResponseWarning: Boolean

A value indicating whether slow server responses should be logged as a warning.

imageExtractionTimeoutMs

val imageExtractionTimeoutMs: Int

imageSavingConvention

val imageSavingConvention: ImageSavingConvention

The image saving convention.

inactiveSessionThreshold

val inactiveSessionThreshold: Int

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.

isPortAuthorized

val isPortAuthorized: Boolean

A value indicating whether this instance is port authorized.

isStartupWizardCompleted

val isStartupWizardCompleted: Boolean

A value indicating whether this instance is first run.

libraryMetadataRefreshConcurrency

val libraryMetadataRefreshConcurrency: Int

The how many metadata refreshes can run concurrently.

libraryMonitorDelay

val libraryMonitorDelay: Int

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.

libraryScanFanoutConcurrency

val libraryScanFanoutConcurrency: Int

The how the library scan fans out.

libraryUpdateDuration

val libraryUpdateDuration: Int

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

logFileRetentionDays

val logFileRetentionDays: Int

The number of days we should retain log files.

maxAudiobookResume

val maxAudiobookResume: Int

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.

maxResumePct

val maxResumePct: Int

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.

metadataCountryCode

val metadataCountryCode: String

The metadata country code.

metadataOptions

val metadataOptions: List<MetadataOptions>

metadataPath

val metadataPath: String

The metadata path.

minAudiobookResume

val minAudiobookResume: Int

The minimum minutes of a book that must be played in order for playstate to be updated.

minResumeDurationSeconds