Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
Classes | Functions
Monitor
Python » Library - xbmc

Kodi's monitor class. More...

Classes

class  XBMCAddon::xbmc::Monitor
 

Functions

 XBMCAddon::xbmc::Monitor::onSettingsChanged ()
 
 XBMCAddon::xbmc::Monitor::onScreensaverActivated ()
 
 XBMCAddon::xbmc::Monitor::onScreensaverDeactivated ()
 
 XBMCAddon::xbmc::Monitor::onDPMSActivated ()
 
 XBMCAddon::xbmc::Monitor::onDPMSDeactivated ()
 
 XBMCAddon::xbmc::Monitor::onScanStarted (...)
 
 XBMCAddon::xbmc::Monitor::onScanFinished (...)
 
 XBMCAddon::xbmc::Monitor::onDatabaseScanStarted (...)
 
 XBMCAddon::xbmc::Monitor::onDatabaseUpdated (...)
 
 XBMCAddon::xbmc::Monitor::onCleanStarted (...)
 onCleanStarted method. More...
 
 XBMCAddon::xbmc::Monitor::onCleanFinished (...)
 
 XBMCAddon::xbmc::Monitor::onAbortRequested ()
 
 XBMCAddon::xbmc::Monitor::onNotification (...)
 
 XBMCAddon::xbmc::Monitor::waitForAbort (...)
 
 XBMCAddon::xbmc::Monitor::abortRequested ()
 

Detailed Description

Kodi's monitor class.

Class: xbmc.Monitor()

Creates a new monitor to notify addon about changes.

Function Documentation

◆ abortRequested()

bool XBMCAddon::xbmc::Monitor::abortRequested ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> abortRequested() </big></font></span></code></h4> \endhtmlonly

Returns True if abort has been requested.

Returns
True if requested
v14 Python API changes:
New function added.

◆ onAbortRequested()

XBMCAddon::xbmc::Monitor::onAbortRequested ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onAbortRequested() </big></font></span></code></h4> \endhtmlonly

v14 Python API changes:
Deprecated. Use waitForAbort() to be notified about this event.

◆ onCleanFinished()

XBMCAddon::xbmc::Monitor::onCleanFinished (   ...)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onCleanFinished(library) </big></font></span></code></h4> \endhtmlonly

onCleanFinished method.

Parameters
libraryVideo / music as string
Note
Will be called when library clean has ended and return video or music to indicate which library has been finished
v14 Python API changes:
New function added.

◆ onCleanStarted()

XBMCAddon::xbmc::Monitor::onCleanStarted (   ...)

onCleanStarted method.

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onCleanStarted(library) </big></font></span></code></h4> \endhtmlonly

Parameters
libraryVideo / music as string
Note
Will be called when library clean has ended and return video or music to indicate which library has been cleaned
v14 Python API changes:
New function added.

◆ onDatabaseScanStarted()

XBMCAddon::xbmc::Monitor::onDatabaseScanStarted (   ...)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onDatabaseScanStarted(database) </big></font></span></code></h4> \endhtmlonly

v13 Python API changes:
New function added.
v14 Python API changes:
Deprecated. Use onScanStarted().

◆ onDatabaseUpdated()

XBMCAddon::xbmc::Monitor::onDatabaseUpdated (   ...)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onDatabaseUpdated(database) </big></font></span></code></h4> \endhtmlonly

v14 Python API changes:
Deprecated. Use onScanFinished().

◆ onDPMSActivated()

XBMCAddon::xbmc::Monitor::onDPMSActivated ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onDPMSActivated() </big></font></span></code></h4> \endhtmlonly

onDPMSActivated method.

Will be called when energysaving/DPMS gets active

◆ onDPMSDeactivated()

XBMCAddon::xbmc::Monitor::onDPMSDeactivated ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onDPMSDeactivated() </big></font></span></code></h4> \endhtmlonly

onDPMSDeactivated method.

Will be called when energysaving/DPMS is turned off

◆ onNotification()

XBMCAddon::xbmc::Monitor::onNotification (   ...)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onNotification(sender, method, data) </big></font></span></code></h4> \endhtmlonly

onNotification method.

Parameters
senderSender of the notification
methodName of the notification
dataJSON-encoded data of the notification
Note
Will be called when Kodi receives or sends a notification
v13 Python API changes:
New function added.

◆ onScanFinished()

XBMCAddon::xbmc::Monitor::onScanFinished (   ...)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onScanFinished(library) </big></font></span></code></h4> \endhtmlonly

onScanFinished method.

Parameters
libraryVideo / music as string
Note
Will be called when library clean has ended and return video or music to indicate which library has been scanned
v14 Python API changes:
New function added.

◆ onScanStarted()

XBMCAddon::xbmc::Monitor::onScanStarted (   ...)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onScanStarted(library) </big></font></span></code></h4> \endhtmlonly

onScanStarted method.

Parameters
libraryVideo / music as string
Note
Will be called when library clean has ended and return video or music to indicate which library is being scanned
v14 Python API changes:
New function added.

◆ onScreensaverActivated()

XBMCAddon::xbmc::Monitor::onScreensaverActivated ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onScreensaverActivated() </big></font></span></code></h4> \endhtmlonly

onScreensaverActivated method.

Will be called when screensaver kicks in

◆ onScreensaverDeactivated()

XBMCAddon::xbmc::Monitor::onScreensaverDeactivated ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onScreensaverDeactivated() </big></font></span></code></h4> \endhtmlonly

onScreensaverDeactivated method.

Will be called when screensaver goes off

◆ onSettingsChanged()

XBMCAddon::xbmc::Monitor::onSettingsChanged ( )

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> onSettingsChanged() </big></font></span></code></h4> \endhtmlonly

onSettingsChanged method.

Will be called when addon settings are changed

◆ waitForAbort()

bool XBMCAddon::xbmc::Monitor::waitForAbort (   ...)

@brief \htmlonly <h4><code><span style="font-style: italic;">Function: </span><span style="font-style: bold;"><font color=31363b><big> waitForAbort([timeout]) </big></font></span></code></h4> \endhtmlonly

Wait for Abort

Block until abort is requested, or until timeout occurs. If an abort requested have already been made, return immediately.

Parameters
timeout[opt] float - timeout in seconds. Default: no timeout.
Returns
True when abort have been requested, False if a timeout is given and the operation times out.
v14 Python API changes:
New function added.