Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
Jellyfin::DTO::ServerConfiguration Class Reference

#include <serverconfiguration.h>

Public Member Functions

 ServerConfiguration (qint32 logFileRetentionDays, bool isStartupWizardCompleted, bool enableMetrics, bool enableNormalizedItemByNameIds, bool isPortAuthorized, bool quickConnectAvailable, bool enableCaseSensitiveItemIds, bool disableLiveTvChannelUserDataName, QString metadataPath, QString preferredMetadataLanguage, QString metadataCountryCode, QStringList sortReplaceCharacters, QStringList sortRemoveCharacters, QStringList sortRemoveWords, qint32 minResumePct, qint32 maxResumePct, qint32 minResumeDurationSeconds, qint32 minAudiobookResume, qint32 maxAudiobookResume, qint32 inactiveSessionThreshold, qint32 libraryMonitorDelay, qint32 libraryUpdateDuration, ImageSavingConvention imageSavingConvention, QList< MetadataOptions > metadataOptions, bool skipDeserializationForBasicTypes, QString serverName, QString uICulture, bool saveMetadataHidden, QList< NameValuePair > contentTypes, qint32 remoteClientBitrateLimit, bool enableFolderView, bool enableGroupingIntoCollections, bool displaySpecialsWithinSeasons, QStringList codecsUsed, QList< RepositoryInfo > pluginRepositories, bool enableExternalContentInSuggestions, qint32 imageExtractionTimeoutMs, QList< PathSubstitution > pathSubstitutions, bool enableSlowResponseWarning, qint64 slowResponseThresholdMs, QStringList corsHosts, qint32 libraryScanFanoutConcurrency, qint32 libraryMetadataRefreshConcurrency, bool removeOldPlugins, bool allowClientLogUpload, qint32 dummyChapterDuration, ImageResolution chapterImageResolution, qint32 parallelImageEncodingLimit, QList< CastReceiverApplication > castReceiverApplications, QSharedPointer< TrickplayOptions > trickplayOptions)
 ServerConfiguration (const ServerConfiguration &other)
void replaceData (ServerConfiguration &other)
void setFromJson (QJsonObject source)
QJsonObject toJson () const
qint32 logFileRetentionDays () const
 Gets or sets the number of days we should retain log files.
void setLogFileRetentionDays (qint32 newLogFileRetentionDays)
 Gets or sets the number of days we should retain log files.
bool isStartupWizardCompleted () const
 Gets or sets a value indicating whether this instance is first run.
void setIsStartupWizardCompleted (bool newIsStartupWizardCompleted)
 Gets or sets a value indicating whether this instance is first run.
QString cachePath () const
 Gets or sets the cache path.
void setCachePath (QString newCachePath)
 Gets or sets the cache path.
bool cachePathNull () const
void setCachePathNull ()
QString previousVersion () const
 Gets or sets the last known version that was ran using the configuration.
void setPreviousVersion (QString newPreviousVersion)
 Gets or sets the last known version that was ran using the configuration.
bool previousVersionNull () const
void setPreviousVersionNull ()
QString previousVersionStr () const
void setPreviousVersionStr (QString newPreviousVersionStr)
bool previousVersionStrNull () const
void setPreviousVersionStrNull ()
bool enableMetrics () const
 Gets or sets a value indicating whether to enable prometheus metrics exporting.
void setEnableMetrics (bool newEnableMetrics)
 Gets or sets a value indicating whether to enable prometheus metrics exporting.
bool enableNormalizedItemByNameIds () const
void setEnableNormalizedItemByNameIds (bool newEnableNormalizedItemByNameIds)
bool isPortAuthorized () const
 Gets or sets a value indicating whether this instance is port authorized.
void setIsPortAuthorized (bool newIsPortAuthorized)
 Gets or sets a value indicating whether this instance is port authorized.
bool quickConnectAvailable () const
 Gets or sets a value indicating whether quick connect is available for use on this server.
void setQuickConnectAvailable (bool newQuickConnectAvailable)
 Gets or sets a value indicating whether quick connect is available for use on this server.
bool enableCaseSensitiveItemIds () const
 Gets or sets a value indicating whether [enable case sensitive item ids].
void setEnableCaseSensitiveItemIds (bool newEnableCaseSensitiveItemIds)
 Gets or sets a value indicating whether [enable case sensitive item ids].
bool disableLiveTvChannelUserDataName () const
void setDisableLiveTvChannelUserDataName (bool newDisableLiveTvChannelUserDataName)
QString metadataPath () const
 Gets or sets the metadata path.
void setMetadataPath (QString newMetadataPath)
 Gets or sets the metadata path.
QString preferredMetadataLanguage () const
 Gets or sets the preferred metadata language.
void setPreferredMetadataLanguage (QString newPreferredMetadataLanguage)
 Gets or sets the preferred metadata language.
QString metadataCountryCode () const
 Gets or sets the metadata country code.
void setMetadataCountryCode (QString newMetadataCountryCode)
 Gets or sets the metadata country code.
QStringList sortReplaceCharacters () const
 Gets or sets characters to be replaced with a ' ' in strings to create a sort name.
void setSortReplaceCharacters (QStringList newSortReplaceCharacters)
 Gets or sets characters to be replaced with a ' ' in strings to create a sort name.
QStringList sortRemoveCharacters () const
 Gets or sets characters to be removed from strings to create a sort name.
void setSortRemoveCharacters (QStringList newSortRemoveCharacters)
 Gets or sets characters to be removed from strings to create a sort name.
