Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
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  CInstanceVFS
 
class  CInstanceVideoCodec
 
class  CInstanceVisualization
 
struct  CPrivateBase
 Internal used structure to have stored C API data above and available for everything below. More...
 
class  CStructHdl
 
struct  DriverPrimitive
 
class  GameControllerLayout
 
class  IAddonInstance
 
class  InputstreamCapabilities
 
class  InputstreamContentlightMetadata
 
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  PVRMenuhook
 
class  PVRProvider
 
class  PVRProvidersResultSet
 
class  PVRRecording
 
class  PVRRecordingsResultSet
 
class  PVRSignalStatus
 
class  PVRStreamProperties
 
class  PVRStreamProperty
 
class  PVRStreamTimes
 
class  PVRTimer
 
class  PVRTimersResultSet
 
class  PVRTimerType
 
class  PVRTypeIntValue
 
class  StreamCryptoSession
 
class  VFSUrl
 
class  VideoCodecInitdata
 
class  VisualizationTrack
 

Typedefs

typedef PeripheralVector< Peripheral, PERIPHERAL_INFOPeripherals
 
typedef PeripheralVector< PeripheralEvent, PERIPHERAL_EVENTPeripheralEvents
 
typedef PeripheralVector< Joystick, JOYSTICK_INFOJoysticks
 
typedef PeripheralVector< DriverPrimitive, JOYSTICK_DRIVER_PRIMITIVEDriverPrimitives
 
typedef PeripheralVector< JoystickFeature, JOYSTICK_FEATUREJoystickFeatures
 
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. More...
 

Functions

const char * GetTypeVersion (int type)
 
const char * GetTypeMinVersion (int type)
 
const char * GetTypeName (int type)
 
int GetTypeId (const char *name)
 

Typedef Documentation

◆ DriverPrimitives

◆ JoystickFeatures

◆ Joysticks

◆ PeripheralEvents

◆ Peripherals

Function Documentation

◆ 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]nameThe 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]typeThe 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]typeThe 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]typeThe with 'enum ADDON_TYPE' type to ask
Returns
version The current version of asked type