| 
    Kodi Documentation 22.0
    
   Kodi is an open source media player and entertainment hub. 
   | 
 
#include <AdvancedSettings.h>
  
Public Types | |
| using | StringMapping = std::vector<std::pair<std::string, std::string>> | 
Public Member Functions | |
| CAdvancedSettings ()=default | |
| void | OnSettingsLoaded () override | 
| Settings have been loaded.   | |
| void | OnSettingsUnloaded () override | 
| Setting values have been unloaded.   | |
| void | OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override | 
| The value of the given setting has changed.   | |
| 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, bool isHDREnabled) const | 
| void | SetDebugMode (bool debug) | 
| void | ToggleDirtyRegionVisualization () | 
| Toggles dirty-region visualization.   | |
  Public Member Functions inherited from ISettingCallback | |
| virtual | ~ISettingCallback ()=default | 
| virtual bool | OnSettingChanging (const std::shared_ptr< const CSetting > &setting) | 
| The value of the given setting is being changed.   | |
| virtual void | OnSettingAction (const std::shared_ptr< const CSetting > &setting) | 
| The given setting has been activated.   | |
| virtual bool | OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode) | 
| The given setting needs to be updated.   | |
| virtual void | OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName) | 
| The given property of the given setting has changed.   | |
  Public Member Functions inherited from ISettingsHandler | |
| virtual | ~ISettingsHandler ()=default | 
| virtual bool | OnSettingsLoading () | 
| Settings loading has been initiated.   | |
| virtual bool | OnSettingsSaving () const | 
| Settings saving has been initiated.   | |
| virtual void | OnSettingsSaved () const | 
| Settings have been saved.   | |
| virtual void | OnSettingsCleared () | 
| Settings have been cleared.   | |
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 (const TiXmlElement *pRootElement, std::string &extensions) | 
| using CAdvancedSettings::StringMapping = std::vector<std::pair<std::string, std::string>> | 
      
  | 
  default | 
| void CAdvancedSettings::AddSettingsFile | ( | const std::string & | filename | ) | 
      
  | 
  static | 
      
  | 
  static | 
      
  | 
  static | 
| float CAdvancedSettings::GetLatencyTweak | ( | float | refreshrate, | 
| bool | isHDREnabled ) const | 
| void CAdvancedSettings::Initialize | ( | CSettingsManager & | settingsMgr | ) | 
      
  | 
  inline | 
| bool CAdvancedSettings::Load | ( | const CProfileManager & | profileManager | ) | 
      
  | 
  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.
| setting | The setting whose value has been changed | 
Reimplemented from ISettingCallback.
      
  | 
  overridevirtual | 
Settings have been loaded.
This callback can be used to trigger loading other settings.
Reimplemented from ISettingsHandler.
      
  | 
  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.
| void CAdvancedSettings::ParseSettingsFile | ( | const std::string & | file | ) | 
      
  | 
  inline | 
Toggles dirty-region visualization.
| void CAdvancedSettings::Uninitialize | ( | CSettingsManager & | settingsMgr | ) | 
| unsigned int CAdvancedSettings::m_addonPackageFolderSize | 
| bool CAdvancedSettings::m_addSourceOnTop | 
True to put 'add source' buttons on top.
| int CAdvancedSettings::m_airPlayPort | 
| int CAdvancedSettings::m_airTunesPort | 
| std::vector<std::string> CAdvancedSettings::m_allExcludeFromScanRegExps | 
| bool CAdvancedSettings::m_AllowMultiChannelFloat = false | 
| bool CAdvancedSettings::m_alwaysOnTop | 
| float CAdvancedSettings::m_audioApplyDrc | 
| std::string CAdvancedSettings::m_audioDefaultPlayer | 
| std::vector<std::string> CAdvancedSettings::m_audioExcludeFromListingRegExps | 
| std::vector<std::string> CAdvancedSettings::m_audioExcludeFromScanRegExps | 
| float CAdvancedSettings::m_audioPlayCountMinimumPercent | 
| bool CAdvancedSettings::m_autoMountOpticalMedia {true} | 
Only used in linux for the udisks and udisks2 providers defines if kodi should automount optical discs.
| bool CAdvancedSettings::m_bEdlMergeShortCommBreaks | 
If GUI notifications should be shown when reaching the start of commercial breaks.
| bool CAdvancedSettings::m_bEpgDisplayIncrementalUpdatePopup | 
| bool CAdvancedSettings::m_bEpgDisplayUpdatePopup | 
| bool CAdvancedSettings::m_bFTPThumbs | 
| bool CAdvancedSettings::m_bHTTPDirectoryStatFilesize | 
| bool CAdvancedSettings::m_bMusicLibraryAllItemsOnBottom | 
| bool CAdvancedSettings::m_bMusicLibraryArtistNavigatesToSongs | 
| bool CAdvancedSettings::m_bMusicLibraryArtistSortOnUpdate | 
| bool CAdvancedSettings::m_bMusicLibraryCleanOnUpdate | 
| bool CAdvancedSettings::m_bMusicLibraryUseISODates | 
| bool CAdvancedSettings::m_bNoRemoteArtWithLocalScraper {false} | 
| bool CAdvancedSettings::m_bPVRAutoScanIconsUserSet | 
mark channel icons populated by auto scan as "user set"
| bool CAdvancedSettings::m_bPVRChannelIconsAutoScan | 
automatically scan user defined folder for channel icons when loading internal channel groups
| bool CAdvancedSettings::m_bPVRTimeshiftSimpleOSD | 
use simple timeshift OSD (with progress only for the playing event instead of progress for the whole ts buffer).
| bool CAdvancedSettings::m_bScanIRServer | 
| bool CAdvancedSettings::m_bShoutcastArt | 
| bool CAdvancedSettings::m_bVideoLibraryAllItemsOnBottom | 
| bool CAdvancedSettings::m_bVideoLibraryCleanOnUpdate | 
| bool CAdvancedSettings::m_bVideoLibraryImportResumePoint {true} | 
| bool CAdvancedSettings::m_bVideoLibraryImportWatchedState {true} | 
| bool CAdvancedSettings::m_bVideoLibraryUseFastHash | 
| bool CAdvancedSettings::m_bVideoScannerIgnoreErrors | 
| bool CAdvancedSettings::m_bVirtualShares | 
| std::string CAdvancedSettings::m_cachePath | 
| bool CAdvancedSettings::m_canWindowed | 
| bool CAdvancedSettings::m_caseSensitiveLocalArtMatch {true} | 
| std::string CAdvancedSettings::m_caTrustFile | 
| std::string CAdvancedSettings::m_cddbAddress | 
| std::string CAdvancedSettings::m_cpuTempCmd | 
| int CAdvancedSettings::m_curlconnecttimeout | 
| bool CAdvancedSettings::m_curlDisableHTTP2 | 
| bool CAdvancedSettings::m_curlDisableIPV6 | 
| int CAdvancedSettings::m_curlKeepAliveInterval | 
| int CAdvancedSettings::m_curllowspeedtime | 
| int CAdvancedSettings::m_curlretries | 
| DatabaseSettings CAdvancedSettings::m_databaseEpg | 
advanced EPG database setup
| DatabaseSettings CAdvancedSettings::m_databaseMusic | 
| DatabaseSettings CAdvancedSettings::m_databaseTV | 
| DatabaseSettings CAdvancedSettings::m_databaseVideo | 
| bool CAdvancedSettings::m_detectAsUdf | 
| bool CAdvancedSettings::m_disableEpisodeRanges {false} | 
| std::string CAdvancedSettings::m_discStubExtensions | 
| bool CAdvancedSettings::m_DXVACheckCompatibility | 
| bool CAdvancedSettings::m_DXVACheckCompatibilityPresent | 
| bool CAdvancedSettings::m_EdlDisplayCommbreakNotifications | 
| bool CAdvancedSettings::m_enableMultimediaKeys | 
| unsigned int CAdvancedSettings::m_fanartRes | 
the maximal resolution to cache fanart at (assumes 16x9)
| std::vector<CRegExp> CAdvancedSettings::m_folderStackRegExps | 
| bool CAdvancedSettings::m_fullScreen {false} | 
| bool CAdvancedSettings::m_fullScreenOnMovieStart | 
| bool CAdvancedSettings::m_GLRectangleHack | 
| std::string CAdvancedSettings::m_gpuTempCmd | 
| int CAdvancedSettings::m_guiAlgorithmDirtyRegions | 
| int32_t CAdvancedSettings::m_guiAnisotropicFiltering {0} | 
| bool CAdvancedSettings::m_guiAsyncTextureUpload {false} | 
| bool CAdvancedSettings::m_guiFrontToBackRendering {false} | 
| bool CAdvancedSettings::m_guiGeometryClear {true} | 
| bool CAdvancedSettings::m_guiSmartRedraw | 
| bool CAdvancedSettings::m_guiVideoLayoutTransparent {false} | 
| bool CAdvancedSettings::m_guiVisualizeDirtyRegions | 
| bool CAdvancedSettings::m_handleMounting | 
Only used in linux for the udisks and udisks2 providers defines if kodi should automount media drives.
| int CAdvancedSettings::m_iEdlCommBreakAutowait | 
| int CAdvancedSettings::m_iEdlCommBreakAutowind | 
| int CAdvancedSettings::m_iEdlMaxCommBreakGap | 
| int CAdvancedSettings::m_iEdlMaxCommBreakLength | 
| int CAdvancedSettings::m_iEdlMaxStartGap | 
| int CAdvancedSettings::m_iEdlMinCommBreakLength | 
| int CAdvancedSettings::m_iEpgActiveTagCheckInterval | 
| int CAdvancedSettings::m_iEpgCleanupInterval | 
| int CAdvancedSettings::m_iEpgRetryInterruptedUpdateInterval | 
| int CAdvancedSettings::m_iEpgUpdateCheckInterval | 
| int CAdvancedSettings::m_iEpgUpdateEmptyTagsInterval | 
| unsigned int CAdvancedSettings::m_imageQualityJpeg | 
the stored jpeg quality the lower the better (default: 4)
| unsigned int CAdvancedSettings::m_imageRes | 
the maximal resolution to cache images at (assumes 16x9)
| CPictureScalingAlgorithm::Algorithm CAdvancedSettings::m_imageScalingAlgorithm | 
| int CAdvancedSettings::m_iMusicLibraryDateAdded | 
| int CAdvancedSettings::m_iMusicLibraryRecentlyAddedItems | 
| bool CAdvancedSettings::m_initialized {false} | 
| int CAdvancedSettings::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.
| uint32_t CAdvancedSettings::m_iPVRNumericChannelSwitchTimeout | 
time in msecs after that a channel switch occurs after entering a channel number, if confirmchannelswitch is disabled
| int CAdvancedSettings::m_iPVRTimeCorrection | 
correct all times (epg tags, timer tags, recording tags) by this amount of minutes. defaults to 0.
| int CAdvancedSettings::m_iPVRTimeshiftThreshold | 
time diff between current playing time and timeshift buffer end, in seconds, before a playing stream is displayed as timeshifting.
| int CAdvancedSettings::m_iSkipLoopFilter | 
| int CAdvancedSettings::m_iVideoLibraryDateAdded | 
| int CAdvancedSettings::m_iVideoLibraryRecentlyAddedItems | 
| bool CAdvancedSettings::m_jsonOutputCompact | 
| unsigned int CAdvancedSettings::m_jsonTcpPort | 
| float CAdvancedSettings::m_limiterHold | 
| float CAdvancedSettings::m_limiterRelease | 
| int CAdvancedSettings::m_logLevel | 
| int CAdvancedSettings::m_logLevelHint | 
| unsigned int CAdvancedSettings::m_maxPassthroughOffSyncDuration = 50 | 
| float CAdvancedSettings::m_maxTempo | 
| bool CAdvancedSettings::m_minimizeToTray | 
| int CAdvancedSettings::m_minimumEpisodePlaylistDuration | 
| std::vector<std::string> CAdvancedSettings::m_moviesExcludeFromScanRegExps | 
| std::vector<std::string> CAdvancedSettings::m_musicArtistSeparators | 
| std::string CAdvancedSettings::m_musicExtensions | 
| std::string CAdvancedSettings::m_musicItemSeparator | 
| int CAdvancedSettings::m_musicPercentSeekBackward | 
| int CAdvancedSettings::m_musicPercentSeekBackwardBig | 
| int CAdvancedSettings::m_musicPercentSeekForward | 
| int CAdvancedSettings::m_musicPercentSeekForwardBig | 
| std::vector<std::string> CAdvancedSettings::m_musicTagsFromFileFilters | 
| std::string CAdvancedSettings::m_musicThumbs | 
| int CAdvancedSettings::m_musicTimeSeekBackward | 
| int CAdvancedSettings::m_musicTimeSeekBackwardBig | 
| int CAdvancedSettings::m_musicTimeSeekForward | 
| int CAdvancedSettings::m_musicTimeSeekForwardBig | 
| bool CAdvancedSettings::m_musicUseTimeSeeking | 
| int CAdvancedSettings::m_nfsRetries | 
| uint32_t CAdvancedSettings::m_nfsTimeout | 
| bool CAdvancedSettings::m_omlSync = true | 
| bool CAdvancedSettings::m_openGlDebugging | 
| StringMapping CAdvancedSettings::m_pathSubstitutions | 
| std::vector<std::string> CAdvancedSettings::m_pictureExcludeFromListingRegExps | 
| std::string CAdvancedSettings::m_pictureExtensions | 
| bool CAdvancedSettings::m_playlistAsFolders | 
| int CAdvancedSettings::m_playlistRetries | 
| int CAdvancedSettings::m_playlistTimeout | 
| bool CAdvancedSettings::m_prioritiseAPEv2tags | 
| SortDescription CAdvancedSettings::m_PVRDefaultSortOrder | 
SortDecription used to store default recording sort type and sort order.
| int CAdvancedSettings::m_remoteDelay | 
number of remote messages to ignore before repeating
| int CAdvancedSettings::m_sambaclienttimeout | 
| std::string CAdvancedSettings::m_sambadoscodepage | 
| bool CAdvancedSettings::m_sambastatfiles | 
| std::vector<int> CAdvancedSettings::m_seekSteps | 
| std::vector<std::string> CAdvancedSettings::m_settingsFiles | 
| bool CAdvancedSettings::m_showExitButton | 
| float CAdvancedSettings::m_slideshowBlackBarCompensation | 
| float CAdvancedSettings::m_slideshowPanAmount | 
| float CAdvancedSettings::m_slideshowZoomAmount | 
| int CAdvancedSettings::m_songInfoDuration | 
| bool CAdvancedSettings::m_splashImage | 
| bool CAdvancedSettings::m_startFullScreen | 
| std::string CAdvancedSettings::m_stereoscopicregex_3d | 
| std::string CAdvancedSettings::m_stereoscopicregex_sbs | 
| std::string CAdvancedSettings::m_stereoscopicregex_tab | 
| std::string CAdvancedSettings::m_strMusicLibraryAlbumFormat | 
| std::string CAdvancedSettings::m_subtitlesExtensions | 
| bool CAdvancedSettings::m_superviseAudioDelay = false | 
| std::string CAdvancedSettings::m_titleTrailingPartNumberRegExp | 
| std::vector<std::string> CAdvancedSettings::m_trailerMatchRegExps | 
| std::string CAdvancedSettings::m_trailingPartNumberRegExp | 
| SETTINGS_TVSHOWLIST CAdvancedSettings::m_tvshowEnumRegExps | 
| std::vector<std::string> CAdvancedSettings::m_tvshowExcludeFromScanRegExps | 
| std::string CAdvancedSettings::m_tvshowMultiPartEnumRegExp | 
| bool CAdvancedSettings::m_useLocaleCollation | 
| std::string CAdvancedSettings::m_userAgent | 
| CLangInfo::Tokens CAdvancedSettings::m_vecTokens | 
| std::vector<RefreshOverride> CAdvancedSettings::m_videoAdjustRefreshOverrides | 
| float CAdvancedSettings::m_videoAudioDelayRange | 
| float CAdvancedSettings::m_videoAudioDelayStep | 
| float CAdvancedSettings::m_videoAutoScaleMaxFps | 
| bool CAdvancedSettings::m_videoBypassCodecProfile = false | 
| int CAdvancedSettings::m_videoCaptureUseOcclusionQuery | 
| std::string CAdvancedSettings::m_videoCleanDateTimeRegExp | 
| std::vector<std::string> CAdvancedSettings::m_videoCleanStringRegExps | 
| float CAdvancedSettings::m_videoDefaultHdrExtraLatency | 
| float CAdvancedSettings::m_videoDefaultLatency | 
| std::string CAdvancedSettings::m_videoDefaultPlayer | 
| std::vector<std::string> CAdvancedSettings::m_videoExcludeFromListingRegExps | 
| std::string CAdvancedSettings::m_videoExtensions | 
| std::string CAdvancedSettings::m_videoFilenameIdentifierRegExp | 
| int CAdvancedSettings::m_videoFpsDetect | 
| float CAdvancedSettings::m_videoIgnorePercentAtEnd | 
| int CAdvancedSettings::m_videoIgnoreSecondsAtStart | 
| std::string CAdvancedSettings::m_videoItemSeparator | 
| float CAdvancedSettings::m_videoNonLinStretchRatio | 
| int CAdvancedSettings::m_videoPercentSeekBackward | 
| int CAdvancedSettings::m_videoPercentSeekBackwardBig | 
| int CAdvancedSettings::m_videoPercentSeekForward | 
| int CAdvancedSettings::m_videoPercentSeekForwardBig | 
| float CAdvancedSettings::m_videoPlayCountMinimumPercent | 
| std::string CAdvancedSettings::m_videoPPFFmpegPostProc | 
| bool CAdvancedSettings::m_videoPreferStereoStream = false | 
| std::vector<RefreshVideoLatency> CAdvancedSettings::m_videoRefreshLatency | 
| std::vector<CRegExp> CAdvancedSettings::m_videoStackRegExps | 
| float CAdvancedSettings::m_videoSubsDelayRange | 
| float CAdvancedSettings::m_videoSubsDelayStep | 
| int CAdvancedSettings::m_videoTimeSeekBackward | 
| int CAdvancedSettings::m_videoTimeSeekBackwardBig | 
| int CAdvancedSettings::m_videoTimeSeekForward | 
| int CAdvancedSettings::m_videoTimeSeekForwardBig | 
| bool CAdvancedSettings::m_videoUseTimeSeeking | 
| bool CAdvancedSettings::m_videoVDPAUdeintSkipChromaHD | 
| int CAdvancedSettings::m_videoVDPAUScaling | 
| bool CAdvancedSettings::m_videoVDPAUtelecine |