kodi::addon Namespace Reference

Classes
class	AudioDecoderInfoTag
class	AudioEncoderInfoTag
class	CAddonBase
class	CInstanceAudioDecoder
class	CInstanceAudioEncoder
class	CInstanceGame
class	CInstanceImageDecoder
class	CInstanceInputStream
class	CInstancePeripheral
class	CInstancePVRClient
class	CInstanceScreensaver
class	CInstanceShaderPreset
class	CInstanceVFS
class	CInstanceVideoCodec
class	CInstanceVisualization
struct	CPrivateBase
	Internal used structure to have stored C API data above and available for everything below. More...
class	CSettingValue
class	CStructHdl
struct	DriverPrimitive
class	DynamicCStructHdl
class	GameControllerLayout
class	IAddonInstance
class	IInstanceInfo
class	ImageDecoderInfoTag
class	InputstreamCapabilities
class	InputstreamContentlightMetadata
class	InputstreamDvccMetadata
class	InputstreamInfo
class	InputstreamMasteringMetadata
class	InputstreamProperty
class	InputstreamTimes
class	Joystick
class	JoystickFeature
class	Peripheral
class	PeripheralCapabilities
class	PeripheralEvent
class	PeripheralVector
class	PVRCapabilities
class	PVRChannel
class	PVRChannelGroup
class	PVRChannelGroupMember
class	PVRChannelGroupMembersResultSet
class	PVRChannelGroupsResultSet
class	PVRChannelsResultSet
class	PVRCodec
class	PVRDescrambleInfo
class	PVREDLEntry
class	PVREPGTag
class	PVREPGTagsResultSet
class	PVRIntSettingDefinition
class	PVRMenuhook
class	PVRProvider
class	PVRProvidersResultSet
class	PVRRecording
class	PVRRecordingsResultSet
class	PVRSettingDefinition
class	PVRSettingKeyValuePair
class	PVRSignalStatus
class	PVRStreamProperties
class	PVRStreamProperty
class	PVRStreamTimes
class	PVRStringSettingDefinition
class	PVRTimer
class	PVRTimersResultSet
class	PVRTimerType
class	PVRTypeIntValue
class	PVRTypeStringValue
class	StreamCryptoSession
class	VFSUrl
class	VideoCodecInitdata
class	VisualizationTrack

Typedefs
typedef PeripheralVector< Peripheral, PERIPHERAL_INFO >	Peripherals
typedef PeripheralVector< PeripheralEvent, PERIPHERAL_EVENT >	PeripheralEvents
typedef PeripheralVector< Joystick, JOYSTICK_INFO >	Joysticks
typedef PeripheralVector< DriverPrimitive, JOYSTICK_DRIVER_PRIMITIVE >	DriverPrimitives
typedef PeripheralVector< JoystickFeature, JOYSTICK_FEATURE >	JoystickFeatures
using	VFSFileHandle = VFS_FILE_HANDLE
	VFS add-on file handle This used to handle opened files of addon with related memory pointer about class or structure and to have on further file control functions available.

Functions
char *	AllocAndCopyString (const char *source)
	Internally used helper to dynamically allocate and fill a char array.
void	FreeString (const char *str)
	Internally used helper to delete a string that was allocated via AllocAndCopyString.
void	ReallocAndCopyString (const char **stringToRealloc, const char *stringToCopy)
	Internally used helper to dynamically reallocate and fill a char array.
std::string ATTR_DLL_LOCAL	GetAddonPath (const std::string &append="")
	To get the addon system installation folder.
std::string ATTR_DLL_LOCAL	GetLibPath (const std::string &append="")
	This function gives OS associated executable binary path of the addon.
std::string ATTR_DLL_LOCAL	GetUserPath (const std::string &append="")
	To get the user-related folder of the addon.
std::string ATTR_DLL_LOCAL	GetTempPath (const std::string &append="")
	To get a temporary path for the addon.
std::string ATTR_DLL_LOCAL	GetLocalizedString (uint32_t labelId, const std::string &defaultStr="")
	Returns an addon's localized 'unicode string'.
bool ATTR_DLL_LOCAL	OpenSettings ()
	Opens this Add-Ons settings dialog.
bool ATTR_DLL_LOCAL	IsSettingUsingDefault (const std::string &settingName)
	Check the given setting name is set to default value.
bool ATTR_DLL_LOCAL	CheckSettingString (const std::string &settingName, std::string &settingValue)
	Check and get a string setting value.
std::string ATTR_DLL_LOCAL	GetSettingString (const std::string &settingName, const std::string &defaultValue="")
	Get string setting value.
void ATTR_DLL_LOCAL	SetSettingString (const std::string &settingName, const std::string &settingValue)
	Set string setting of addon.
bool ATTR_DLL_LOCAL	CheckSettingInt (const std::string &settingName, int &settingValue)
	Check and get a integer setting value.
