Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
kodi::addon::CAddonBase Class Reference

Add-on main instance class. More...

#include <AddonBase.h>

Public Member Functions

 CAddonBase ()
 
virtual ~CAddonBase ()=default
 
virtual ADDON_STATUS Create ()
 
virtual ADDON_STATUS GetStatus ()
 
virtual ADDON_STATUS SetSetting (const std::string &settingName, const CSettingValue &settingValue)
 
virtual ADDON_STATUS CreateInstance (int instanceType, std::string instanceID, KODI_HANDLE instance, KODI_HANDLE &addonInstance)
 
virtual ADDON_STATUS CreateInstanceEx (int instanceType, std::string instanceID, KODI_HANDLE instance, KODI_HANDLE &addonInstance, const std::string &version)
 

Static Public Member Functions

static void ADDONBASE_Destroy ()
 
static ADDON_STATUS ADDONBASE_GetStatus ()
 
static ADDON_STATUS ADDONBASE_SetSetting (const char *settingName, const void *settingValue)
 
static ADDON_STATUS ADDONBASE_CreateInstance (int instanceType, const char *instanceID, KODI_HANDLE instance, KODI_HANDLE *addonInstance, KODI_HANDLE parent)
 
static ADDON_STATUS ADDONBASE_CreateInstanceEx (int instanceType, const char *instanceID, KODI_HANDLE instance, KODI_HANDLE *addonInstance, KODI_HANDLE parent, const char *version)
 
static void ADDONBASE_DestroyInstance (int instanceType, KODI_HANDLE instance)
 

Static Public Attributes

static AddonGlobalInterface * m_interface
 
static std::string m_strGlobalApiVersion
 

Detailed Description

Add-on main instance class.

Constructor & Destructor Documentation

◆ CAddonBase()

kodi::addon::CAddonBase::CAddonBase ( )
inline

◆ ~CAddonBase()

virtual kodi::addon::CAddonBase::~CAddonBase ( )
virtualdefault

Member Function Documentation

◆ ADDONBASE_CreateInstance()

static ADDON_STATUS kodi::addon::CAddonBase::ADDONBASE_CreateInstance ( int  instanceType,
const char *  instanceID,
KODI_HANDLE  instance,
KODI_HANDLE *  addonInstance,
KODI_HANDLE  parent 
)
inlinestatic

◆ ADDONBASE_CreateInstanceEx()

static ADDON_STATUS kodi::addon::CAddonBase::ADDONBASE_CreateInstanceEx ( int  instanceType,
const char *  instanceID,
KODI_HANDLE  instance,
KODI_HANDLE *  addonInstance,
KODI_HANDLE  parent,
const char *  version 
)
inlinestatic

◆ ADDONBASE_Destroy()

static void kodi::addon::CAddonBase::ADDONBASE_Destroy ( )
inlinestatic

◆ ADDONBASE_DestroyInstance()

static void kodi::addon::CAddonBase::ADDONBASE_DestroyInstance ( int  instanceType,
KODI_HANDLE  instance 
)
inlinestatic

◆ ADDONBASE_GetStatus()

static ADDON_STATUS kodi::addon::CAddonBase::ADDONBASE_GetStatus ( )
inlinestatic

◆ ADDONBASE_SetSetting()

static ADDON_STATUS kodi::addon::CAddonBase::ADDONBASE_SetSetting ( const char *  settingName,
const void *  settingValue 
)
inlinestatic

◆ Create()

virtual ADDON_STATUS kodi::addon::CAddonBase::Create ( )
inlinevirtual

◆ CreateInstance()

virtual ADDON_STATUS kodi::addon::CAddonBase::CreateInstance ( int  instanceType,
std::string  instanceID,
KODI_HANDLE  instance,
KODI_HANDLE &  addonInstance 
)
inlinevirtual

◆ CreateInstanceEx()

virtual ADDON_STATUS kodi::addon::CAddonBase::CreateInstanceEx ( int  instanceType,
std::string  instanceID,
KODI_HANDLE  instance,
KODI_HANDLE &  addonInstance,
const std::string &  version 
)
inlinevirtual

◆ GetStatus()

virtual ADDON_STATUS kodi::addon::CAddonBase::GetStatus ( )
inlinevirtual

◆ SetSetting()

virtual ADDON_STATUS kodi::addon::CAddonBase::SetSetting ( const std::string &  settingName,
const CSettingValue &  settingValue 
)
inlinevirtual

Member Data Documentation

◆ m_interface

AddonGlobalInterface* kodi::addon::CAddonBase::m_interface
static

◆ m_strGlobalApiVersion

std::string kodi::addon::CAddonBase::m_strGlobalApiVersion
static
The documentation for this class was generated from the following file: