kodi::addon::IAddonInstance Class Reference

#include <AddonBase.h>

Inheritance diagram for kodi::addon::IAddonInstance:

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

Friends
class	CAddonBase

Constructor & Destructor Documentation

IAddonInstance()

kodi::addon::IAddonInstance::IAddonInstance ( const kodi::addon::IInstanceInfo & instance )

inlineexplicit

~IAddonInstance()

virtual kodi::addon::IAddonInstance::~IAddonInstance ( )

virtualdefault

Member Function Documentation

CheckInstanceSettingBoolean()

bool kodi::addon::IAddonInstance::CheckInstanceSettingBoolean ( const std::string & settingName, bool & settingValue )

inline

CheckInstanceSettingEnum()

template<typename enumType >

bool kodi::addon::IAddonInstance::CheckInstanceSettingEnum ( const std::string & settingName, enumType & settingValue )

inline

CheckInstanceSettingFloat()

bool kodi::addon::IAddonInstance::CheckInstanceSettingFloat ( const std::string & settingName, float & settingValue )

inline

CheckInstanceSettingInt()

bool kodi::addon::IAddonInstance::CheckInstanceSettingInt ( const std::string & settingName, int & settingValue )

inline

CheckInstanceSettingString()

bool kodi::addon::IAddonInstance::CheckInstanceSettingString ( const std::string & settingName, std::string & settingValue )

inline

CreateInstance()

virtual ADDON_STATUS kodi::addon::IAddonInstance::CreateInstance ( const kodi::addon::IInstanceInfo & instance, KODI_ADDON_INSTANCE_HDL & hdl )

inlinevirtual

GetInstanceAPIVersion()

std::string kodi::addon::IAddonInstance::GetInstanceAPIVersion ( ) const

inline

GetInstanceSettingBoolean()

bool kodi::addon::IAddonInstance::GetInstanceSettingBoolean ( const std::string & settingName, bool defaultValue = false )

inline

GetInstanceSettingEnum()

template<typename enumType >

enumType kodi::addon::IAddonInstance::GetInstanceSettingEnum ( const std::string & settingName, enumType defaultValue = static_cast<enumType>(0) )

inline

GetInstanceSettingFloat()

float kodi::addon::IAddonInstance::GetInstanceSettingFloat ( const std::string & settingName, float defaultValue = 0.0f )

inline

GetInstanceSettingInt()

int kodi::addon::IAddonInstance::GetInstanceSettingInt ( const std::string & settingName, int defaultValue = 0 )

inline

GetInstanceSettingString()

std::string kodi::addon::IAddonInstance::GetInstanceSettingString ( const std::string & settingName, const std::string & defaultValue = "" )

inline

GetInstanceUserPath()

std::string kodi::addon::IAddonInstance::GetInstanceUserPath ( const std::string & append = "" )

inline

IsInstanceAPIVersionAtLeast()

bool kodi::addon::IAddonInstance::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.

IsInstanceSettingUsingDefault()

bool kodi::addon::IAddonInstance::IsInstanceSettingUsingDefault ( const std::string & settingName )

inline

SetInstanceSetting()

virtual ADDON_STATUS kodi::addon::IAddonInstance::SetInstanceSetting ( const std::string & settingName, const kodi::addon::CSettingValue & settingValue )

inlinevirtual

SetInstanceSettingBoolean()

void kodi::addon::IAddonInstance::SetInstanceSettingBoolean ( const std::string & settingName, bool settingValue )

inline

SetInstanceSettingEnum()

template<typename enumType >

void kodi::addon::IAddonInstance::SetInstanceSettingEnum ( const std::string & settingName, enumType settingValue )

inline

SetInstanceSettingFloat()

void kodi::addon::IAddonInstance::SetInstanceSettingFloat ( const std::string & settingName, float settingValue )

inline

SetInstanceSettingInt()

void kodi::addon::IAddonInstance::SetInstanceSettingInt ( const std::string & settingName, int settingValue )

inline

SetInstanceSettingString()

void kodi::addon::IAddonInstance::SetInstanceSettingString ( const std::string & settingName, const std::string & settingValue )

inline

Friends And Related Symbol Documentation

CAddonBase

friend class CAddonBase

friend

---

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

• kodi-dev-kit/include/kodi/AddonBase.h