QStringList sortRemoveWords () const
 Gets or sets words to be removed from strings to create a sort name.
void setSortRemoveWords (QStringList newSortRemoveWords)
 Gets or sets words to be removed from strings to create a sort name.
qint32 minResumePct () const
 Gets or sets the minimum percentage of an item that must be played in order for playstate to be updated.
void setMinResumePct (qint32 newMinResumePct)
 Gets or sets the minimum percentage of an item that must be played in order for playstate to be updated.
qint32 maxResumePct () const
 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.
void setMaxResumePct (qint32 newMaxResumePct)
 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.
qint32 minResumeDurationSeconds () const
 Gets or sets the minimum duration that an item must have in order to be eligible for playstate updates..
void setMinResumeDurationSeconds (qint32 newMinResumeDurationSeconds)
 Gets or sets the minimum duration that an item must have in order to be eligible for playstate updates..
qint32 minAudiobookResume () const
 Gets or sets the minimum minutes of a book that must be played in order for playstate to be updated.
void setMinAudiobookResume (qint32 newMinAudiobookResume)
 Gets or sets the minimum minutes of a book that must be played in order for playstate to be updated.
qint32 maxAudiobookResume () const
 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.
void setMaxAudiobookResume (qint32 newMaxAudiobookResume)
 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.
qint32 inactiveSessionThreshold () const
void setInactiveSessionThreshold (qint32 newInactiveSessionThreshold)
qint32 libraryMonitorDelay () const
void setLibraryMonitorDelay (qint32 newLibraryMonitorDelay)
qint32 libraryUpdateDuration () const
 Gets or sets the duration in seconds that we will wait after a library updated event before executing the library changed notification.
void setLibraryUpdateDuration (qint32 newLibraryUpdateDuration)
 Gets or sets the duration in seconds that we will wait after a library updated event before executing the library changed notification.
ImageSavingConvention imageSavingConvention () const
void setImageSavingConvention (ImageSavingConvention newImageSavingConvention)
QList< MetadataOptionsmetadataOptions () const
void setMetadataOptions (QList< MetadataOptions > newMetadataOptions)
bool skipDeserializationForBasicTypes () const
void setSkipDeserializationForBasicTypes (bool newSkipDeserializationForBasicTypes)
QString serverName () const
void setServerName (QString newServerName)
QString uICulture () const
void setUICulture (QString newUICulture)
bool saveMetadataHidden () const
void setSaveMetadataHidden (bool newSaveMetadataHidden)
QList< NameValuePaircontentTypes () const
void setContentTypes (QList< NameValuePair > newContentTypes)
qint32 remoteClientBitrateLimit () const
void setRemoteClientBitrateLimit (qint32 newRemoteClientBitrateLimit)
bool enableFolderView () const
void setEnableFolderView (bool newEnableFolderView)
bool enableGroupingIntoCollections () const
void setEnableGroupingIntoCollections (bool newEnableGroupingIntoCollections)
bool displaySpecialsWithinSeasons () const
void setDisplaySpecialsWithinSeasons (bool newDisplaySpecialsWithinSeasons)
QStringList codecsUsed () const
void setCodecsUsed (QStringList newCodecsUsed)
QList< RepositoryInfopluginRepositories () const
void setPluginRepositories (QList< RepositoryInfo > newPluginRepositories)
bool enableExternalContentInSuggestions () const
void setEnableExternalContentInSuggestions (bool newEnableExternalContentInSuggestions)
qint32 imageExtractionTimeoutMs () const
void setImageExtractionTimeoutMs (qint32 newImageExtractionTimeoutMs)
QList< PathSubstitutionpathSubstitutions () const
void setPathSubstitutions (QList< PathSubstitution > newPathSubstitutions)
bool enableSlowResponseWarning () const
 Gets or sets a value indicating whether slow server responses should be logged as a warning.
void setEnableSlowResponseWarning (bool newEnableSlowResponseWarning)
 Gets or sets a value indicating whether slow server responses should be logged as a warning.
qint64 slowResponseThresholdMs () const
 Gets or sets the threshold for the slow response time warning in ms.
void setSlowResponseThresholdMs (qint64 newSlowResponseThresholdMs)
 Gets or sets the threshold for the slow response time warning in ms.
QStringList corsHosts () const
 Gets or sets the cors hosts.
void setCorsHosts (QStringList newCorsHosts)
 Gets or sets the cors hosts.
std::optional< qint32 > activityLogRetentionDays () const
 Gets or sets the number of days we should retain activity logs.
void setActivityLogRetentionDays (std::optional< qint32 > newActivityLogRetentionDays)
 Gets or sets the number of days we should retain activity logs.
bool activityLogRetentionDaysNull () const
void setActivityLogRetentionDaysNull ()
qint32 libraryScanFanoutConcurrency () const
 Gets or sets the how the library scan fans out.
void setLibraryScanFanoutConcurrency (qint32 newLibraryScanFanoutConcurrency)
 Gets or sets the how the library scan fans out.
qint32 libraryMetadataRefreshConcurrency () const
 Gets or sets the how many metadata refreshes can run concurrently.
void setLibraryMetadataRefreshConcurrency (qint32 newLibraryMetadataRefreshConcurrency)
 Gets or sets the how many metadata refreshes can run concurrently.
bool removeOldPlugins () const
 Gets or sets a value indicating whether older plugins should automatically be deleted from the plugin folder.
