Kodi Development 23.0
for Binary and Script based Add-Ons
 
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
IAddonInstance

Inherited by CInstanceAudioDecoder, CInstanceAudioEncoder, CInstanceGame, CInstanceImageDecoder, CInstanceInputStream, CInstancePVRClient, CInstancePeripheral, CInstanceScreensaver, CInstanceShaderPreset, CInstanceVFS, CInstanceVideoCodec, and CInstanceVisualization.

Public Member Functions

bool CheckInstanceSettingBoolean (const std::string &settingName, bool &settingValue)
 
template<typename enumType >
bool CheckInstanceSettingEnum (const std::string &settingName, enumType &settingValue)
 
bool CheckInstanceSettingFloat (const std::string &settingName, float &settingValue)
 
bool CheckInstanceSettingInt (const std::string &settingName, int &settingValue)
 
bool CheckInstanceSettingString (const std::string &settingName, std::string &settingValue)
 
virtual ADDON_STATUS CreateInstance (const kodi::addon::IInstanceInfo &instance, KODI_ADDON_INSTANCE_HDL &hdl)
 
std::string GetInstanceAPIVersion () const
 
bool GetInstanceSettingBoolean (const std::string &settingName, bool defaultValue=false)
 
template<typename enumType >
enumType GetInstanceSettingEnum (const std::string &settingName, enumType defaultValue=static_cast< enumType >(0))
 
float GetInstanceSettingFloat (const std::string &settingName, float defaultValue=0.0f)
 
int GetInstanceSettingInt (const std::string &settingName, int defaultValue=0)
 
std::string GetInstanceSettingString (const std::string &settingName, const std::string &defaultValue="")
 
std::string GetInstanceUserPath (const std::string &append="")
 
 IAddonInstance (const kodi::addon::IInstanceInfo &instance)
 
bool IsInstanceAPIVersionAtLeast (int major, int minor, int patch) const
 Whether Kodi's API for this instance is at least the given version.
 
bool IsInstanceSettingUsingDefault (const std::string &settingName)
 
virtual ADDON_STATUS SetInstanceSetting (const std::string &settingName, const kodi::addon::CSettingValue &settingValue)
 
void SetInstanceSettingBoolean (const std::string &settingName, bool settingValue)
 
template<typename enumType >
void SetInstanceSettingEnum (const std::string &settingName, enumType settingValue)
 
void SetInstanceSettingFloat (const std::string &settingName, float settingValue)
 
void SetInstanceSettingInt (const std::string &settingName, int settingValue)
 
void SetInstanceSettingString (const std::string &settingName, const std::string &settingValue)
 

Friends

class CAddonBase
 

Member Function Documentation

◆ IsInstanceAPIVersionAtLeast()

bool IsInstanceAPIVersionAtLeast ( int major,
int minor,
int patch ) const
inline

Whether Kodi's API for this instance is at least the given version.

Kodi allocates an instance's function tables, so an entry added in a later version may only be filled in when Kodi has that version too.

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