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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "AddonCallback.h"
#include "AddonString.h"
namespace XBMCAddon
{
namespace xbmc
{
///
/// \ingroup python_xbmc
/// \defgroup python_monitor Monitor
/// @{
/// @brief **Kodi's monitor class.**
///
/// \python_class{ xbmc.Monitor() }
///
/// Creates a new monitor to notify addon about changes.
///
class Monitor : public AddonCallback
{
String Id;
long invokerId;
CEvent abortEvent;
public:
Monitor();
#ifndef SWIG
inline void OnSettingsChanged() { XBMC_TRACE; invokeCallback(new CallbackFunction<Monitor>(this,&Monitor::onSettingsChanged)); }
inline void OnScreensaverActivated() { XBMC_TRACE; invokeCallback(new CallbackFunction<Monitor>(this,&Monitor::onScreensaverActivated)); }
inline void OnScreensaverDeactivated() { XBMC_TRACE; invokeCallback(new CallbackFunction<Monitor>(this,&Monitor::onScreensaverDeactivated)); }
inline void OnDPMSActivated() { XBMC_TRACE; invokeCallback(new CallbackFunction<Monitor>(this,&Monitor::onDPMSActivated)); }
inline void OnDPMSDeactivated() { XBMC_TRACE; invokeCallback(new CallbackFunction<Monitor>(this,&Monitor::onDPMSDeactivated)); }
inline void OnScanStarted(const String &library)
{
XBMC_TRACE;
invokeCallback(
new CallbackFunction<Monitor, const String>(this, &Monitor::onScanStarted, library));
}
inline void OnScanFinished(const String &library)
{
XBMC_TRACE;
invokeCallback(
new CallbackFunction<Monitor, const String>(this, &Monitor::onScanFinished, library));
}
inline void OnCleanStarted(const String& library)
{
XBMC_TRACE;
invokeCallback(
new CallbackFunction<Monitor, const String>(this, &Monitor::onCleanStarted, library));
}
inline void OnCleanFinished(const String& library)
{
XBMC_TRACE;
invokeCallback(
new CallbackFunction<Monitor, const String>(this, &Monitor::onCleanFinished, library));
}
inline void OnNotification(const String& sender, const String& method, const String& data)
{
XBMC_TRACE;
invokeCallback(new CallbackFunction<Monitor, const String, const String, const String>(
this, &Monitor::onNotification, sender, method, data));
}
inline const String& GetId() { return Id; }
inline long GetInvokerId() { return invokerId; }
/**
* Called from XBPython to notify registered monitors that a script is aborting/ending.
*/
void AbortNotify();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_monitor
/// @brief \python_func{ onSettingsChanged() }
/// onSettingsChanged method.
///
/// Will be called when addon settings are changed
///
onSettingsChanged();
#else
virtual void onSettingsChanged() { XBMC_TRACE; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_monitor
/// @brief \python_func{ onScreensaverActivated() }
/// onScreensaverActivated method.
///
/// Will be called when screensaver kicks in
///
onScreensaverActivated();
#else
virtual void onScreensaverActivated() { XBMC_TRACE; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_monitor
/// @brief \python_func{ onScreensaverDeactivated() }
/// onScreensaverDeactivated method.
///
/// Will be called when screensaver goes off
///
onScreensaverDeactivated();
#else
virtual void onScreensaverDeactivated() { XBMC_TRACE; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_monitor
/// @brief \python_func{ onDPMSActivated() }
/// onDPMSActivated method.
///
/// Will be called when energysaving/DPMS gets active
///
onDPMSActivated();
#else
virtual void onDPMSActivated() { XBMC_TRACE; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_monitor
/// @brief \python_func{ onDPMSDeactivated() }
/// onDPMSDeactivated method.
///
/// Will be called when energysaving/DPMS is turned off
///
onDPMSDeactivated();
#else
virtual void onDPMSDeactivated() { XBMC_TRACE; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_monitor
/// @brief \python_func{ onScanStarted(library) }
/// onScanStarted method.
///
/// @param library Video / music as string
///
///
/// @note Will be called when library clean has ended and return video or
/// music to indicate which library is being scanned
///
///
///-----------------------------------------------------------------------
/// @python_v14 New function added.
///
onScanStarted(...);
#else
virtual void onScanStarted(const String library) { XBMC_TRACE; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_monitor
/// @brief \python_func{ onScanFinished(library) }
/// onScanFinished method.
///
/// @param library Video / music as string
///
///
/// @note Will be called when library clean has ended and return video or
/// music to indicate which library has been scanned
///
///
///-----------------------------------------------------------------------
/// @python_v14 New function added.
///
onScanFinished(...);
#else
virtual void onScanFinished(const String library) { XBMC_TRACE; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_monitor
/// @brief \python_func{ onCleanStarted(library) }
/// onCleanStarted method.
///
/// @param library Video / music as string
///
///
/// @note Will be called when library clean has ended and return video or
/// music to indicate which library has been cleaned
///
///
///-----------------------------------------------------------------------
/// @python_v14 New function added.
///
onCleanStarted(...);
#else
virtual void onCleanStarted(const String library) { XBMC_TRACE; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_monitor
/// @brief \python_func{ onCleanFinished(library) }
/// onCleanFinished method.
///
/// @param library Video / music as string
///
///
/// @note Will be called when library clean has ended and return video or
/// music to indicate which library has been finished
///
///
///-----------------------------------------------------------------------
/// @python_v14 New function added.
///
onCleanFinished(...);
#else
virtual void onCleanFinished(const String library) { XBMC_TRACE; }
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_monitor
/// @brief \python_func{ onNotification(sender, method, data) }
/// onNotification method.
///
/// @param sender Sender of the notification
/// @param method Name of the notification
/// @param data JSON-encoded data of the notification
///
/// @note Will be called when Kodi receives or sends a notification
///
///
///-----------------------------------------------------------------------
/// @python_v13 New function added.
///
onNotification(...);
#else
virtual void onNotification(const String sender, const String method, const String data)
{
XBMC_TRACE;
}
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
/// \ingroup python_monitor
/// @brief \python_func{ waitForAbort([timeout]) }
/// Wait for Abort
/// \anchor xbmc_Monitor_waitForAbort
///
/// Block until abort is requested, or until timeout occurs. If an
/// abort requested have already been made, return immediately.
///
/// @param timeout [opt] float - timeout in seconds.
/// Default: no timeout.
///
/// @return True when abort have been requested,
/// False if a timeout is given and the
/// operation times out.
///
///
///-----------------------------------------------------------------------
/// @python_v14 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// monitor = xbmc.Monitor()
/// # do something
/// monitor.waitForAbort(10) # sleeps for 10 secs or returns early if kodi aborts
/// if monitor.abortRequested():
/// # abort was requested to Kodi (e.g. shutdown), do your cleanup logic
/// ..
/// ~~~~~~~~~~~~~
///
waitForAbort(...);
#else
bool waitForAbort(double timeout = -1);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
/// \ingroup python_monitor
/// @brief \python_func{ abortRequested() }
/// Returns True if abort has been requested.
///
/// @return True if requested
///
///
///-----------------------------------------------------------------------
/// @python_v14 New function added.
///
abortRequested();
#else
bool abortRequested();
#endif
~Monitor() override;
};
/** @} */
}
};
|