void setRemoveOldPlugins (bool newRemoveOldPlugins)
 Gets or sets a value indicating whether older plugins should automatically be deleted from the plugin folder.
bool allowClientLogUpload () const
 Gets or sets a value indicating whether clients should be allowed to upload logs.
void setAllowClientLogUpload (bool newAllowClientLogUpload)
 Gets or sets a value indicating whether clients should be allowed to upload logs.
qint32 dummyChapterDuration () const
 Gets or sets the dummy chapter duration in seconds, use 0 (zero) or less to disable generation alltogether.
void setDummyChapterDuration (qint32 newDummyChapterDuration)
 Gets or sets the dummy chapter duration in seconds, use 0 (zero) or less to disable generation alltogether.
ImageResolution chapterImageResolution () const
void setChapterImageResolution (ImageResolution newChapterImageResolution)
qint32 parallelImageEncodingLimit () const
 Gets or sets the limit for parallel image encoding.
void setParallelImageEncodingLimit (qint32 newParallelImageEncodingLimit)
 Gets or sets the limit for parallel image encoding.
QList< CastReceiverApplicationcastReceiverApplications () const
 Gets or sets the list of cast receiver applications.
void setCastReceiverApplications (QList< CastReceiverApplication > newCastReceiverApplications)
 Gets or sets the list of cast receiver applications.
QSharedPointer< TrickplayOptionstrickplayOptions () const
void setTrickplayOptions (QSharedPointer< TrickplayOptions > newTrickplayOptions)

Static Public Member Functions

static ServerConfiguration fromJson (QJsonObject source)

Protected Attributes

qint32 m_logFileRetentionDays
bool m_isStartupWizardCompleted
QString m_cachePath
QString m_previousVersion
QString m_previousVersionStr
bool m_enableMetrics
bool m_enableNormalizedItemByNameIds
bool m_isPortAuthorized
bool m_quickConnectAvailable
bool m_enableCaseSensitiveItemIds
bool m_disableLiveTvChannelUserDataName
QString m_metadataPath
QString m_preferredMetadataLanguage
QString m_metadataCountryCode
QStringList m_sortReplaceCharacters
QStringList m_sortRemoveCharacters
QStringList m_sortRemoveWords
qint32 m_minResumePct
qint32 m_maxResumePct
qint32 m_minResumeDurationSeconds
qint32 m_minAudiobookResume
qint32 m_maxAudiobookResume
qint32 m_inactiveSessionThreshold
qint32 m_libraryMonitorDelay
qint32 m_libraryUpdateDuration
ImageSavingConvention m_imageSavingConvention
QList< MetadataOptionsm_metadataOptions
bool m_skipDeserializationForBasicTypes
QString m_serverName
QString m_uICulture
bool m_saveMetadataHidden
QList< NameValuePairm_contentTypes
qint32 m_remoteClientBitrateLimit
bool m_enableFolderView
bool m_enableGroupingIntoCollections
bool m_displaySpecialsWithinSeasons
QStringList m_codecsUsed
QList< RepositoryInfom_pluginRepositories
bool m_enableExternalContentInSuggestions
qint32 m_imageExtractionTimeoutMs
QList< PathSubstitutionm_pathSubstitutions
bool m_enableSlowResponseWarning
qint64 m_slowResponseThresholdMs
QStringList m_corsHosts
std::optional< qint32 > m_activityLogRetentionDays = std::nullopt
qint32 m_libraryScanFanoutConcurrency
qint32 m_libraryMetadataRefreshConcurrency
bool m_removeOldPlugins
bool m_allowClientLogUpload
qint32 m_dummyChapterDuration
ImageResolution m_chapterImageResolution
qint32 m_parallelImageEncodingLimit
QList< CastReceiverApplicationm_castReceiverApplications
QSharedPointer< TrickplayOptionsm_trickplayOptions = QSharedPointer<TrickplayOptions>()

Constructor & Destructor Documentation

◆ ServerConfiguration() [1/2]

Jellyfin::DTO::ServerConfiguration::ServerConfiguration ( qint32 logFileRetentionDays,
bool isStartupWizardCompleted,
bool enableMetrics,
bool enableNormalizedItemByNameIds,
bool isPortAuthorized,
bool quickConnectAvailable,
bool enableCaseSensitiveItemIds,
bool disableLiveTvChannelUserDataName,
QString metadataPath,
QString preferredMetadataLanguage,
QString metadataCountryCode,
QStringList sortReplaceCharacters,
QStringList sortRemoveCharacters,
QStringList sortRemoveWords,
qint32 minResumePct,
qint32 maxResumePct,
qint32 minResumeDurationSeconds,
qint32 minAudiobookResume,
qint32 maxAudiobookResume,
qint32 inactiveSessionThreshold,
qint32 libraryMonitorDelay,
qint32 libraryUpdateDuration,
ImageSavingConvention imageSavingConvention,
QList< MetadataOptions > metadataOptions,
bool skipDeserializationForBasicTypes,
QString serverName,
QString uICulture,
bool saveMetadataHidden,
QList< NameValuePair > contentTypes,
qint32 remoteClientBitrateLimit,
bool enableFolderView,
bool enableGroupingIntoCollections,
bool displaySpecialsWithinSeasons,
QStringList codecsUsed,
QList< RepositoryInfo > pluginRepositories,
bool enableExternalContentInSuggestions,
qint32 imageExtractionTimeoutMs,
QList< PathSubstitution > pathSubstitutions,
bool enableSlowResponseWarning,
qint64 slowResponseThresholdMs,
QStringList corsHosts,
qint32 libraryScanFanoutConcurrency,
qint32 libraryMetadataRefreshConcurrency,
bool removeOldPlugins,
bool allowClientLogUpload,
qint32 dummyChapterDuration,
ImageResolution chapterImageResolution,
qint32 parallelImageEncodingLimit,
QList< CastReceiverApplication > castReceiverApplications,
QSharedPointer< TrickplayOptions > trickplayOptions )

