Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::WINDOWING::IOSScreenSaver Class Referenceabstract

#include <OSScreenSaver.h>

Inheritance diagram for KODI::WINDOWING::IOSScreenSaver:
COSScreenSaverAndroid COSScreenSaverOSX COSScreenSaverTVOS COSScreenSaverX11 KODI::WINDOWING::CDummyOSScreenSaver KODI::WINDOWING::LINUX::COSScreenSaverFreedesktop KODI::WINDOWING::WAYLAND::COSScreenSaverIdleInhibitUnstableV1 KODI::WINDOWING::WAYLAND::COSScreenSaverWebOS

Public Member Functions

virtual ~IOSScreenSaver ()=default
 
virtual void Inhibit ()=0
 
virtual void Uninhibit ()=0
 

Detailed Description

Interface for OS screen saver control implementations

Constructor & Destructor Documentation

◆ ~IOSScreenSaver()

virtual KODI::WINDOWING::IOSScreenSaver::~IOSScreenSaver ( )
virtualdefault

Member Function Documentation

◆ Inhibit()

virtual void KODI::WINDOWING::IOSScreenSaver::Inhibit ( )
pure virtual

Do not allow the OS screen saver to become active

Calling this function multiple times without calling Unhibit MUST NOT produce any side-effects.

Implemented in COSScreenSaverAndroid, KODI::WINDOWING::LINUX::COSScreenSaverFreedesktop, KODI::WINDOWING::CDummyOSScreenSaver, COSScreenSaverOSX, COSScreenSaverTVOS, KODI::WINDOWING::WAYLAND::COSScreenSaverIdleInhibitUnstableV1, KODI::WINDOWING::WAYLAND::COSScreenSaverWebOS, and COSScreenSaverX11.

◆ Uninhibit()

virtual void KODI::WINDOWING::IOSScreenSaver::Uninhibit ( )
pure virtual

Allow the OS screen saver to become active again

Calling this function multiple times or at all without calling Inhibit MUST NOT produce any side-effects.

Implemented in COSScreenSaverAndroid, KODI::WINDOWING::LINUX::COSScreenSaverFreedesktop, KODI::WINDOWING::CDummyOSScreenSaver, COSScreenSaverOSX, COSScreenSaverTVOS, KODI::WINDOWING::WAYLAND::COSScreenSaverIdleInhibitUnstableV1, KODI::WINDOWING::WAYLAND::COSScreenSaverWebOS, and COSScreenSaverX11.


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