Library - xbmcaddon

Kodi's addon class. More...

Classes
class	XBMCAddon::xbmcaddon::Addon

Functions
	XBMCAddon::xbmcaddon::Addon::getLocalizedString (...)
	Function: xbmcaddon.Addon([id]).getLocalizedString(id) Returns an addon's localized 'unicode string'. More...
	XBMCAddon::xbmcaddon::Addon::getSetting (...)
	Function: xbmcaddon.Addon([id]).getSetting(id) Returns the value of a setting as a unicode string. More...
	XBMCAddon::xbmcaddon::Addon::getSettingBool (...)
	Function: xbmcaddon.Addon([id]).getSettingBool(id) Returns the value of a setting as a boolean. More...
	XBMCAddon::xbmcaddon::Addon::getSettingInt (...)
	Function: xbmcaddon.Addon([id]).getSettingInt(id) Returns the value of a setting as an integer. More...
	XBMCAddon::xbmcaddon::Addon::getSettingNumber (...)
	Function: xbmcaddon.Addon([id]).getSettingNumber(id) Returns the value of a setting as a floating point number. More...
	XBMCAddon::xbmcaddon::Addon::getSettingString (...)
	Function: xbmcaddon.Addon([id]).getSettingString(id) Returns the value of a setting as a unicode string. More...
	XBMCAddon::xbmcaddon::Addon::setSetting (...)
	Function: xbmcaddon.Addon([id]).setSetting(id, value) Sets a script setting. More...
	XBMCAddon::xbmcaddon::Addon::setSettingBool (...)
	Function: xbmcaddon.Addon([id]).setSettingBool(id, value) Sets a script setting. More...
	XBMCAddon::xbmcaddon::Addon::setSettingInt (...)
	Function: xbmcaddon.Addon([id]).setSettingInt(id, value) Sets a script setting. More...
	XBMCAddon::xbmcaddon::Addon::setSettingNumber (...)
	Function: xbmcaddon.Addon([id]).setSettingNumber(id, value) Sets a script setting. More...
	XBMCAddon::xbmcaddon::Addon::setSettingString (...)
	Function: xbmcaddon.Addon([id]).setSettingString(id, value) Sets a script setting. More...
	XBMCAddon::xbmcaddon::Addon::openSettings ()
	Function: xbmcaddon.Addon([id]).openSettings() Opens this scripts settings dialog. More...
	XBMCAddon::xbmcaddon::Addon::getAddonInfo (...)
	Function: xbmcaddon.Addon([id]).getAddonInfo(id) Returns the value of an addon property as a string. More...

Detailed Description

Kodi's addon class.

Offers classes and functions that manipulate the add-on settings, information and localization.

---

Class: xbmcaddon.Addon([id])

Creates a new AddOn class.

Parameters

id	[opt] string - id of the addon as specified in addon.xml

Note

Specifying the addon id is not needed.
Important however is that the addon folder has the same name as the AddOn id provided in addon.xml.
You can optionally specify the addon id from another installed addon to retrieve settings from it.

---

v13 Python API changes:

id is optional as it will be auto detected for this add-on instance.

Example:

..
self.Addon = xbmcaddon.Addon()
self.Addon = xbmcaddon.Addon('script.foo.bar')
..

Function Documentation

getAddonInfo()

String XBMCAddon::xbmcaddon::Addon::getAddonInfo

(

...

)

Function: xbmcaddon.Addon([id]).getAddonInfo(id)

---

Returns the value of an addon property as a string.

Parameters

id	string - id of the property that the module needs to access.

Choices for the property are

author	changelog	description	disclaimer
fanart	icon	id	name
path	profile	stars	summary
type	version

Returns

AddOn property as a string

---

Example:

..
version = self.Addon.getAddonInfo('version')
..

getLocalizedString()

String XBMCAddon::xbmcaddon::Addon::getLocalizedString

(

...

)

Function: xbmcaddon.Addon([id]).getLocalizedString(id)

---

Returns an addon's localized 'unicode string'.

Parameters

id	integer - id# for string you want to localize.

Returns

Localized 'unicode string'

---

v13 Python API changes:

id is optional as it will be auto detected for this add-on instance.

Example:

..
locstr = self.Addon.getLocalizedString(32000)
..

getSetting()

String XBMCAddon::xbmcaddon::Addon::getSetting

(

...

)

Function: xbmcaddon.Addon([id]).getSetting(id)

---

Returns the value of a setting as a unicode string.

Parameters

id	string - id of the setting that the module needs to access.

Returns

Setting as a unicode string

---

v13 Python API changes:

id is optional as it will be auto detected for this add-on instance.