◆ ServerConfiguration() [2/2]

Jellyfin::DTO::ServerConfiguration::ServerConfiguration ( const ServerConfiguration & other)

Member Function Documentation

◆ activityLogRetentionDays()

std::optional< qint32 > Jellyfin::DTO::ServerConfiguration::activityLogRetentionDays ( ) const

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

◆ activityLogRetentionDaysNull()

bool Jellyfin::DTO::ServerConfiguration::activityLogRetentionDaysNull ( ) const

◆ allowClientLogUpload()

bool Jellyfin::DTO::ServerConfiguration::allowClientLogUpload ( ) const

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

◆ cachePath()

QString Jellyfin::DTO::ServerConfiguration::cachePath ( ) const

Gets or sets the cache path.

◆ cachePathNull()

bool Jellyfin::DTO::ServerConfiguration::cachePathNull ( ) const

◆ castReceiverApplications()

QList< CastReceiverApplication > Jellyfin::DTO::ServerConfiguration::castReceiverApplications ( ) const

Gets or sets the list of cast receiver applications.

◆ chapterImageResolution()

ImageResolution Jellyfin::DTO::ServerConfiguration::chapterImageResolution ( ) const

◆ codecsUsed()

QStringList Jellyfin::DTO::ServerConfiguration::codecsUsed ( ) const

◆ contentTypes()

QList< NameValuePair > Jellyfin::DTO::ServerConfiguration::contentTypes ( ) const

◆ corsHosts()

QStringList Jellyfin::DTO::ServerConfiguration::corsHosts ( ) const

Gets or sets the cors hosts.

◆ disableLiveTvChannelUserDataName()

bool Jellyfin::DTO::ServerConfiguration::disableLiveTvChannelUserDataName ( ) const

◆ displaySpecialsWithinSeasons()

bool Jellyfin::DTO::ServerConfiguration::displaySpecialsWithinSeasons ( ) const

◆ dummyChapterDuration()

qint32 Jellyfin::DTO::ServerConfiguration::dummyChapterDuration ( ) const

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

◆ enableCaseSensitiveItemIds()

bool Jellyfin::DTO::ServerConfiguration::enableCaseSensitiveItemIds ( ) const

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

◆ enableExternalContentInSuggestions()

bool Jellyfin::DTO::ServerConfiguration::enableExternalContentInSuggestions ( ) const

◆ enableFolderView()

bool Jellyfin::DTO::ServerConfiguration::enableFolderView ( ) const

◆ enableGroupingIntoCollections()

bool Jellyfin::DTO::ServerConfiguration::enableGroupingIntoCollections ( ) const

◆ enableMetrics()

bool Jellyfin::DTO::ServerConfiguration::enableMetrics ( ) const

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

◆ enableNormalizedItemByNameIds()

bool Jellyfin::DTO::ServerConfiguration::enableNormalizedItemByNameIds ( ) const

◆ enableSlowResponseWarning()

bool Jellyfin::DTO::ServerConfiguration::enableSlowResponseWarning ( ) const

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

◆ fromJson()

ServerConfiguration Jellyfin::DTO::ServerConfiguration::fromJson ( QJsonObject source)
static

◆ imageExtractionTimeoutMs()

qint32 Jellyfin::DTO::ServerConfiguration::imageExtractionTimeoutMs ( ) const

◆ imageSavingConvention()

ImageSavingConvention Jellyfin::DTO::ServerConfiguration::imageSavingConvention ( ) const

◆ inactiveSessionThreshold()

qint32 Jellyfin::DTO::ServerConfiguration::inactiveSessionThreshold ( ) const
   @brief 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()

bool Jellyfin::DTO::ServerConfiguration::isPortAuthorized ( ) const

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

◆ isStartupWizardCompleted()

bool Jellyfin::DTO::ServerConfiguration::isStartupWizardCompleted ( ) const

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

◆ libraryMetadataRefreshConcurrency()

qint32 Jellyfin::DTO::ServerConfiguration::libraryMetadataRefreshConcurrency ( ) const

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

◆ libraryMonitorDelay()

qint32 Jellyfin::DTO::ServerConfiguration::libraryMonitorDelay ( ) const
   @brief 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()

qint32 Jellyfin::DTO::ServerConfiguration::libraryScanFanoutConcurrency ( ) const

Gets or sets the how the library scan fans out.

◆ libraryUpdateDuration()

qint32 Jellyfin::DTO::ServerConfiguration::libraryUpdateDuration ( ) const

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

◆ logFileRetentionDays()

qint32 Jellyfin::DTO::ServerConfiguration::logFileRetentionDays ( ) const

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

◆ maxAudiobookResume()

qint32 Jellyfin::DTO::ServerConfiguration::maxAudiobookResume ( ) const

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.

◆ maxResumePct()

qint32 Jellyfin::DTO::ServerConfiguration::maxResumePct ( ) const

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.

◆ metadataCountryCode()

