Updates application configuration.

请求参数

Authorization

在 header 添加参数

X-Emby-Token

示例：

X-Emby-Token: ********************

Body 参数application/json

Represents the server configuration.

LogFileRetentionDays

integer <int32>

可选

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

IsStartupWizardCompleted

boolean

可选

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

CachePath

string | null

可选

Gets or sets the cache path.

PreviousVersion

string | null

可选

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

PreviousVersionStr

string | null

可选

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

EnableMetrics

boolean

可选

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

EnableNormalizedItemByNameIds

boolean

可选

IsPortAuthorized

boolean

可选

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

QuickConnectAvailable

boolean

可选

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

EnableCaseSensitiveItemIds

boolean

可选

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

DisableLiveTvChannelUserDataName

boolean

可选

MetadataPath

string

可选

Gets or sets the metadata path.

PreferredMetadataLanguage

string

可选

Gets or sets the preferred metadata language.

MetadataCountryCode

string

可选

Gets or sets the metadata country code.

SortReplaceCharacters

array[string]

可选

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

SortRemoveCharacters

array[string]

可选

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

SortRemoveWords

array[string]

可选

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

MinResumePct

integer <int32>

可选

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

MaxResumePct

integer <int32>

可选

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.

MinResumeDurationSeconds

integer <int32>

可选

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

MinAudiobookResume

integer <int32>

可选

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

MaxAudiobookResume

integer <int32>

可选

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.

InactiveSessionThreshold

integer <int32>

可选

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.

LibraryMonitorDelay

integer <int32>

可选

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.

LibraryUpdateDuration

integer <int32>

可选

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

ImageSavingConvention

enum<string>

可选

Gets or sets the image saving convention.

枚举值:

LegacyCompatible

MetadataOptions

array[object (MetadataOptions) {7}]

可选

ItemType

string | null

可选

DisabledMetadataSavers

array[string] | null

可选

LocalMetadataReaderOrder

array[string] | null

可选

DisabledMetadataFetchers

array[string] | null

可选

MetadataFetcherOrder

array[string] | null

可选

DisabledImageFetchers

array[string] | null

可选

ImageFetcherOrder

array[string] | null

可选

SkipDeserializationForBasicTypes

boolean

可选

ServerName

string

可选

UICulture

string

可选

SaveMetadataHidden

boolean

可选

ContentTypes

array[object (NameValuePair) {2}]

可选

Name

string | null

可选

Gets or sets the name.

Value

string | null

可选

Gets or sets the value.

RemoteClientBitrateLimit

integer <int32>

可选

EnableFolderView

boolean

可选

EnableGroupingIntoCollections

boolean

可选

DisplaySpecialsWithinSeasons

boolean

可选

CodecsUsed

array[string]

可选

PluginRepositories

array[object (RepositoryInfo) {3}]

可选

Name

string | null

可选

Gets or sets the name.

Url

string | null

可选

Gets or sets the URL.

Enabled

boolean

可选

Gets or sets a value indicating whether the repository is enabled.

EnableExternalContentInSuggestions

boolean

可选

ImageExtractionTimeoutMs

integer <int32>

可选

PathSubstitutions

array[object (PathSubstitution) {2}]

可选

From

string

可选

Gets or sets the value to substitute.

string

可选

Gets or sets the value to substitution with.

EnableSlowResponseWarning

boolean

可选

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

SlowResponseThresholdMs

integer <int64>

可选

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

CorsHosts

array[string]

可选

Gets or sets the cors hosts.

ActivityLogRetentionDays

integer <int32> | null

可选

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

LibraryScanFanoutConcurrency

integer <int32>

可选

Gets or sets the how the library scan fans out.

LibraryMetadataRefreshConcurrency

integer <int32>

可选

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

RemoveOldPlugins

boolean

可选

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

AllowClientLogUpload

boolean

可选

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

DummyChapterDuration

integer <int32>

可选

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

ChapterImageResolution

enum<string>

可选

Gets or sets the chapter image resolution.

枚举值:

MatchSourceP144P240P360P480P720P1080P1440P2160

ParallelImageEncodingLimit

integer <int32>

可选

Gets or sets the limit for parallel image encoding.

CastReceiverApplications

array[object (CastReceiverApplication) {2}]

可选

Gets or sets the list of cast receiver applications.

string

可选

Gets or sets the cast receiver application id.

Name

string

可选

Gets or sets the cast receiver application name.

