forked from romanvm/Kodistubs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathxbmcaddon.py
executable file
·263 lines (184 loc) · 7.04 KB
/
xbmcaddon.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# coding: utf-8
# This file is generated from Kodi source code and post-edited
# to correct code style and docstrings formatting.
# License: GPL v.3 <https://www.gnu.org/licenses/gpl-3.0.en.html>
"""
Kodi's addon class
"""
from typing import Union
__kodistubs__ = True
str_type = Union[str, unicode]
class Addon(object):
"""
Kodi's addon class
Offers classes and functions that manipulate the add-on settings, information
and localization.
Creates a new AddOn class.
:param id: [opt] string - id of the addon as specified in addon.xml
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.**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')
"""
def __init__(self, id=None):
# type: (str) -> None
pass
def getLocalizedString(self, id):
# type: (int) -> unicode
"""
Returns an addon's localized 'unicode string'.
:param id: integer - id# for string you want to localize.
:return: Localized 'unicode string'
**id** is optional as it will be auto detected for this add-on instance.
Example::
locstr = self.Addon.getLocalizedString(32000)
"""
return u""
def getSetting(self, id):
# type: (str) -> str
"""
Returns the value of a setting as a unicode string.
:param id: string - id of the setting that the module needs to access.
:return: Setting as a unicode string
**id** is optional as it will be auto detected for this add-on instance.
Example::
apikey = self.Addon.getSetting('apikey')
"""
return ""
def getSettingBool(self, id):
# type: (str) -> bool
"""
Returns the value of a setting as a boolean.
:param id: string - id of the setting that the module needs to access.
:return: Setting as a boolean
New function added.
Example::
enabled = self.Addon.getSettingBool('enabled')
"""
return True
def getSettingInt(self, id):
# type: (str) -> int
"""
Returns the value of a setting as an integer.
:param id: string - id of the setting that the module needs to access.
:return: Setting as an integer
New function added.
Example::
max = self.Addon.getSettingInt('max')
"""
return 0
def getSettingNumber(self, id):
# type: (str) -> float
"""
Returns the value of a setting as a floating point number.
:param id: string - id of the setting that the module needs to access.
:return: Setting as a floating point number
New function added.
Example::
max = self.Addon.getSettingNumber('max')
"""
return 0.0
def getSettingString(self, id):
# type: (str) -> str
"""
Returns the value of a setting as a unicode string.
:param id: string - id of the setting that the module needs to access.
:return: Setting as a unicode string
New function added.
Example::
apikey = self.Addon.getSettingString('apikey')
"""
return ""
def setSetting(self, id, value):
# type: (str, str_type) -> None
"""
Sets a script setting.
:param id: string - id of the setting that the module needs to access.
:param value: string or unicode - value of the setting.
You can use the above as keywords for arguments.**id** is optional
as it will be auto detected for this add-on instance.
Example::
self.Addon.setSetting(id='username', value='teamkodi')
"""
pass
def setSettingBool(self, id, value):
# type: (str, bool) -> bool
"""
Sets a script setting.
:param id: string - id of the setting that the module needs to access.
:param value: boolean - value of the setting.
:return: True if the value of the setting was set, false otherwise
You can use the above as keywords for arguments.
New function added.
Example::
self.Addon.setSettingBool(id='enabled', value=True)
"""
return True
def setSettingInt(self, id, value):
# type: (str, int) -> bool
"""
Sets a script setting.
:param id: string - id of the setting that the module needs to access.
:param value: integer - value of the setting.
:return: True if the value of the setting was set, false otherwise
You can use the above as keywords for arguments.
New function added.
Example::
self.Addon.setSettingInt(id='max', value=5)
"""
return True
def setSettingNumber(self, id, value):
# type: (str, float) -> bool
"""
Sets a script setting.
:param id: string - id of the setting that the module needs to access.
:param value: float - value of the setting.
:return: True if the value of the setting was set, false otherwise
You can use the above as keywords for arguments.
New function added.
Example::
self.Addon.setSettingNumber(id='max', value=5.5)
"""
return True
def setSettingString(self, id, value):
# type: (str, str_type) -> bool
"""
Sets a script setting.
:param id: string - id of the setting that the module needs to access.
:param value: string or unicode - value of the setting.
:return: True if the value of the setting was set, false otherwise
You can use the above as keywords for arguments.
New function added.
Example::
self.Addon.setSettingString(id='username', value='teamkodi')
"""
return True
def openSettings(self):
# type: () -> None
"""
Opens this scripts settings dialog.
Example::
self.Addon.openSettings()
"""
pass
def getAddonInfo(self, id):
# type: (str) -> str
"""
Returns the value of an addon property as a string.
:param 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
======= ========== ============ ===========
:return: AddOn property as a string
Example::
version = self.Addon.getAddonInfo('version')
"""
return ""