|
Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
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 |
| class | CPluginSource |
| class | CRepository |
| class | CRepositoryUpdateJob |
| class | CRepositoryUpdater |
| class | CResource |
| class | CScraper |
| class | CScraperError |
| class | CService |
| class | CServiceAddonManager |
| class | CSettingUrlEncodedString |
| class | CShaderPreset |
| class | CShaderPresetAddon |
| Wrapper class that wraps the shader presets add-on. More... | |
| 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 equipping a CVFSEntry with an IDirectory interface. More... | |
| class | CVFSEntryIFileDirectoryWrapper |
| Wrapper equipping 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> |
| using | EXT_ELEMENTS = std::vector<std::pair<std::string, CAddonExtensions>> |
| using | EXT_VALUE = std::vector<std::pair<std::string, SExtValue>> |
| using | EXT_VALUES = std::vector<std::pair<std::string, CExtValues>> |
| using | AddonInfos = std::vector<AddonInfoPtr> |
| using | AddonInstanceId = uint32_t |
| using | InfoMap = std::map<std::string, std::string, std::less<>> |
| using | RepositoryPtr = std::shared_ptr<CRepository> |
| using | AddonInfoMap = std::map<std::string, AddonInfoPtr, std::less<>> |
| using | AddonWithUpdate = std::pair<std::shared_ptr<IAddon>, std::shared_ptr<IAddon>> |
| using | ADDON_INSTANCE_HANDLER = void* |
| using | AddonGetInterface = std::function<void*(const std::string& name, const std::string& version)> |
| using | ContentPathMap = std::map<std::string, std::vector<std::string>, std::less<>> |
| using | RepositoryDirList = std::vector<RepositoryDirInfo> |
| using | ScraperPtr = std::shared_ptr<CScraper> |
| using | CSkinSettingPtr = std::shared_ptr<CSkinSetting> |
| using | CSkinSettingStringPtr = std::shared_ptr<CSkinSettingString> |
| using | CSkinSettingBoolPtr = std::shared_ptr<CSkinSettingBool> |
| using | VFSEntryPtr = std::shared_ptr<CVFSEntry> |
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, const 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 (ContentType type, bool pretty) |
| ContentType | TranslateContent (std::string_view string) |
| AddonType | ScraperTypeFromContent (ContentType content) |
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< AddonType > | ADDONS_TO_CACHE = {AddonType::GAMEDLL, AddonType::SHADERDLL} |
| 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" |
| using ADDON::ADDON_INSTANCE_HANDLER = void* |
Addon instance handler, used as identify for std::map to find related addon instance. This class itself not accessed here.
| using ADDON::AddonGetInterface = std::function<void*(const std::string& name, const std::string& version)> |
| using ADDON::AddonInfoMap = std::map<std::string, AddonInfoPtr, std::less<>> |
| typedef std::shared_ptr< CAddonInfo > ADDON::AddonInfoPtr = std::shared_ptr<CAddonInfo> |
| using ADDON::AddonInfos = std::vector<AddonInfoPtr> |
| typedef uint32_t ADDON::AddonInstanceId = uint32_t |
| typedef std::shared_ptr< IAddon > ADDON::AddonPtr = std::shared_ptr<IAddon> |
| using ADDON::AddonWithUpdate = std::pair<std::shared_ptr<IAddon>, std::shared_ptr<IAddon>> |
| using ADDON::ContentPathMap = std::map<std::string, std::vector<std::string>, std::less<>> |
| using ADDON::CSkinSettingBoolPtr = std::shared_ptr<CSkinSettingBool> |
| using ADDON::CSkinSettingPtr = std::shared_ptr<CSkinSetting> |
| using ADDON::CSkinSettingStringPtr = std::shared_ptr<CSkinSettingString> |
| using ADDON::EXT_ELEMENTS = std::vector<std::pair<std::string, CAddonExtensions>> |
| using ADDON::EXT_VALUE = std::vector<std::pair<std::string, SExtValue>> |
| using ADDON::EXT_VALUES = std::vector<std::pair<std::string, CExtValues>> |
| using ADDON::InfoMap = std::map<std::string, std::string, std::less<>> |
| using ADDON::RepositoryDirList = std::vector<RepositoryDirInfo> |
| typedef std::shared_ptr< CRepository > ADDON::RepositoryPtr = std::shared_ptr<CRepository> |
| using ADDON::ScraperPtr = std::shared_ptr<CScraper> |
| typedef std::vector< AddonPtr > ADDON::VECADDONS = std::vector<AddonPtr> |
| using ADDON::VFSEntryPtr = std::shared_ptr<CVFSEntry> |
|
strong |
|
strong |
|
strong |
Independent add-on instance support.
Used to be able to find out its instance path for the respective add-on types.
|
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:
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
| bool ADDON::GetSettingValue | ( | CAddon & | addon, |
| AddonInstanceId | instanceId, | ||
| const std::string & | key, | ||
| typename TSetting::Value & | value ) |
| AddonType ADDON::ScraperTypeFromContent | ( | ContentType | content | ) |
| std::string ADDON::TranslateContent | ( | ContentType | type, |
| bool | pretty ) |
| ContentType ADDON::TranslateContent | ( | std::string_view | string | ) |
| bool ADDON::UpdateSettingValue | ( | CAddon & | addon, |
| AddonInstanceId | instanceId, | ||
| const std::string & | key, | ||
| const typename TSetting::Value & | value ) |
|
constexpr |
Identifier denoting initial first add-on instance.
|
constexpr |
Identifier denoting add-on instance id as unused.
|
constexpr |
|
constexpr |
|
constexpr |
|
constexpr |
Identifier denoting default add-on settings.xml.
All numbers greater than 0 denote add-on instances with an individual set of settings.
|
constexpr |
Identifier denoting default add-on instance.
All numbers greater than 0 denote add-ons with support for multiple instances.
| const std::vector<AddonType> ADDON::ADDONS_TO_CACHE = {AddonType::GAMEDLL, AddonType::SHADERDLL} |
| const int ADDON::AUTO_UPDATES_NEVER = 2 |
| const int ADDON::AUTO_UPDATES_NOTIFY = 1 |
| const int ADDON::AUTO_UPDATES_ON = 0 |
|
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.
|
constexpr |