TrickplayOptions

object

可选

Gets or sets the trickplay options.

EnableHwAcceleration

boolean

可选

Gets or sets a value indicating whether or not to use HW acceleration.

EnableHwEncoding

boolean

可选

Gets or sets a value indicating whether or not to use HW accelerated MJPEG encoding.

EnableKeyFrameOnlyExtraction

boolean

可选

Gets or sets a value indicating whether to only extract key frames.
Significantly faster, but is not compatible with all decoders and/or video files.

ScanBehavior

enum<string>

可选

Gets or sets the behavior used by trickplay provider on library scan/update.

枚举值:

BlockingNonBlocking

ProcessPriority

enum<string>

可选

Gets or sets the process priority for the ffmpeg process.

枚举值:

NormalIdleHighRealTimeBelowNormalAboveNormal

Interval

integer <int32>

可选

Gets or sets the interval, in ms, between each new trickplay image.

WidthResolutions

array[integer <int32>]

可选

Gets or sets the target width resolutions, in px, to generates preview images for.

TileWidth

integer <int32>

可选

Gets or sets number of tile images to allow in X dimension.

TileHeight

integer <int32>

可选

Gets or sets number of tile images to allow in Y dimension.

Qscale

integer <int32>

可选

Gets or sets the ffmpeg output quality level.

JpegQuality

integer <int32>

可选

Gets or sets the jpeg quality to use for image tiles.

ProcessThreads

integer <int32>

可选

Gets or sets the number of threads to be used by ffmpeg.

示例