QString Jellyfin::DTO::ServerConfiguration::metadataCountryCode ( ) const

Gets or sets the metadata country code.

◆ metadataOptions()

QList< MetadataOptions > Jellyfin::DTO::ServerConfiguration::metadataOptions ( ) const

◆ metadataPath()

QString Jellyfin::DTO::ServerConfiguration::metadataPath ( ) const

Gets or sets the metadata path.

◆ minAudiobookResume()

qint32 Jellyfin::DTO::ServerConfiguration::minAudiobookResume ( ) const

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

◆ minResumeDurationSeconds()

qint32 Jellyfin::DTO::ServerConfiguration::minResumeDurationSeconds ( ) const

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

◆ minResumePct()

qint32 Jellyfin::DTO::ServerConfiguration::minResumePct ( ) const

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

◆ parallelImageEncodingLimit()

qint32 Jellyfin::DTO::ServerConfiguration::parallelImageEncodingLimit ( ) const

Gets or sets the limit for parallel image encoding.

◆ pathSubstitutions()

QList< PathSubstitution > Jellyfin::DTO::ServerConfiguration::pathSubstitutions ( ) const

◆ pluginRepositories()

QList< RepositoryInfo > Jellyfin::DTO::ServerConfiguration::pluginRepositories ( ) const

◆ preferredMetadataLanguage()

QString Jellyfin::DTO::ServerConfiguration::preferredMetadataLanguage ( ) const

Gets or sets the preferred metadata language.

◆ previousVersion()

QString Jellyfin::DTO::ServerConfiguration::previousVersion ( ) const

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

◆ previousVersionNull()

bool Jellyfin::DTO::ServerConfiguration::previousVersionNull ( ) const

◆ previousVersionStr()

QString Jellyfin::DTO::ServerConfiguration::previousVersionStr ( ) const
   @brief Gets or sets the stringified PreviousVersion to be stored/loaded,

because System.Version itself isn't xml-serializable.

◆ previousVersionStrNull()

bool Jellyfin::DTO::ServerConfiguration::previousVersionStrNull ( ) const

◆ quickConnectAvailable()

bool Jellyfin::DTO::ServerConfiguration::quickConnectAvailable ( ) const

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

◆ remoteClientBitrateLimit()

qint32 Jellyfin::DTO::ServerConfiguration::remoteClientBitrateLimit ( ) const

◆ removeOldPlugins()

bool Jellyfin::DTO::ServerConfiguration::removeOldPlugins ( ) const

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

◆ replaceData()

void Jellyfin::DTO::ServerConfiguration::replaceData ( ServerConfiguration & other)

Replaces the data being hold by this class with that of the other.

◆ saveMetadataHidden()

bool Jellyfin::DTO::ServerConfiguration::saveMetadataHidden ( ) const

◆ serverName()

QString Jellyfin::DTO::ServerConfiguration::serverName ( ) const

◆ setActivityLogRetentionDays()

void Jellyfin::DTO::ServerConfiguration::setActivityLogRetentionDays ( std::optional< qint32 > newActivityLogRetentionDays)

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

◆ setActivityLogRetentionDaysNull()

void Jellyfin::DTO::ServerConfiguration::setActivityLogRetentionDaysNull ( )

◆ setAllowClientLogUpload()

void Jellyfin::DTO::ServerConfiguration::setAllowClientLogUpload ( bool newAllowClientLogUpload)

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

◆ setCachePath()

void Jellyfin::DTO::ServerConfiguration::setCachePath ( QString newCachePath)

Gets or sets the cache path.

◆ setCachePathNull()

void Jellyfin::DTO::ServerConfiguration::setCachePathNull ( )

◆ setCastReceiverApplications()

void Jellyfin::DTO::ServerConfiguration::setCastReceiverApplications ( QList< CastReceiverApplication > newCastReceiverApplications)

Gets or sets the list of cast receiver applications.

◆ setChapterImageResolution()

void Jellyfin::DTO::ServerConfiguration::setChapterImageResolution ( ImageResolution newChapterImageResolution)

◆ setCodecsUsed()

void Jellyfin::DTO::ServerConfiguration::setCodecsUsed ( QStringList newCodecsUsed)

◆ setContentTypes()

void Jellyfin::DTO::ServerConfiguration::setContentTypes ( QList< NameValuePair > newContentTypes)

◆ setCorsHosts()

void Jellyfin::DTO::ServerConfiguration::setCorsHosts ( QStringList newCorsHosts)

Gets or sets the cors hosts.

◆ setDisableLiveTvChannelUserDataName()

void Jellyfin::DTO::ServerConfiguration::setDisableLiveTvChannelUserDataName ( bool newDisableLiveTvChannelUserDataName)

◆ setDisplaySpecialsWithinSeasons()

void Jellyfin::DTO::ServerConfiguration::setDisplaySpecialsWithinSeasons ( bool newDisplaySpecialsWithinSeasons)

◆ setDummyChapterDuration()

void Jellyfin::DTO::ServerConfiguration::setDummyChapterDuration ( qint32 newDummyChapterDuration)

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

◆ setEnableCaseSensitiveItemIds()

void Jellyfin::DTO::ServerConfiguration::setEnableCaseSensitiveItemIds ( bool newEnableCaseSensitiveItemIds)

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

◆ setEnableExternalContentInSuggestions()

void Jellyfin::DTO::ServerConfiguration::setEnableExternalContentInSuggestions ( bool newEnableExternalContentInSuggestions)

