CAdvancedSettings Class Reference

Inheritance diagram for CAdvancedSettings:

Collaboration diagram for CAdvancedSettings:

Public Types
typedef std::vector< std::pair< std::string, std::string > >	StringMapping

Public Member Functions
void	OnSettingsLoaded () override
	Settings have been loaded. More...
void	OnSettingsUnloaded () override
	Setting values have been unloaded. More...
void	OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override
	The value of the given setting has changed. More...
void	Initialize (CSettingsManager &settingsMgr)
void	Uninitialize (CSettingsManager &settingsMgr)
bool	Initialized () const
void	AddSettingsFile (const std::string &filename)
bool	Load (const CProfileManager &profileManager)
void	ParseSettingsFile (const std::string &file)
float	GetLatencyTweak (float refreshrate)
void	SetDebugMode (bool debug)
void	ToggleDirtyRegionVisualization ()
	Toggles dirty-region visualization.
Public Member Functions inherited from ISettingCallback
virtual bool	OnSettingChanging (const std::shared_ptr< const CSetting > &setting)
	The value of the given setting is being changed. More...
virtual void	OnSettingAction (const std::shared_ptr< const CSetting > &setting)
	The given setting has been activated. More...
virtual bool	OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode)
	The given setting needs to be updated. More...
virtual void	OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName)
	The given property of the given setting has changed. More...
Public Member Functions inherited from ISettingsHandler
virtual bool	OnSettingsLoading ()
	Settings loading has been initiated. More...
virtual bool	OnSettingsSaving () const
	Settings saving has been initiated. More...
virtual void	OnSettingsSaved () const
	Settings have been saved. More...
virtual void	OnSettingsCleared ()
	Settings have been cleared. More...

Static Public Member Functions
static void	GetCustomTVRegexps (TiXmlElement *pRootElement, SETTINGS_TVSHOWLIST &settings)
static void	GetCustomRegexps (TiXmlElement *pRootElement, std::vector< std::string > &settings)
static void	GetCustomExtensions (TiXmlElement *pRootElement, std::string &extensions)

Public Attributes
std::string	m_audioDefaultPlayer
float	m_audioPlayCountMinimumPercent
bool	m_VideoPlayerIgnoreDTSinWAV
float	m_limiterHold
float	m_limiterRelease
bool	m_omlSync = true
float	m_videoSubsDelayRange
float	m_videoAudioDelayRange
bool	m_videoUseTimeSeeking
int	m_videoTimeSeekForward
int	m_videoTimeSeekBackward
int	m_videoTimeSeekForwardBig
int	m_videoTimeSeekBackwardBig
int	m_videoPercentSeekForward
int	m_videoPercentSeekBackward
int	m_videoPercentSeekForwardBig
int	m_videoPercentSeekBackwardBig
std::vector< int >	m_seekSteps
std::string	m_videoPPFFmpegPostProc
bool	m_videoVDPAUtelecine
bool	m_videoVDPAUdeintSkipChromaHD
bool	m_musicUseTimeSeeking
int	m_musicTimeSeekForward
int	m_musicTimeSeekBackward
int	m_musicTimeSeekForwardBig
int	m_musicTimeSeekBackwardBig
int	m_musicPercentSeekForward
int	m_musicPercentSeekBackward
int	m_musicPercentSeekForwardBig
int	m_musicPercentSeekBackwardBig
int	m_videoIgnoreSecondsAtStart
float	m_videoIgnorePercentAtEnd
float	m_audioApplyDrc
unsigned int	m_maxPassthroughOffSyncDuration = 10
int	m_videoVDPAUScaling
float	m_videoNonLinStretchRatio
float	m_videoAutoScaleMaxFps
std::vector< RefreshOverride >	m_videoAdjustRefreshOverrides
std::vector< RefreshVideoLatency >	m_videoRefreshLatency
float	m_videoDefaultLatency
int	m_videoCaptureUseOcclusionQuery
bool	m_DXVACheckCompatibility
bool	m_DXVACheckCompatibilityPresent
int	m_videoFpsDetect
float	m_maxTempo
bool	m_videoPreferStereoStream = false
std::string	m_videoDefaultPlayer
float	m_videoPlayCountMinimumPercent
float	m_slideshowBlackBarCompensation
float	m_slideshowZoomAmount
float	m_slideshowPanAmount
int	m_songInfoDuration
int	m_logLevel
int	m_logLevelHint
std::string	m_cddbAddress
bool	m_addSourceOnTop
	True to put 'add source' buttons on top.
