Kodi Documentation  19.0
Kodi is an open source media player and entertainment hub.
XBMCAddon::xbmc::Monitor Class Reference

#include <Monitor.h>

Inheritance diagram for XBMCAddon::xbmc::Monitor:
XBMCAddon::AddonCallback XBMCAddon::AddonClass CCriticalSection XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >

Public Member Functions

 Monitor ()
 
void OnSettingsChanged ()
 
void OnScreensaverActivated ()
 
void OnScreensaverDeactivated ()
 
void OnDPMSActivated ()
 
void OnDPMSDeactivated ()
 
void OnScanStarted (const String &library)
 
void OnScanFinished (const String &library)
 
void OnCleanStarted (const String &library)
 
void OnCleanFinished (const String &library)
 
void OnNotification (const String &sender, const String &method, const String &data)
 
const StringGetId ()
 
long GetInvokerId ()
 
void AbortNotify ()
 
 onSettingsChanged ()
 

Function: onSettingsChanged()


onSettingsChanged method. More...
 
 onScreensaverActivated ()
 

Function: onScreensaverActivated()


onScreensaverActivated method. More...
 
 onScreensaverDeactivated ()
 

Function: onScreensaverDeactivated()


onScreensaverDeactivated method. More...
 
 onDPMSActivated ()
 

Function: onDPMSActivated()


onDPMSActivated method. More...
 
 onDPMSDeactivated ()
 

Function: onDPMSDeactivated()


onDPMSDeactivated method. More...
 
 onScanStarted (...)
 

Function: onScanStarted(library)


onScanStarted method. More...
 
 onScanFinished (...)
 

Function: onScanFinished(library)


onScanFinished method. More...
 
 onCleanStarted (...)
 

Function: onCleanStarted(library)


onCleanStarted method. More...
 
 onCleanFinished (...)
 

Function: onCleanFinished(library)


onCleanFinished method. More...
 
 onNotification (...)
 

Function: onNotification(sender, method, data)


onNotification method. More...
 
 waitForAbort (...)
 

Function: waitForAbort([timeout])


Wait for Abort More...
 
 abortRequested ()
 

Function: abortRequested()


Returns True if abort has been requested. More...
 
 ~Monitor () override
 
- Public Member Functions inherited from XBMCAddon::AddonCallback
 ~AddonCallback () override
 
void setHandler (CallbackHandler *_handler)
 
void invokeCallback (Callback *callback)
 
- Public Member Functions inherited from XBMCAddon::AddonClass
 AddonClass ()
 
virtual ~AddonClass ()
 
const char * GetClassname () const
 
LanguageHookGetLanguageHook ()
 
bool isDeallocating ()
 
void Release () const
 
void Acquire () const
 
- Public Member Functions inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
 CountingLockable ()=default
 
void lock ()
 
bool try_lock ()
 
void unlock ()
 
unsigned int exit (unsigned int leave=0)
 
void restore (unsigned int restoreCount)
 
XbmcThreads::CRecursiveMutex & get_underlying ()
 

Additional Inherited Members

- Static Public Member Functions inherited from XBMCAddon::AddonClass
static short getNumAddonClasses ()
 
- Protected Member Functions inherited from XBMCAddon::AddonCallback
bool hasHandler ()
 
 AddonCallback ()
 
- Protected Member Functions inherited from XBMCAddon::AddonClass
virtual void deallocating ()
 
- Static Protected Member Functions inherited from XBMCAddon::AddonClass
static short getNextClassIndex ()
 
- Protected Attributes inherited from XBMCAddon::AddonCallback
AddonClass::Ref< CallbackHandlerhandler
 
- Protected Attributes inherited from XBMCAddon::AddonClass
LanguageHooklanguageHook
 
- Protected Attributes inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
XbmcThreads::CRecursiveMutex mutex
 
unsigned int count
 

Constructor & Destructor Documentation

§ Monitor()

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

§ ~Monitor()

XBMCAddon::xbmc::Monitor::~Monitor ( )
override

Member Function Documentation

§ AbortNotify()

void XBMCAddon::xbmc::Monitor::AbortNotify ( )

Called from XBPython to notify registered monitors that a script is aborting/ending.

§ GetId()

const String& XBMCAddon::xbmc::Monitor::GetId ( )
inline

§ GetInvokerId()

long XBMCAddon::xbmc::Monitor::GetInvokerId ( )
inline

§ OnCleanFinished()

void XBMCAddon::xbmc::Monitor::OnCleanFinished ( const String library)
inline

§ OnCleanStarted()

void XBMCAddon::xbmc::Monitor::OnCleanStarted ( const String library)
inline

§ OnDPMSActivated()

void XBMCAddon::xbmc::Monitor::OnDPMSActivated ( )
inline

§ OnDPMSDeactivated()

void XBMCAddon::xbmc::Monitor::OnDPMSDeactivated ( )
inline

§ OnNotification()

void XBMCAddon::xbmc::Monitor::OnNotification ( const String sender,
const String method,
const String data 
)
inline

§ OnScanFinished()

void XBMCAddon::xbmc::Monitor::OnScanFinished ( const String library)
inline

§ OnScanStarted()

void XBMCAddon::xbmc::Monitor::OnScanStarted ( const String library)
inline

§ OnScreensaverActivated()

void XBMCAddon::xbmc::Monitor::OnScreensaverActivated ( )
inline

§ OnScreensaverDeactivated()

void XBMCAddon::xbmc::Monitor::OnScreensaverDeactivated ( )
inline

§ OnSettingsChanged()

void XBMCAddon::xbmc::Monitor::OnSettingsChanged ( )
inline

The documentation for this class was generated from the following files: