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')
..
◆ getLocalizedString()
| getLocalizedString |
( |
|
... | ) |
|
Function: xbmcaddon.Addon([id]).getLocalizedString(id)
Returns an addon's localized 'string'.
- Parameters
-
| id | integer - id# for string you want to localize. |
- Returns
- Localized 'string'
- v13 Python API changes:
- id is optional as it will be auto detected for this add-on instance.
Example:
..
..
getLocalizedString(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
◆ getSettings()
Function: xbmcaddon.Addon([id]).getSettings()
Returns a wrapper around the addon's settings.
- Returns
- Settings wrapper
- v20 Python API changes:
- New function added.
Example:
..
settings = self.Addon.getSettings()
..
◆ getSetting()
Function: xbmcaddon.Addon([id]).getSetting(id)
Returns the value of a setting as string.
- Parameters
-
| id | string - id of the setting that the module needs to access. |
- Returns
- Setting as a string
- v13 Python API changes:
- id is optional as it will be auto detected for this add-on instance.
Example:
..
..
getSetting(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
◆ 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.
- v20 Python API changes:
- Deprecated. Use Settings.getBool() instead.
Example:
..
enabled = self.Addon.getSettingBool('enabled')
..
◆ 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.
- v20 Python API changes:
- Deprecated. Use Settings.getInt() instead.
Example:
..
max = self.Addon.getSettingInt('max')
..
◆ 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.
- v20 Python API changes:
- Deprecated. Use Settings.getNumber() instead.
Example:
..
max = self.Addon.getSettingNumber('max')
..
◆ getSettingString()
Function: xbmcaddon.Addon([id]).getSettingString(id)
Returns the value of a setting as a string.
- Parameters
-
| id | string - id of the setting that the module needs to access. |
- Returns
- Setting as a string
- v18 Python API changes:
- New function added.
- v20 Python API changes:
- Deprecated. Use Settings.getString() instead.
Example:
..
apikey = self.Addon.getSettingString('apikey')
..
◆ 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 - 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')
..
setSetting(...)
<h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font co...
◆ 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.
- v20 Python API changes:
- Deprecated. Use Settings.setBool() instead.
Example:
..
self.Addon.setSettingBool(id='enabled', value=True)
..
◆ 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.
- v20 Python API changes:
- Deprecated. Use Settings.setInt() instead.
Example:
..
self.Addon.setSettingInt(id='max', value=5)
..
◆ 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.
- v20 Python API changes:
- Deprecated. Use Settings.setNumber() instead.
Example:
..
self.Addon.setSettingNumber(id='max', value=5.5)
..
◆ 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.
- v20 Python API changes:
- Deprecated. Use Settings.setString() instead.
Example:
..
self.Addon.setSettingString(id='username', value='teamkodi')
..
◆ openSettings()
Function: xbmcaddon.Addon([id]).openSettings()
Opens this scripts settings dialog.
Example:
..
self.Addon.openSettings()
..
◆ 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')
..
1.9.1