Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages

Instance informations
Class to get any instance information when creating a new one. More...

Topics

 Value Help
 

Classes

class  kodi::addon::IInstanceInfo
 

Functions

KODI_ADDON_INSTANCE_TYPE kodi::addon::IInstanceInfo::GetType () const
 To get settings value as string.
 
bool kodi::addon::IInstanceInfo::IsType (KODI_ADDON_INSTANCE_TYPE type) const
 Check asked type used on this class.
 
uint32_t kodi::addon::IInstanceInfo::GetNumber () const
 Get optional identification number (usage relate to addon type).
 
std::string kodi::addon::IInstanceInfo::GetID () const
 Get optional identification string (usage relate to addon type).
 
std::string kodi::addon::IInstanceInfo::GetAPIVersion () const
 Get API version from Kodi about instance.
 
bool kodi::addon::IInstanceInfo::FirstInstance () const
 Check this is first created instance by Kodi.
 

Detailed Description

Instance informations
Class to get any instance information when creating a new one.

Function Documentation

◆ FirstInstance()

bool kodi::addon::IInstanceInfo::FirstInstance ( ) const
inline

Check this is first created instance by Kodi.

◆ GetAPIVersion()

std::string kodi::addon::IInstanceInfo::GetAPIVersion ( ) const
inline

Get API version from Kodi about instance.

◆ GetID()

std::string kodi::addon::IInstanceInfo::GetID ( ) const
inline

Get optional identification string (usage relate to addon type).

◆ GetNumber()

uint32_t kodi::addon::IInstanceInfo::GetNumber ( ) const
inline

Get optional identification number (usage relate to addon type).

◆ GetType()

KODI_ADDON_INSTANCE_TYPE kodi::addon::IInstanceInfo::GetType ( ) const
inline

To get settings value as string.

◆ IsType()

bool kodi::addon::IInstanceInfo::IsType ( KODI_ADDON_INSTANCE_TYPE type) const
inline

Check asked type used on this class.

Parameters
[in]typeType identifier to check
Returns
True if type matches