Example:

..
apikey = self.Addon.getSetting('apikey')
..

getSettingBool()

bool XBMCAddon::xbmcaddon::Addon::getSettingBool

(

...

)

Function: xbmcaddon.Addon([id]).getSettingBool(id)

---

Returns the value of a setting as a boolean.

Parameters

id	string - id of the setting that the module needs to access.

Returns

Setting as a boolean

---

v18 Python API changes:

New function added.

Example:

..
enabled = self.Addon.getSettingBool('enabled')
..

getSettingInt()

int XBMCAddon::xbmcaddon::Addon::getSettingInt

(

...

)

Function: xbmcaddon.Addon([id]).getSettingInt(id)

---

Returns the value of a setting as an integer.

Parameters

id	string - id of the setting that the module needs to access.

Returns

Setting as an integer

---

v18 Python API changes:

New function added.

Example:

..
max = self.Addon.getSettingInt('max')
..

getSettingNumber()

double XBMCAddon::xbmcaddon::Addon::getSettingNumber

(

...

)

Function: xbmcaddon.Addon([id]).getSettingNumber(id)

---

Returns the value of a setting as a floating point number.

Parameters

id	string - id of the setting that the module needs to access.

Returns

Setting as a floating point number

---

v18 Python API changes:

New function added.

Example:

..
max = self.Addon.getSettingNumber('max')
..

getSettingString()

String XBMCAddon::xbmcaddon::Addon::getSettingString

(

...

)

Function: xbmcaddon.Addon([id]).getSettingString(id)

---

Returns the value of a setting as a unicode string.

Parameters

id	string - id of the setting that the module needs to access.

Returns

Setting as a unicode string

---

v18 Python API changes:

New function added.

Example:

..
apikey = self.Addon.getSettingString('apikey')
..

openSettings()

void XBMCAddon::xbmcaddon::Addon::openSettings

(

)

Function: xbmcaddon.Addon([id]).openSettings()

---

Opens this scripts settings dialog.

---

Example:

..
self.Addon.openSettings()
..

setSetting()

void XBMCAddon::xbmcaddon::Addon::setSetting

(

...

)

Function: xbmcaddon.Addon([id]).setSetting(id, value)

---

Sets a script setting.

Parameters

id	string - id of the setting that the module needs to access.
value	string or unicode - value of the setting.

Note

You can use the above as keywords for arguments.

---

v13 Python API changes:

id is optional as it will be auto detected for this add-on instance.

Example:

..
self.Addon.setSetting(id='username', value='teamkodi')
..

setSettingBool()

bool XBMCAddon::xbmcaddon::Addon::setSettingBool

(

...

)

Function: xbmcaddon.Addon([id]).setSettingBool(id, value)

---

Sets a script setting.

Parameters

id	string - id of the setting that the module needs to access.
value	boolean - value of the setting.

Returns

True if the value of the setting was set, false otherwise

Note

You can use the above as keywords for arguments.

---

v18 Python API changes:

New function added.

Example:

..
self.Addon.setSettingBool(id='enabled', value=True)
..

setSettingInt()

bool XBMCAddon::xbmcaddon::Addon::setSettingInt

(

...

)

Function: xbmcaddon.Addon([id]).setSettingInt(id, value)

---

Sets a script setting.

Parameters

id	string - id of the setting that the module needs to access.
value	integer - value of the setting.

Returns

True if the value of the setting was set, false otherwise

Note

You can use the above as keywords for arguments.

---

v18 Python API changes:

New function added.

Example:

..
self.Addon.setSettingInt(id='max', value=5)
..

setSettingNumber()

bool XBMCAddon::xbmcaddon::Addon::setSettingNumber

(

...

)

Function: xbmcaddon.Addon([id]).setSettingNumber(id, value)

---

Sets a script setting.

Parameters

id	string - id of the setting that the module needs to access.
value	float - value of the setting.

Returns

True if the value of the setting was set, false otherwise

Note

You can use the above as keywords for arguments.

---

v18 Python API changes:

New function added.

Example:

..
self.Addon.setSettingNumber(id='max', value=5.5)
..

setSettingString()

bool XBMCAddon::xbmcaddon::Addon::setSettingString

(

...

)

Function: xbmcaddon.Addon([id]).setSettingString(id, value)

---

Sets a script setting.

Parameters

id	string - id of the setting that the module needs to access.
value	string or unicode - value of the setting.

Returns

True if the value of the setting was set, false otherwise

Note

You can use the above as keywords for arguments.

---

v18 Python API changes:

New function added.

Example:

..
self.Addon.setSettingString(id='username', value='teamkodi')
..