kodi::addon Namespace Reference

Classes
class	CAddonBase
	Add-on main instance class. More...
class	CInstanceAudioDecoder
class	CInstanceAudioEncoder
class	CInstanceImageDecoder
class	CInstanceInputStream
class	CInstancePeripheral
class	CInstanceScreensaver
class	CInstanceVFS
class	CInstanceVideoCodec
class	CInstanceVisualization
struct	DriverPrimitive
class	IAddonInstance
class	Joystick
class	JoystickFeature
class	Peripheral
class	PeripheralEvent
class	PeripheralVector

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

Functions
kodi::addon::CInstanceVFS IAddonInstance	GetKeyboardInput (const std::string &heading, std::string &input, bool hiddenInput=false)
	Require keyboard input. More...
void	SetErrorDialog (const std::string &heading, const std::string &line1, const std::string &line2="", const std::string &line3="")
	Display an error dialog. More...
void	RequireAuthentication (const std::string &url)
	Prompt the user for authentication of a URL. More...
	CVFSCallbacks (const VFSGetDirectoryCallbacks *cb)

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

CVFSCallbacks()

kodi::addon::CVFSCallbacks ( const VFSGetDirectoryCallbacks *  cb )

explicit

GetKeyboardInput()

kodi::addon::CInstanceVFS IAddonInstance kodi::addon::GetKeyboardInput	(	const std::string &	heading,
		std::string &	input,
		bool	hiddenInput = false
	)

Require keyboard input.

Becomes called if GetDirectory() returns false and GetDirectory() becomes after entry called again.

Parameters

[in]	heading	The heading of the keyboard dialog
[out]	input	The resulting string. Returns string after second call!
[in]	hiddenInput	To show input only as "*" on dialog

Returns

True if input was received, false otherwise

RequireAuthentication()

void kodi::addon::RequireAuthentication

(

const std::string &

url

)

Prompt the user for authentication of a URL.

Parameters

[in]

url

The URL

SetErrorDialog()

void kodi::addon::SetErrorDialog	(	const std::string &	heading,
		const std::string &	line1,
		const std::string &	line2 = "",
		const std::string &	line3 = ""
	)

Display an error dialog.

Parameters

[in]	heading	The heading of the error dialog
[in]	line1	The first line of the error dialog
[in]	line2	[opt] The second line of the error dialog
[in]	line3	[opt] The third line of the error dialog