◆ setEnableFolderView()

void Jellyfin::DTO::ServerConfiguration::setEnableFolderView ( bool newEnableFolderView)

◆ setEnableGroupingIntoCollections()

void Jellyfin::DTO::ServerConfiguration::setEnableGroupingIntoCollections ( bool newEnableGroupingIntoCollections)

◆ setEnableMetrics()

void Jellyfin::DTO::ServerConfiguration::setEnableMetrics ( bool newEnableMetrics)

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

◆ setEnableNormalizedItemByNameIds()

void Jellyfin::DTO::ServerConfiguration::setEnableNormalizedItemByNameIds ( bool newEnableNormalizedItemByNameIds)

◆ setEnableSlowResponseWarning()

void Jellyfin::DTO::ServerConfiguration::setEnableSlowResponseWarning ( bool newEnableSlowResponseWarning)

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

◆ setFromJson()

void Jellyfin::DTO::ServerConfiguration::setFromJson ( QJsonObject source)

◆ setImageExtractionTimeoutMs()

void Jellyfin::DTO::ServerConfiguration::setImageExtractionTimeoutMs ( qint32 newImageExtractionTimeoutMs)

◆ setImageSavingConvention()

void Jellyfin::DTO::ServerConfiguration::setImageSavingConvention ( ImageSavingConvention newImageSavingConvention)

◆ setInactiveSessionThreshold()

void Jellyfin::DTO::ServerConfiguration::setInactiveSessionThreshold ( qint32 newInactiveSessionThreshold)
  @brief 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.

◆ setIsPortAuthorized()

void Jellyfin::DTO::ServerConfiguration::setIsPortAuthorized ( bool newIsPortAuthorized)

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

◆ setIsStartupWizardCompleted()

void Jellyfin::DTO::ServerConfiguration::setIsStartupWizardCompleted ( bool newIsStartupWizardCompleted)

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

◆ setLibraryMetadataRefreshConcurrency()

void Jellyfin::DTO::ServerConfiguration::setLibraryMetadataRefreshConcurrency ( qint32 newLibraryMetadataRefreshConcurrency)

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

◆ setLibraryMonitorDelay()

void Jellyfin::DTO::ServerConfiguration::setLibraryMonitorDelay ( qint32 newLibraryMonitorDelay)
  @brief 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.

◆ setLibraryScanFanoutConcurrency()

void Jellyfin::DTO::ServerConfiguration::setLibraryScanFanoutConcurrency ( qint32 newLibraryScanFanoutConcurrency)

Gets or sets the how the library scan fans out.

◆ setLibraryUpdateDuration()

void Jellyfin::DTO::ServerConfiguration::setLibraryUpdateDuration ( qint32 newLibraryUpdateDuration)

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

◆ setLogFileRetentionDays()

void Jellyfin::DTO::ServerConfiguration::setLogFileRetentionDays ( qint32 newLogFileRetentionDays)

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

◆ setMaxAudiobookResume()

void Jellyfin::DTO::ServerConfiguration::setMaxAudiobookResume ( qint32 newMaxAudiobookResume)

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.

◆ setMaxResumePct()

void Jellyfin::DTO::ServerConfiguration::setMaxResumePct ( qint32 newMaxResumePct)

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.

◆ setMetadataCountryCode()

void Jellyfin::DTO::ServerConfiguration::setMetadataCountryCode ( QString newMetadataCountryCode)

Gets or sets the metadata country code.

◆ setMetadataOptions()

void Jellyfin::DTO::ServerConfiguration::setMetadataOptions ( QList< MetadataOptions > newMetadataOptions)

◆ setMetadataPath()

void Jellyfin::DTO::ServerConfiguration::setMetadataPath ( QString newMetadataPath)

Gets or sets the metadata path.

◆ setMinAudiobookResume()

void Jellyfin::DTO::ServerConfiguration::setMinAudiobookResume ( qint32 newMinAudiobookResume)

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

◆ setMinResumeDurationSeconds()

void Jellyfin::DTO::ServerConfiguration::setMinResumeDurationSeconds ( qint32 newMinResumeDurationSeconds)

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

◆ setMinResumePct()

void Jellyfin::DTO::ServerConfiguration::setMinResumePct ( qint32 newMinResumePct)

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

◆ setParallelImageEncodingLimit()

void Jellyfin::DTO::ServerConfiguration::setParallelImageEncodingLimit ( qint32 newParallelImageEncodingLimit)

Gets or sets the limit for parallel image encoding.

◆ setPathSubstitutions()

void Jellyfin::DTO::ServerConfiguration::setPathSubstitutions ( QList< PathSubstitution > newPathSubstitutions)

◆ setPluginRepositories()

void Jellyfin::DTO::ServerConfiguration::setPluginRepositories ( QList< RepositoryInfo > newPluginRepositories)

◆ setPreferredMetadataLanguage()

void Jellyfin::DTO::ServerConfiguration::setPreferredMetadataLanguage ( QString newPreferredMetadataLanguage)

Gets or sets the preferred metadata language.

◆ setPreviousVersion()

void Jellyfin::DTO::ServerConfiguration::setPreviousVersion ( QString newPreviousVersion)

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

◆ setPreviousVersionNull()

void Jellyfin::DTO::ServerConfiguration::setPreviousVersionNull ( )

◆ setPreviousVersionStr()