int	m_airTunesPort
int	m_airPlayPort
bool	m_handleMounting
	Only used in linux for the udisks and udisks2 providers defines if kodi should automount media drives. More...
bool	m_autoMountOpticalMedia {true}
	Only used in linux for the udisks and udisks2 providers defines if kodi should automount optical discs.
bool	m_fullScreenOnMovieStart
std::string	m_cachePath
std::string	m_videoCleanDateTimeRegExp
std::vector< std::string >	m_videoCleanStringRegExps
std::vector< std::string >	m_videoExcludeFromListingRegExps
std::vector< std::string >	m_allExcludeFromScanRegExps
std::vector< std::string >	m_moviesExcludeFromScanRegExps
std::vector< std::string >	m_tvshowExcludeFromScanRegExps
std::vector< std::string >	m_audioExcludeFromListingRegExps
std::vector< std::string >	m_audioExcludeFromScanRegExps
std::vector< std::string >	m_pictureExcludeFromListingRegExps
std::vector< std::string >	m_videoStackRegExps
std::vector< std::string >	m_folderStackRegExps
std::vector< std::string >	m_trailerMatchRegExps
SETTINGS_TVSHOWLIST	m_tvshowEnumRegExps
std::string	m_tvshowMultiPartEnumRegExp
StringMapping	m_pathSubstitutions
int	m_remoteDelay
	number of remote messages to ignore before repeating
bool	m_bScanIRServer
bool	m_playlistAsFolders
bool	m_detectAsUdf
unsigned int	m_fanartRes
	the maximal resolution to cache fanart at (assumes 16x9)
unsigned int	m_imageRes
	the maximal resolution to cache images at (assumes 16x9)
CPictureScalingAlgorithm::Algorithm	m_imageScalingAlgorithm
unsigned int	m_imageQualityJpeg
	the stored jpeg quality the lower the better (default: 4)
int	m_sambaclienttimeout
std::string	m_sambadoscodepage
bool	m_sambastatfiles
bool	m_bHTTPDirectoryStatFilesize
bool	m_bFTPThumbs
bool	m_bShoutcastArt
std::string	m_musicThumbs
std::vector< std::string >	m_musicArtistExtraArt
std::vector< std::string >	m_musicAlbumExtraArt
int	m_iMusicLibraryRecentlyAddedItems
int	m_iMusicLibraryDateAdded
bool	m_bMusicLibraryAllItemsOnBottom
bool	m_bMusicLibraryCleanOnUpdate
bool	m_bMusicLibraryArtistSortOnUpdate
bool	m_bMusicLibraryUseISODates
std::string	m_strMusicLibraryAlbumFormat
bool	m_prioritiseAPEv2tags
std::string	m_musicItemSeparator
std::vector< std::string >	m_musicArtistSeparators
std::string	m_videoItemSeparator
std::vector< std::string >	m_musicTagsFromFileFilters
bool	m_bVideoLibraryAllItemsOnBottom
int	m_iVideoLibraryRecentlyAddedItems
bool	m_bVideoLibraryCleanOnUpdate
bool	m_bVideoLibraryUseFastHash
bool	m_bVideoLibraryImportWatchedState {true}
bool	m_bVideoLibraryImportResumePoint {true}
std::vector< std::string >	m_videoEpisodeExtraArt
std::vector< std::string >	m_videoTvShowExtraArt
std::vector< std::string >	m_videoTvSeasonExtraArt
std::vector< std::string >	m_videoMovieExtraArt
std::vector< std::string >	m_videoMovieSetExtraArt
std::vector< std::string >	m_videoMusicVideoExtraArt
bool	m_bVideoScannerIgnoreErrors
int	m_iVideoLibraryDateAdded
std::set< std::string >	m_vecTokens
int	m_iEpgUpdateCheckInterval
int	m_iEpgCleanupInterval
int	m_iEpgActiveTagCheckInterval
int	m_iEpgRetryInterruptedUpdateInterval
int	m_iEpgUpdateEmptyTagsInterval
bool	m_bEpgDisplayUpdatePopup
bool	m_bEpgDisplayIncrementalUpdatePopup
bool	m_bEdlMergeShortCommBreaks
	If GUI notifications should be shown when reaching the start of commercial breaks.