int ATTR_DLL_LOCAL	GetSettingInt (const std::string &settingName, int defaultValue=0)
	Get integer setting value.
void ATTR_DLL_LOCAL	SetSettingInt (const std::string &settingName, int settingValue)
	Set integer setting of addon.
bool ATTR_DLL_LOCAL	CheckSettingBoolean (const std::string &settingName, bool &settingValue)
	Check and get a boolean setting value.
bool ATTR_DLL_LOCAL	GetSettingBoolean (const std::string &settingName, bool defaultValue=false)
	Get boolean setting value.
void ATTR_DLL_LOCAL	SetSettingBoolean (const std::string &settingName, bool settingValue)
	Set boolean setting of addon.
bool ATTR_DLL_LOCAL	CheckSettingFloat (const std::string &settingName, float &settingValue)
	Check and get a floating point setting value.
float ATTR_DLL_LOCAL	GetSettingFloat (const std::string &settingName, float defaultValue=0.0f)
	Get floating point setting value.
void ATTR_DLL_LOCAL	SetSettingFloat (const std::string &settingName, float settingValue)
	Set floating point setting of addon.
template<typename enumType >
bool ATTR_DLL_LOCAL	CheckSettingEnum (const std::string &settingName, enumType &settingValue)
	Check and get a enum setting value.
template<typename enumType >
enumType ATTR_DLL_LOCAL	GetSettingEnum (const std::string &settingName, enumType defaultValue=static_cast< enumType >(0))
	Get enum setting value.
template<typename enumType >
void ATTR_DLL_LOCAL	SetSettingEnum (const std::string &settingName, enumType settingValue)
	Set enum setting of addon.
std::string ATTR_DLL_LOCAL	GetAddonInfo (const std::string &id)
	Returns the value of an addon property as a string.
void *	GetInterface (const std::string &name, const std::string &version)
	Returns a function table to a named interface.
std::string ATTR_DLL_LOCAL	GetKodiTypeVersion (int type)
	To get used version inside Kodi itself about asked type.
std::string ATTR_DLL_LOCAL	TranslateAddonStatus (ADDON_STATUS status)
	Get to related ADDON_STATUS a human readable text.
const char *	GetTypeVersion (int type)
const char *	GetTypeMinVersion (int type)
const char *	GetTypeName (int type)
int	GetTypeId (const char *name)

Typedef Documentation

DriverPrimitives

typedef PeripheralVector<DriverPrimitive, JOYSTICK_DRIVER_PRIMITIVE> kodi::addon::DriverPrimitives

JoystickFeatures

typedef PeripheralVector<JoystickFeature, JOYSTICK_FEATURE> kodi::addon::JoystickFeatures

Joysticks

typedef PeripheralVector<Joystick, JOYSTICK_INFO> kodi::addon::Joysticks

PeripheralEvents

typedef PeripheralVector<PeripheralEvent, PERIPHERAL_EVENT> kodi::addon::PeripheralEvents

Peripherals

typedef PeripheralVector<Peripheral, PERIPHERAL_INFO> kodi::addon::Peripherals

Function Documentation

AllocAndCopyString()

char * kodi::addon::AllocAndCopyString ( const char *  source )

inline

Internally used helper to dynamically allocate and fill a char array.

FreeString()

void kodi::addon::FreeString ( const char *  str )

inline

Internally used helper to delete a string that was allocated via AllocAndCopyString.

GetTypeId()

int kodi::addon::GetTypeId ( const char *  name )

inline

Function used internally on add-on and in Kodi itself to get id number about given type name.

Parameters

[in]

name

The type name string to ask

Returns

Id number of the asked instance type

Warning

String must be lower case here!

GetTypeMinVersion()

const char * kodi::addon::GetTypeMinVersion ( int  type )

inline

This is used from Kodi to get the minimum supported version of add-on parts. It is compiled in add-on and also in Kodi itself, with this can be Kodi compare the version from him with them on add-on.

Parameters

[in]

type

The with 'enum ADDON_TYPE' type to ask

Returns

version The minimum version of asked type

GetTypeName()

const char * kodi::addon::GetTypeName ( int  type )

inline

Function used internally on add-on and in Kodi itself to get name about given type.

Parameters

[in]

type

The with 'enum ADDON_TYPE' defined type to ask

Returns

Name of the asked instance type

GetTypeVersion()

const char * kodi::addon::GetTypeVersion ( int  type )

inline

This is used from Kodi to get the active version of add-on parts. It is compiled in add-on and also in Kodi itself, with this can be Kodi compare the version from him with them on add-on.

Parameters

[in]

type

The with 'enum ADDON_TYPE' type to ask

Returns

version The current version of asked type

ReallocAndCopyString()

void kodi::addon::ReallocAndCopyString ( const char **  stringToRealloc, const char *  stringToCopy  )

inline

Internally used helper to dynamically reallocate and fill a char array.