Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
ADDON Namespace Reference

Namespaces

namespace  AddonEvents
 
namespace  GUI
 

Classes

struct  AddonEvent
 
struct  AddonIdFinder
 
class  CAddon
 
class  CAddonBuilder
 
class  CAddonDatabase
 
class  CAddonDatabaseSerializer
 Addon content serializer/deserializer. More...
 
class  CAddonDll
 
class  CAddonDllInformer
 Information class for use on addon type managers. More...
 
class  CAddonExtensions
 
class  CAddonGUITranslator
 Translates data types from GUI API to the corresponding format in Kodi. More...
 
class  CAddonInfo
 
class  CAddonInfoBuilder
 
class  CAddonInfoBuilderFromDB
 
class  CAddonInstaller
 
class  CAddonMgr
 
class  CAddonRepos
 
class  CAddonSettings
 
class  CAddonStatusHandler
 
class  CAddonSystemSettings
 
class  CAddonType
 
class  CAddonUpdateRules
 
class  CAddonVersion
 
class  CBinaryAddonBase
 
class  CBinaryAddonCache
 
class  CBinaryAddonManager
 
class  CContextMenuAddon
 
class  CExtValues
 
class  CFontResource
 
class  CGameResource
 
class  CGUIAddonRenderingControl
 
class  CGUIAddonWindow
 
class  CGUIAddonWindowDialog
 
class  CImageResource
 A collection of images. The collection can have a type. More...
 
class  CLanguageResource
 
struct  closestRes
 
struct  ContentMapping
 
class  CPluginSource
 
class  CRepository
 
class  CRepositoryUpdateJob
 
class  CRepositoryUpdater
 
class  CResource
 
class  CScraper
 
class  CScraperError
 
class  CService
 
class  CServiceAddonManager
 
class  CSettingUrlEncodedString
 
class  CSkinInfo
 
class  CSkinSetting
 
class  CSkinSettingBool
 
class  CSkinSettingString
 
class  CSkinSettingUpdateHandler
 
class  CUISoundsResource
 
class  CVFSAddonCache
 
class  CVFSEntry
 A virtual filesystem entry add-on. More...
 
class  CVFSEntryIDirectoryWrapper
 Wrapper equpping a CVFSEntry with an IDirectory interface. More...
 
class  CVFSEntryIFileDirectoryWrapper
 Wrapper equpping a CVFSEntry with an IFileDirectory interface. More...
 
class  CVFSEntryIFileWrapper
 Wrapper equipping a CVFSEntry with an IFile interface. More...
 
class  CVFSURLWrapper
 
class  CWebinterface
 
struct  DependencyInfo
 
class  IAddon
 
class  IAddonInstanceHandler
 
class  IAddonMgrCallback
 
class  IAddonProvider
 
struct  Interface_Android
 
struct  Interface_AudioEngine
 
struct  Interface_Base
 Global general Add-on to Kodi callback functions. More...
 
struct  Interface_Filesystem
 
struct  Interface_General
 Global general Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlAddonRendering
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlButton
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlEdit
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlFadeLabel
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlImage
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlLabel
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlProgress
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlRadioButton
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlSettingsSlider
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlSlider
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlSpin
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIControlTextBox
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIDialogContextMenu
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIDialogExtendedProgress
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIDialogFileBrowser
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIDialogKeyboard
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIDialogNumeric
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIDialogOK
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIDialogProgress
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIDialogSelect
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIDialogTextViewer
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIDialogYesNo
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIGeneral
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIListItem
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_GUIWindow
 Global gui Add-on to Kodi callback functions. More...
 
struct  Interface_Network
 Global general Add-on to Kodi callback functions. More...
 
struct  RepoInfo
 
struct  RepositoryDirInfo
 
struct  SExtValue
 
struct  TypeMapping
 

Typedefs

using AddonInfoPtr = std::shared_ptr<CAddonInfo>
 
using AddonPtr = std::shared_ptr<IAddon>
 
using VECADDONS = std::vector<AddonPtr>
 
typedef std::vector< std::pair< std::string, CAddonExtensions > > EXT_ELEMENTS
 
typedef std::vector< std::pair< std::string, SExtValue > > EXT_VALUE
 