{
    "LogFileRetentionDays": 0,
    "IsStartupWizardCompleted": true,
    "CachePath": "string",
    "PreviousVersion": "string",
    "PreviousVersionStr": "string",
    "EnableMetrics": true,
    "EnableNormalizedItemByNameIds": true,
    "IsPortAuthorized": true,
    "QuickConnectAvailable": true,
    "EnableCaseSensitiveItemIds": true,
    "DisableLiveTvChannelUserDataName": true,
    "MetadataPath": "string",
    "PreferredMetadataLanguage": "string",
    "MetadataCountryCode": "string",
    "SortReplaceCharacters": [
        "string"
    ],
    "SortRemoveCharacters": [
        "string"
    ],
    "SortRemoveWords": [
        "string"
    ],
    "MinResumePct": 0,
    "MaxResumePct": 0,
    "MinResumeDurationSeconds": 0,
    "MinAudiobookResume": 0,
    "MaxAudiobookResume": 0,
    "InactiveSessionThreshold": 0,
    "LibraryMonitorDelay": 0,
    "LibraryUpdateDuration": 0,
    "ImageSavingConvention": "Legacy",
    "MetadataOptions": [
        {
            "ItemType": "string",
            "DisabledMetadataSavers": [
                "string"
            ],
            "LocalMetadataReaderOrder": [
                "string"
            ],
            "DisabledMetadataFetchers": [
                "string"
            ],
            "MetadataFetcherOrder": [
                "string"
            ],
            "DisabledImageFetchers": [
                "string"
            ],
            "ImageFetcherOrder": [
                "string"
            ]
        }
    ],
    "SkipDeserializationForBasicTypes": true,
    "ServerName": "string",
    "UICulture": "string",
    "SaveMetadataHidden": true,
    "ContentTypes": [
        {
            "Name": "string",
            "Value": "string"
        }
    ],
    "RemoteClientBitrateLimit": 0,
    "EnableFolderView": true,
    "EnableGroupingIntoCollections": true,
    "DisplaySpecialsWithinSeasons": true,
    "CodecsUsed": [
        "string"
    ],
    "PluginRepositories": [
        {
            "Name": "string",
            "Url": "string",
            "Enabled": true
        }
    ],
    "EnableExternalContentInSuggestions": true,
    "ImageExtractionTimeoutMs": 0,
    "PathSubstitutions": [
        {
            "From": "string",
            "To": "string"
        }
    ],
    "EnableSlowResponseWarning": true,
    "SlowResponseThresholdMs": 0,
    "CorsHosts": [
        "string"
    ],
    "ActivityLogRetentionDays": 0,
    "LibraryScanFanoutConcurrency": 0,
    "LibraryMetadataRefreshConcurrency": 0,
    "RemoveOldPlugins": true,
    "AllowClientLogUpload": true,
    "DummyChapterDuration": 0,
    "ChapterImageResolution": "MatchSource",
    "ParallelImageEncodingLimit": 0,
    "CastReceiverApplications": [
        {
            "Id": "string",
            "Name": "string"
        }
    ],
    "TrickplayOptions": {
        "EnableHwAcceleration": true,
        "EnableHwEncoding": true,
        "EnableKeyFrameOnlyExtraction": true,
        "ScanBehavior": "Blocking",
        "ProcessPriority": "Normal",
        "Interval": 0,
        "WidthResolutions": [
            0
        ],
        "TileWidth": 0,
        "TileHeight": 0,
        "Qscale": 0,
        "JpegQuality": 0,
        "ProcessThreads": 0
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/System/Configuration' \
--header 'Content-Type: application/json' \
--header 'X-Emby-Token;' \
--data-raw '{
    "LogFileRetentionDays": 0,
    "IsStartupWizardCompleted": true,
    "CachePath": "string",
    "PreviousVersion": "string",
    "PreviousVersionStr": "string",
    "EnableMetrics": true,
    "EnableNormalizedItemByNameIds": true,
    "IsPortAuthorized": true,
    "QuickConnectAvailable": true,
    "EnableCaseSensitiveItemIds": true,
    "DisableLiveTvChannelUserDataName": true,
    "MetadataPath": "string",
    "PreferredMetadataLanguage": "string",
    "MetadataCountryCode": "string",
    "SortReplaceCharacters": [
        "string"
    ],
    "SortRemoveCharacters": [
        "string"
    ],
    "SortRemoveWords": [
        "string"
    ],
    "MinResumePct": 0,
    "MaxResumePct": 0,
    "MinResumeDurationSeconds": 0,
    "MinAudiobookResume": 0,
    "MaxAudiobookResume": 0,
    "InactiveSessionThreshold": 0,
    "LibraryMonitorDelay": 0,
    "LibraryUpdateDuration": 0,
    "ImageSavingConvention": "Legacy",
    "MetadataOptions": [
        {
            "ItemType": "string",
            "DisabledMetadataSavers": [
                "string"
            ],
            "LocalMetadataReaderOrder": [
                "string"
            ],
            "DisabledMetadataFetchers": [
                "string"
            ],
            "MetadataFetcherOrder": [
                "string"
            ],
            "DisabledImageFetchers": [
                "string"
            ],
            "ImageFetcherOrder": [
                "string"
            ]
        }
    ],
    "SkipDeserializationForBasicTypes": true,
    "ServerName": "string",
    "UICulture": "string",
    "SaveMetadataHidden": true,
    "ContentTypes": [
        {
            "Name": "string",
            "Value": "string"
        }
    ],
    "RemoteClientBitrateLimit": 0,
    "EnableFolderView": true,
    "EnableGroupingIntoCollections": true,
    "DisplaySpecialsWithinSeasons": true,
    "CodecsUsed": [
        "string"
    ],
    "PluginRepositories": [
        {
            "Name": "string",
            "Url": "string",
            "Enabled": true
        }
    ],
    "EnableExternalContentInSuggestions": true,
    "ImageExtractionTimeoutMs": 0,
    "PathSubstitutions": [
        {
            "From": "string",
            "To": "string"
        }
    ],
    "EnableSlowResponseWarning": true,
    "SlowResponseThresholdMs": 0,
    "CorsHosts": [
        "string"
    ],
    "ActivityLogRetentionDays": 0,
    "LibraryScanFanoutConcurrency": 0,
    "LibraryMetadataRefreshConcurrency": 0,
    "RemoveOldPlugins": true,
    "AllowClientLogUpload": true,
    "DummyChapterDuration": 0,
    "ChapterImageResolution": "MatchSource",
    "ParallelImageEncodingLimit": 0,
    "CastReceiverApplications": [
        {
            "Id": "string",
            "Name": "string"
        }
    ],
    "TrickplayOptions": {
        "EnableHwAcceleration": true,
        "EnableHwEncoding": true,
        "EnableKeyFrameOnlyExtraction": true,
        "ScanBehavior": "Blocking",
        "ProcessPriority": "Normal",
        "Interval": 0,
        "WidthResolutions": [
            0
        ],
        "TileWidth": 0,
        "TileHeight": 0,
        "Qscale": 0,
        "JpegQuality": 0,
        "ProcessThreads": 0
    }
}'

Configuration updated.

Updates application configuration.

请求参数

示例代码

返回响应