void Jellyfin::DTO::ServerConfiguration::setPreviousVersionStr ( QString newPreviousVersionStr)
  @brief Gets or sets the stringified PreviousVersion to be stored/loaded,

because System.Version itself isn't xml-serializable.

◆ setPreviousVersionStrNull()

void Jellyfin::DTO::ServerConfiguration::setPreviousVersionStrNull ( )

◆ setQuickConnectAvailable()

void Jellyfin::DTO::ServerConfiguration::setQuickConnectAvailable ( bool newQuickConnectAvailable)

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

◆ setRemoteClientBitrateLimit()

void Jellyfin::DTO::ServerConfiguration::setRemoteClientBitrateLimit ( qint32 newRemoteClientBitrateLimit)

◆ setRemoveOldPlugins()

void Jellyfin::DTO::ServerConfiguration::setRemoveOldPlugins ( bool newRemoveOldPlugins)

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

◆ setSaveMetadataHidden()

void Jellyfin::DTO::ServerConfiguration::setSaveMetadataHidden ( bool newSaveMetadataHidden)

◆ setServerName()

void Jellyfin::DTO::ServerConfiguration::setServerName ( QString newServerName)

◆ setSkipDeserializationForBasicTypes()

void Jellyfin::DTO::ServerConfiguration::setSkipDeserializationForBasicTypes ( bool newSkipDeserializationForBasicTypes)

◆ setSlowResponseThresholdMs()

void Jellyfin::DTO::ServerConfiguration::setSlowResponseThresholdMs ( qint64 newSlowResponseThresholdMs)

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

◆ setSortRemoveCharacters()

void Jellyfin::DTO::ServerConfiguration::setSortRemoveCharacters ( QStringList newSortRemoveCharacters)

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

◆ setSortRemoveWords()

void Jellyfin::DTO::ServerConfiguration::setSortRemoveWords ( QStringList newSortRemoveWords)

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

◆ setSortReplaceCharacters()

void Jellyfin::DTO::ServerConfiguration::setSortReplaceCharacters ( QStringList newSortReplaceCharacters)

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

◆ setTrickplayOptions()

void Jellyfin::DTO::ServerConfiguration::setTrickplayOptions ( QSharedPointer< TrickplayOptions > newTrickplayOptions)

◆ setUICulture()

void Jellyfin::DTO::ServerConfiguration::setUICulture ( QString newUICulture)

◆ skipDeserializationForBasicTypes()

bool Jellyfin::DTO::ServerConfiguration::skipDeserializationForBasicTypes ( ) const

◆ slowResponseThresholdMs()

qint64 Jellyfin::DTO::ServerConfiguration::slowResponseThresholdMs ( ) const

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

◆ sortRemoveCharacters()

QStringList Jellyfin::DTO::ServerConfiguration::sortRemoveCharacters ( ) const

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

◆ sortRemoveWords()

QStringList Jellyfin::DTO::ServerConfiguration::sortRemoveWords ( ) const

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

◆ sortReplaceCharacters()

QStringList Jellyfin::DTO::ServerConfiguration::sortReplaceCharacters ( ) const

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

◆ toJson()

QJsonObject Jellyfin::DTO::ServerConfiguration::toJson ( ) const

◆ trickplayOptions()

QSharedPointer< TrickplayOptions > Jellyfin::DTO::ServerConfiguration::trickplayOptions ( ) const

◆ uICulture()

QString Jellyfin::DTO::ServerConfiguration::uICulture ( ) const

Member Data Documentation

◆ m_activityLogRetentionDays

std::optional<qint32> Jellyfin::DTO::ServerConfiguration::m_activityLogRetentionDays = std::nullopt
protected

◆ m_allowClientLogUpload

bool Jellyfin::DTO::ServerConfiguration::m_allowClientLogUpload
protected

◆ m_cachePath

QString Jellyfin::DTO::ServerConfiguration::m_cachePath
protected

◆ m_castReceiverApplications

QList<CastReceiverApplication> Jellyfin::DTO::ServerConfiguration::m_castReceiverApplications
protected

◆ m_chapterImageResolution

ImageResolution Jellyfin::DTO::ServerConfiguration::m_chapterImageResolution
protected

◆ m_codecsUsed

QStringList Jellyfin::DTO::ServerConfiguration::m_codecsUsed
protected

◆ m_contentTypes

QList<NameValuePair> Jellyfin::DTO::ServerConfiguration::m_contentTypes
protected

◆ m_corsHosts

QStringList Jellyfin::DTO::ServerConfiguration::m_corsHosts
protected

◆ m_disableLiveTvChannelUserDataName

bool Jellyfin::DTO::ServerConfiguration::m_disableLiveTvChannelUserDataName
protected

◆ m_displaySpecialsWithinSeasons

bool Jellyfin::DTO::ServerConfiguration::m_displaySpecialsWithinSeasons
protected

◆ m_dummyChapterDuration

qint32 Jellyfin::DTO::ServerConfiguration::m_dummyChapterDuration
protected

◆ m_enableCaseSensitiveItemIds

bool Jellyfin::DTO::ServerConfiguration::m_enableCaseSensitiveItemIds
protected

◆ m_enableExternalContentInSuggestions

bool Jellyfin::DTO::ServerConfiguration::m_enableExternalContentInSuggestions
protected

◆ m_enableFolderView

bool Jellyfin::DTO::ServerConfiguration::m_enableFolderView
protected

◆ m_enableGroupingIntoCollections

bool Jellyfin::DTO::ServerConfiguration::m_enableGroupingIntoCollections
protected