bool	m_EdlDisplayCommbreakNotifications
int	m_iEdlMaxCommBreakLength
int	m_iEdlMinCommBreakLength
int	m_iEdlMaxCommBreakGap
int	m_iEdlMaxStartGap
int	m_iEdlCommBreakAutowait
int	m_iEdlCommBreakAutowind
int	m_curlconnecttimeout
int	m_curllowspeedtime
int	m_curlretries
int	m_curlKeepAliveInterval
bool	m_curlDisableIPV6
bool	m_curlDisableHTTP2
std::string	m_caTrustFile
bool	m_minimizeToTray
bool	m_fullScreen
bool	m_startFullScreen
bool	m_showExitButton
bool	m_canWindowed
bool	m_splashImage
bool	m_alwaysOnTop
int	m_playlistRetries
int	m_playlistTimeout
bool	m_GLRectangleHack
int	m_iSkipLoopFilter
bool	m_bVirtualShares
std::string	m_cpuTempCmd
std::string	m_gpuTempCmd
int	m_iPVRTimeCorrection
	correct all times (epg tags, timer tags, recording tags) by this amount of minutes. defaults to 0.
int	m_iPVRInfoToggleInterval
	if there are more than 1 pvr gui info item available (e.g. multiple recordings active at the same time), use this toggle delay in milliseconds. defaults to 3000.
bool	m_bPVRChannelIconsAutoScan
	automatically scan user defined folder for channel icons when loading internal channel groups
bool	m_bPVRAutoScanIconsUserSet
	mark channel icons populated by auto scan as "user set"
int	m_iPVRNumericChannelSwitchTimeout
	time in msecs after that a channel switch occurs after entering a channel number, if confirmchannelswitch is disabled
int	m_iPVRTimeshiftThreshold
	time diff between current playing time and timeshift buffer end, in seconds, before a playing stream is displayed as timeshifting.
bool	m_bPVRTimeshiftSimpleOSD
	use simple timeshift OSD (with progress only for the playing event instead of progress for the whole ts buffer).
SortDescription	m_PVRDefaultSortOrder
	SortDecription used to store default recording sort type and sort order.
DatabaseSettings	m_databaseMusic
DatabaseSettings	m_databaseVideo
DatabaseSettings	m_databaseTV
DatabaseSettings	m_databaseEpg
bool	m_useLocaleCollation
bool	m_guiVisualizeDirtyRegions
int	m_guiAlgorithmDirtyRegions
bool	m_guiSmartRedraw
unsigned int	m_addonPackageFolderSize
unsigned int	m_cacheMemSize
unsigned int	m_cacheBufferMode
unsigned int	m_cacheChunkSize
float	m_cacheReadFactor
bool	m_jsonOutputCompact
unsigned int	m_jsonTcpPort
bool	m_enableMultimediaKeys
std::vector< std::string >	m_settingsFiles
bool	m_initialized
std::string	m_videoExtensions
std::string	m_discStubExtensions
std::string	m_subtitlesExtensions
std::string	m_musicExtensions
std::string	m_pictureExtensions
std::string	m_stereoscopicregex_3d
std::string	m_stereoscopicregex_sbs
std::string	m_stereoscopicregex_tab
bool	m_openGlDebugging
std::string	m_userAgent
uint32_t	m_nfsTimeout
int	m_nfsRetries

Member Function Documentation

OnSettingChanged()

void CAdvancedSettings::OnSettingChanged ( const std::shared_ptr< const CSetting > &  setting )

overridevirtual

The value of the given setting has changed.

This callback is triggered whenever the value of a setting has been successfully changed (i.e. none of the OnSettingChanging() handlers) has reverted the change.

Parameters

setting

The setting whose value has been changed

Reimplemented from ISettingCallback.

OnSettingsLoaded()

void CAdvancedSettings::OnSettingsLoaded ( )

overridevirtual

Settings have been loaded.

This callback can be used to trigger loading other settings.

Reimplemented from ISettingsHandler.

OnSettingsUnloaded()

void CAdvancedSettings::OnSettingsUnloaded ( )

overridevirtual

Setting values have been unloaded.

This callback can be used to trigger uninitializing any state variables (e.g. before re-loading the settings).

Reimplemented from ISettingsHandler.

ParseSettingsFile()

void CAdvancedSettings::ParseSettingsFile

(

const std::string &

file

)

Todo:

Should cache path be given in terms of our predefined paths?? Are we even going to have predefined paths??

Member Data Documentation

m_databaseEpg

DatabaseSettings CAdvancedSettings::m_databaseEpg

advanced EPG database setup

m_handleMounting

bool CAdvancedSettings::m_handleMounting

Only used in linux for the udisks and udisks2 providers defines if kodi should automount media drives.

Note

if kodi is running standalone (–standalone option) it will be set to tue

---

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

• xbmc/settings/AdvancedSettings.h
• xbmc/settings/AdvancedSettings.cpp