typedef std::vector< std::pair< std::string, CExtValues > > EXT_VALUES
 
typedef std::vector< AddonInfoPtrAddonInfos
 
using AddonInstanceId = uint32_t
 
using InfoMap = std::map<std::string, std::string>
 
using ArtMap = std::map<std::string, std::string>
 
using RepositoryPtr = std::shared_ptr<CRepository>
 
using ADDON_INFO_LIST = std::map<std::string, AddonInfoPtr>
 
using AddonWithUpdate = std::pair<std::shared_ptr<IAddon>, std::shared_ptr<IAddon>>
 
using BinaryAddonBasePtr = std::shared_ptr<CBinaryAddonBase>
 
using ADDON_INSTANCE_HANDLER = void*
 
using AddonDllPtr = std::shared_ptr<CAddonDll>
 
typedef void *(* ADDON_GET_INTERFACE_FN) (const std::string &name, const std::string &version)
 
typedef std::map< std::string, std::vector< std::string > > ContentPathMap
 
typedef std::vector< RepositoryDirInfoRepositoryDirList
 
typedef std::shared_ptr< CScraperScraperPtr
 
typedef std::shared_ptr< CSkinSettingCSkinSettingPtr
 
typedef std::shared_ptr< CSkinSettingStringCSkinSettingStringPtr
 
typedef std::shared_ptr< CSkinSettingBoolCSkinSettingBoolPtr
 
typedef std::shared_ptr< CVFSEntryVFSEntryPtr
 
typedef enum ADDON::WebinterfaceType WebinterfaceType
 

Enumerations

enum class  AddonDisabledReason { NONE = 0 , USER = 1 , INCOMPATIBLE = 2 , PERMANENT_FAILURE = 3 }
 
enum class  AddonOriginType { SYSTEM = 0 , REPOSITORY = 1 , MANUAL = 2 }
 
enum class  AddonUpdateRule { ANY = 0 , USER_DISABLED_AUTO_UPDATE = 1 , PIN_OLD_VERSION = 2 , PIN_ZIP_INSTALL = 3 }
 Reasons why an addon is not updateable. More...
 
enum class  AddonInstanceSupport { SUPPORT_NONE = 0 , SUPPORT_MANDATORY = 1 , SUPPORT_OPTIONAL = 2 , SUPPORT_SETTINGS = 3 }
 Independent add-on instance support. More...
 
enum class  AddonLifecycleState { NORMAL = 0 , DEPRECATED = 1 , BROKEN = 2 }
 Add-on state defined within addon.xml to report about the current addon lifecycle state. More...
 
enum class  AddonType {
  UNKNOWN = 0 , VISUALIZATION , SKIN , PVRDLL ,
  INPUTSTREAM , GAMEDLL , PERIPHERALDLL , SCRIPT ,
  SCRIPT_WEATHER , SUBTITLE_MODULE , SCRIPT_LYRICS , SCRAPER_ALBUMS ,
  SCRAPER_ARTISTS , SCRAPER_MOVIES , SCRAPER_MUSICVIDEOS , SCRAPER_TVSHOWS ,
  SCREENSAVER , PLUGIN , REPOSITORY , WEB_INTERFACE ,
  SERVICE , AUDIOENCODER , CONTEXTMENU_ITEM , AUDIODECODER ,
  RESOURCE_IMAGES , RESOURCE_LANGUAGE , RESOURCE_UISOUNDS , RESOURCE_GAMES ,
  RESOURCE_FONT , VFS , IMAGEDECODER , SCRAPER_LIBRARY ,
  SCRIPT_LIBRARY , SCRIPT_MODULE , GAME_CONTROLLER , VIDEOCODEC ,
  VIDEO , AUDIO , IMAGE , EXECUTABLE ,
  GAME , MAX_TYPES
}
 
enum class  BackgroundJob : bool { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  ModalJob : bool { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  AutoUpdateJob : bool { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  DependencyJob : bool { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  InstallModalPrompt : bool { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  AllowCheckForUpdates : bool { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  RecurseOrphaned : bool { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  AddonCheckType : bool { OUTDATED_ADDONS , AVAILABLE_UPDATES }
 
enum class  OnlyEnabled : bool { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  OnlyEnabledRootAddon : bool { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  CheckIncompatible : bool { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  CheckAddonPath { CHOICE_YES = true , CHOICE_NO = false }
 
enum class  AddonRepoUpdateMode { OFFICIAL_ONLY = 0 , ANY_REPOSITORY = 1 }
 
enum  WebinterfaceType { WebinterfaceTypeStatic = 0 , WebinterfaceTypeWsgi }
 

Functions

template<class TSetting >
bool GetSettingValue (CAddon &addon, AddonInstanceId instanceId, const std::string &key, typename TSetting::Value &value)
 
template<class TSetting >
bool UpdateSettingValue (CAddon &addon, AddonInstanceId instanceId, const std::string &key, typename TSetting::Value value)
 
void OnPreInstall (const AddonPtr &addon)
 
void OnPostInstall (const AddonPtr &addon, bool update, bool modal)
 
void OnPreUnInstall (const AddonPtr &addon)
 
void OnPostUnInstall (const AddonPtr &addon)
 
std::string TranslateContent (const CONTENT_TYPE &type, bool pretty)
 
CONTENT_TYPE TranslateContent (const std::string &string)
 
AddonType ScraperTypeFromContent (const CONTENT_TYPE &content)
 
template<>
CScraperUrl FromFileItem< CScraperUrl > (const CFileItem &item)
 
template<>
CMusicAlbumInfo FromFileItem< CMusicAlbumInfo > (const CFileItem &item)
 
template<>
CMusicArtistInfo FromFileItem< CMusicArtistInfo > (const CFileItem &item)
 
template<>
bool DetailsFromFileItem< CAlbum > (const CFileItem &item, CAlbum &album)
 
template<>
bool DetailsFromFileItem< CArtist > (const CFileItem &item, CArtist &artist)
 
template<>
bool DetailsFromFileItem< CVideoInfoTag > (const CFileItem &item, CVideoInfoTag &tag)
 

Variables

constexpr const char * KODI_ADDON_DEFAULT_LANGUAGE_CODE = "en_GB"
 
const int AUTO_UPDATES_ON = 0
 
const int AUTO_UPDATES_NOTIFY = 1
 
const int AUTO_UPDATES_NEVER = 2
 
const std::vector< AddonTypeADDONS_TO_CACHE = {AddonType::GAMEDLL}
 
constexpr const char * ADDON_SETTING_INSTANCE_GROUP = "kodi_addon_instance"
 
constexpr const char * ADDON_SETTING_INSTANCE_NAME_VALUE = "kodi_addon_instance_name"
 
constexpr const char * ADDON_SETTING_INSTANCE_ENABLED_VALUE = "kodi_addon_instance_enabled"
 
constexpr AddonInstanceId ADDON_SINGLETON_INSTANCE_ID = 0
 Identifier denoting default add-on instance.
 
constexpr AddonInstanceId ADDON_FIRST_INSTANCE_ID = 1
 Identifier denoting initial first add-on instance.
 
constexpr AddonInstanceId ADDON_INSTANCE_ID_UNUSED = ADDON_SINGLETON_INSTANCE_ID
 Identifier denoting add-on instance id as unused.
 
constexpr AddonInstanceId ADDON_SETTINGS_ID = ADDON_SINGLETON_INSTANCE_ID
 Identifier denoting default add-on settings.xml.
 
constexpr char const * ORIGIN_SYSTEM = "b6a50484-93a0-4afb-a01c-8d17e059feda"
 

Typedef Documentation

◆ ADDON_GET_INTERFACE_FN

typedef void *(* ADDON::ADDON_GET_INTERFACE_FN) (const std::string &name, const std::string &version)

◆ ADDON_INFO_LIST

using ADDON::ADDON_INFO_LIST = std::map<std::string, AddonInfoPtr>

◆ ADDON_INSTANCE_HANDLER

Addon instance handler, used as identify for std::map to find related addon instance. This class itself not accessed here.

Todo
As long game addon system use CAddonDll itself and not IAddonInstanceHandler as parent, is the set of this as "void*" needed. After game system is changed should by this also changed to "const IAddonInstanceHandler*" or direct in map below.

◆ AddonDllPtr

typedef std::shared_ptr< CAddonDll > ADDON::AddonDllPtr = std::shared_ptr<CAddonDll>

◆ AddonInfoPtr

typedef std::shared_ptr< CAddonInfo > ADDON::AddonInfoPtr = std::shared_ptr<CAddonInfo>

◆ AddonInfos

typedef std::vector<AddonInfoPtr> ADDON::AddonInfos

◆ AddonInstanceId

typedef uint32_t ADDON::AddonInstanceId = uint32_t

◆ AddonPtr

typedef std::shared_ptr< IAddon > ADDON::AddonPtr = std::shared_ptr<IAddon>

◆ AddonWithUpdate

using ADDON::AddonWithUpdate = std::pair<std::shared_ptr<IAddon>, std::shared_ptr<IAddon>>

◆ ArtMap

typedef std::map< std::string, std::string > ADDON::ArtMap = std::map<std::string, std::string>

◆ BinaryAddonBasePtr

typedef std::shared_ptr< CBinaryAddonBase > ADDON::BinaryAddonBasePtr = std::shared_ptr<CBinaryAddonBase>

◆ ContentPathMap

typedef std::map<std::string, std::vector<std::string> > ADDON::ContentPathMap

◆ CSkinSettingBoolPtr

typedef std::shared_ptr<CSkinSettingBool> ADDON::CSkinSettingBoolPtr

◆ CSkinSettingPtr

typedef std::shared_ptr<CSkinSetting> ADDON::CSkinSettingPtr

◆ CSkinSettingStringPtr

◆ EXT_ELEMENTS

typedef std::vector<std::pair<std::string, CAddonExtensions> > ADDON::EXT_ELEMENTS

◆ EXT_VALUE

typedef std::vector<std::pair<std::string, SExtValue> > ADDON::EXT_VALUE

◆ EXT_VALUES

typedef std::vector<std::pair<std::string, CExtValues> > ADDON::EXT_VALUES

◆ InfoMap

typedef std::map< std::string, std::string > ADDON::InfoMap = std::map<std::string, std::string>

◆ RepositoryDirList

◆ RepositoryPtr

typedef std::shared_ptr< CRepository > ADDON::RepositoryPtr = std::shared_ptr<CRepository>

◆ ScraperPtr

typedef std::shared_ptr<CScraper> ADDON::ScraperPtr

◆ VECADDONS

typedef std::vector< AddonPtr > ADDON::VECADDONS = std::vector<AddonPtr>

◆ VFSEntryPtr

typedef std::shared_ptr<CVFSEntry> ADDON::VFSEntryPtr

◆ WebinterfaceType

Enumeration Type Documentation

◆ AddonCheckType

enum class ADDON::AddonCheckType : bool
strong
Enumerator
OUTDATED_ADDONS 
AVAILABLE_UPDATES 

◆ AddonDisabledReason

enum class ADDON::AddonDisabledReason
strong
Enumerator
NONE 

Special reason for returning all disabled addons.

Only used as an actual value when an addon is enabled.

USER 
INCOMPATIBLE 
PERMANENT_FAILURE 

◆ AddonInstanceSupport

enum class ADDON::AddonInstanceSupport
strong

Independent add-on instance support.

Used to be able to find out its instance path for the respective add-on types.

Enumerator
SUPPORT_NONE 

If add-on type does not support instances.

SUPPORT_MANDATORY 

If add-on type needs support for several instances individually.

SUPPORT_OPTIONAL 

If add-on type can support several instances individually.

SUPPORT_SETTINGS 

If add-on type supports multiple instances using independent settings.

◆ AddonLifecycleState

enum class ADDON::AddonLifecycleState
strong

Add-on state defined within addon.xml to report about the current addon lifecycle state.

E.g. the add-on is broken and can no longer be used.

XML examples:

<lifecyclestate type="broken" lang="en_GB">SOME TEXT</lifecyclestate>
Enumerator
NORMAL 

Used if an add-on has no special lifecycle state which is the default state.

DEPRECATED 

the add-on should be marked as deprecated but is still usable

BROKEN 

the add-on should marked as broken in the repository

◆ AddonOriginType

enum class ADDON::AddonOriginType
strong
Enumerator
SYSTEM 

The type of the origin of an addon.

Represents where an addon was installed from.

REPOSITORY 

The addon is a system addon.

MANUAL 

The addon origin is a repository.

◆ AddonRepoUpdateMode

enum class ADDON::AddonRepoUpdateMode
strong
Enumerator
OFFICIAL_ONLY 
ANY_REPOSITORY 

◆ AddonType

enum class ADDON::AddonType
strong
Enumerator
UNKNOWN 
VISUALIZATION 
SKIN 
PVRDLL 
INPUTSTREAM 
GAMEDLL 
PERIPHERALDLL 
SCRIPT 
SCRIPT_WEATHER 
SUBTITLE_MODULE 
SCRIPT_LYRICS 
SCRAPER_ALBUMS 
SCRAPER_ARTISTS 
SCRAPER_MOVIES 
SCRAPER_MUSICVIDEOS 
SCRAPER_TVSHOWS 
SCREENSAVER 
PLUGIN 
REPOSITORY 
WEB_INTERFACE 
SERVICE 
AUDIOENCODER 
CONTEXTMENU_ITEM 
AUDIODECODER 
RESOURCE_IMAGES 
RESOURCE_LANGUAGE 
RESOURCE_UISOUNDS 
RESOURCE_GAMES 
RESOURCE_FONT 
VFS 
IMAGEDECODER 
SCRAPER_LIBRARY 
SCRIPT_LIBRARY 
SCRIPT_MODULE 
GAME_CONTROLLER 
VIDEOCODEC 
VIDEO 

virtual addon types

AUDIO 
IMAGE 
EXECUTABLE 
GAME 
MAX_TYPES 

◆ AddonUpdateRule

enum class ADDON::AddonUpdateRule
strong

Reasons why an addon is not updateable.

Enumerator
ANY 

used internally, not to be explicitly set

USER_DISABLED_AUTO_UPDATE 

automatic updates disabled via AddonInfo dialog

PIN_OLD_VERSION 

user downgraded to an older version

PIN_ZIP_INSTALL 

user installed manually from zip

◆ AllowCheckForUpdates

enum class ADDON::AllowCheckForUpdates : bool
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ AutoUpdateJob

enum class ADDON::AutoUpdateJob : bool
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ BackgroundJob

enum class ADDON::BackgroundJob : bool
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ CheckAddonPath

enum class ADDON::CheckAddonPath
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ CheckIncompatible

enum class ADDON::CheckIncompatible : bool
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ DependencyJob

enum class ADDON::DependencyJob : bool
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ InstallModalPrompt

enum class ADDON::InstallModalPrompt : bool
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ ModalJob

enum class ADDON::ModalJob : bool
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ OnlyEnabled

enum class ADDON::OnlyEnabled : bool
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ OnlyEnabledRootAddon

enum class ADDON::OnlyEnabledRootAddon : bool
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ RecurseOrphaned

enum class ADDON::RecurseOrphaned : bool
strong
Enumerator
CHOICE_YES 
CHOICE_NO 

◆ WebinterfaceType

Enumerator
WebinterfaceTypeStatic 
WebinterfaceTypeWsgi 

Function Documentation

◆ DetailsFromFileItem< CAlbum >()

template<>
bool ADDON::DetailsFromFileItem< CAlbum > ( const CFileItem & item,
CAlbum & album )

◆ DetailsFromFileItem< CArtist >()

template<>
bool ADDON::DetailsFromFileItem< CArtist > ( const CFileItem & item,
CArtist & artist )

◆ DetailsFromFileItem< CVideoInfoTag >()

template<>
bool ADDON::DetailsFromFileItem< CVideoInfoTag > ( const CFileItem & item,
CVideoInfoTag & tag )

◆ FromFileItem< CMusicAlbumInfo >()

template<>
CMusicAlbumInfo ADDON::FromFileItem< CMusicAlbumInfo > ( const CFileItem & item)

◆ FromFileItem< CMusicArtistInfo >()

template<>
CMusicArtistInfo ADDON::FromFileItem< CMusicArtistInfo > ( const CFileItem & item)

◆ FromFileItem< CScraperUrl >()

template<>
CScraperUrl ADDON::FromFileItem< CScraperUrl > ( const CFileItem & item)

◆ GetSettingValue()

template<class TSetting >
bool ADDON::GetSettingValue ( CAddon & addon,
AddonInstanceId instanceId,
const std::string & key,
typename TSetting::Value & value )

◆ OnPostInstall()

void ADDON::OnPostInstall ( const AddonPtr & addon,
bool update,
bool modal )

◆ OnPostUnInstall()

void ADDON::OnPostUnInstall ( const AddonPtr & addon)

◆ OnPreInstall()

void ADDON::OnPreInstall ( const AddonPtr & addon)
Bug
If primary extension point have changed we're calling the wrong method.

◆ OnPreUnInstall()

void ADDON::OnPreUnInstall ( const AddonPtr & addon)

◆ ScraperTypeFromContent()

AddonType ADDON::ScraperTypeFromContent ( const CONTENT_TYPE & content)

◆ TranslateContent() [1/2]

std::string ADDON::TranslateContent ( const CONTENT_TYPE & type,
bool pretty )

◆ TranslateContent() [2/2]

CONTENT_TYPE ADDON::TranslateContent ( const std::string & string)

◆ UpdateSettingValue()

template<class TSetting >
bool ADDON::UpdateSettingValue ( CAddon & addon,
AddonInstanceId instanceId,
const std::string & key,
typename TSetting::Value value )

Variable Documentation

◆ ADDON_FIRST_INSTANCE_ID

constexpr AddonInstanceId ADDON::ADDON_FIRST_INSTANCE_ID = 1
constexpr

Identifier denoting initial first add-on instance.

◆ ADDON_INSTANCE_ID_UNUSED

constexpr AddonInstanceId ADDON::ADDON_INSTANCE_ID_UNUSED = ADDON_SINGLETON_INSTANCE_ID
constexpr

Identifier denoting add-on instance id as unused.

See also
ADDON::IAddonInstanceHandler

◆ ADDON_SETTING_INSTANCE_ENABLED_VALUE

constexpr const char* ADDON::ADDON_SETTING_INSTANCE_ENABLED_VALUE = "kodi_addon_instance_enabled"
constexpr

◆ ADDON_SETTING_INSTANCE_GROUP

constexpr const char* ADDON::ADDON_SETTING_INSTANCE_GROUP = "kodi_addon_instance"
constexpr

◆ ADDON_SETTING_INSTANCE_NAME_VALUE

constexpr const char* ADDON::ADDON_SETTING_INSTANCE_NAME_VALUE = "kodi_addon_instance_name"
constexpr

◆ ADDON_SETTINGS_ID

constexpr AddonInstanceId ADDON::ADDON_SETTINGS_ID = ADDON_SINGLETON_INSTANCE_ID
constexpr

Identifier denoting default add-on settings.xml.

All numbers greater than 0 denote add-on instances with an individual set of settings.

◆ ADDON_SINGLETON_INSTANCE_ID

constexpr AddonInstanceId ADDON::ADDON_SINGLETON_INSTANCE_ID = 0
constexpr

Identifier denoting default add-on instance.

All numbers greater than 0 denote add-ons with support for multiple instances.

◆ ADDONS_TO_CACHE

const std::vector<AddonType> ADDON::ADDONS_TO_CACHE = {AddonType::GAMEDLL}

◆ AUTO_UPDATES_NEVER

const int ADDON::AUTO_UPDATES_NEVER = 2

◆ AUTO_UPDATES_NOTIFY

const int ADDON::AUTO_UPDATES_NOTIFY = 1

◆ AUTO_UPDATES_ON

const int ADDON::AUTO_UPDATES_ON = 0

◆ KODI_ADDON_DEFAULT_LANGUAGE_CODE

constexpr const char* ADDON::KODI_ADDON_DEFAULT_LANGUAGE_CODE = "en_GB"
constexpr

Defines the default language code used as fallback in case the requested language is not available. Used, for instance, to handle content from addon.xml.

◆ ORIGIN_SYSTEM

constexpr char const* ADDON::ORIGIN_SYSTEM = "b6a50484-93a0-4afb-a01c-8d17e059feda"
constexpr