◆ m_enableMetrics

bool Jellyfin::DTO::ServerConfiguration::m_enableMetrics
protected

◆ m_enableNormalizedItemByNameIds

bool Jellyfin::DTO::ServerConfiguration::m_enableNormalizedItemByNameIds
protected

◆ m_enableSlowResponseWarning

bool Jellyfin::DTO::ServerConfiguration::m_enableSlowResponseWarning
protected

◆ m_imageExtractionTimeoutMs

qint32 Jellyfin::DTO::ServerConfiguration::m_imageExtractionTimeoutMs
protected

◆ m_imageSavingConvention

ImageSavingConvention Jellyfin::DTO::ServerConfiguration::m_imageSavingConvention
protected

◆ m_inactiveSessionThreshold

qint32 Jellyfin::DTO::ServerConfiguration::m_inactiveSessionThreshold
protected

◆ m_isPortAuthorized

bool Jellyfin::DTO::ServerConfiguration::m_isPortAuthorized
protected

◆ m_isStartupWizardCompleted

bool Jellyfin::DTO::ServerConfiguration::m_isStartupWizardCompleted
protected

◆ m_libraryMetadataRefreshConcurrency

qint32 Jellyfin::DTO::ServerConfiguration::m_libraryMetadataRefreshConcurrency
protected

◆ m_libraryMonitorDelay

qint32 Jellyfin::DTO::ServerConfiguration::m_libraryMonitorDelay
protected

◆ m_libraryScanFanoutConcurrency

qint32 Jellyfin::DTO::ServerConfiguration::m_libraryScanFanoutConcurrency
protected

◆ m_libraryUpdateDuration

qint32 Jellyfin::DTO::ServerConfiguration::m_libraryUpdateDuration
protected

◆ m_logFileRetentionDays

qint32 Jellyfin::DTO::ServerConfiguration::m_logFileRetentionDays
protected

◆ m_maxAudiobookResume

qint32 Jellyfin::DTO::ServerConfiguration::m_maxAudiobookResume
protected

◆ m_maxResumePct

qint32 Jellyfin::DTO::ServerConfiguration::m_maxResumePct
protected

◆ m_metadataCountryCode

QString Jellyfin::DTO::ServerConfiguration::m_metadataCountryCode
protected

◆ m_metadataOptions

QList<MetadataOptions> Jellyfin::DTO::ServerConfiguration::m_metadataOptions
protected

◆ m_metadataPath

QString Jellyfin::DTO::ServerConfiguration::m_metadataPath
protected

◆ m_minAudiobookResume

qint32 Jellyfin::DTO::ServerConfiguration::m_minAudiobookResume
protected

◆ m_minResumeDurationSeconds

qint32 Jellyfin::DTO::ServerConfiguration::m_minResumeDurationSeconds
protected

◆ m_minResumePct

qint32 Jellyfin::DTO::ServerConfiguration::m_minResumePct
protected

◆ m_parallelImageEncodingLimit

qint32 Jellyfin::DTO::ServerConfiguration::m_parallelImageEncodingLimit
protected

◆ m_pathSubstitutions

QList<PathSubstitution> Jellyfin::DTO::ServerConfiguration::m_pathSubstitutions
protected

◆ m_pluginRepositories

QList<RepositoryInfo> Jellyfin::DTO::ServerConfiguration::m_pluginRepositories
protected

◆ m_preferredMetadataLanguage

QString Jellyfin::DTO::ServerConfiguration::m_preferredMetadataLanguage
protected

◆ m_previousVersion

QString Jellyfin::DTO::ServerConfiguration::m_previousVersion
protected

◆ m_previousVersionStr

QString Jellyfin::DTO::ServerConfiguration::m_previousVersionStr
protected

◆ m_quickConnectAvailable

bool Jellyfin::DTO::ServerConfiguration::m_quickConnectAvailable
protected

◆ m_remoteClientBitrateLimit

qint32 Jellyfin::DTO::ServerConfiguration::m_remoteClientBitrateLimit
protected

◆ m_removeOldPlugins

bool Jellyfin::DTO::ServerConfiguration::m_removeOldPlugins
protected

◆ m_saveMetadataHidden

bool Jellyfin::DTO::ServerConfiguration::m_saveMetadataHidden
protected

◆ m_serverName

QString Jellyfin::DTO::ServerConfiguration::m_serverName
protected

◆ m_skipDeserializationForBasicTypes

bool Jellyfin::DTO::ServerConfiguration::m_skipDeserializationForBasicTypes
protected

◆ m_slowResponseThresholdMs

qint64 Jellyfin::DTO::ServerConfiguration::m_slowResponseThresholdMs
protected

◆ m_sortRemoveCharacters

QStringList Jellyfin::DTO::ServerConfiguration::m_sortRemoveCharacters
protected

◆ m_sortRemoveWords

QStringList Jellyfin::DTO::ServerConfiguration::m_sortRemoveWords
protected

◆ m_sortReplaceCharacters

QStringList Jellyfin::DTO::ServerConfiguration::m_sortReplaceCharacters
protected

◆ m_trickplayOptions

QSharedPointer<TrickplayOptions> Jellyfin::DTO::ServerConfiguration::m_trickplayOptions = QSharedPointer<TrickplayOptions>()
protected

◆ m_uICulture

QString Jellyfin::DTO::ServerConfiguration::m_uICulture
protected

The documentation for this class was generated from the following files: