ubports-volte/mce-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[mce] Add blanking pause related D-Bus constants. JB#41340

Browse Source 
Also update documentation for MCE_PREVENT_BLANK_REQ.

Signed-off-by: Simo Piiroinen <simo.piiroinen@jollamobile.com>
This commit is contained in:
Simo Piiroinen
2018-03-19 12:47:17 +02:00
parent 2789748227
commit d56854bc87
1 changed files with 43 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
include/mce/dbus-names.h
View File

@@ -356,8 +356,20 @@
*
* @since mce 0.5
*
* If display is on and lockscreen is not active, normal blanking
* timers are stopped for 60 seconds.
* Normal blanking timers are stopped for 60 seconds - under roughly
* the following conditions:
*
* - Display is already on and lockscreen is not active
*
* - Display is already on, lockscreen is active but
* compositor has notified that user interaction is expected
* and the blanking prevent request originates from the same
* process that owns the topmost window on screen.
*
* The exact details are subject to change and clients showld
* track #MCE_PREVENT_BLANK_ALLOWED_SIG signals to know when
* making blank prevention calls are allowed/ignored (and query
* the initial state with #MCE_PREVENT_BLANK_ALLOWED_GET).
*
* To keep display from blanking for longer periods, the client
* needs to re-issue this call every 60 seconds.
@@ -365,9 +377,15 @@
* When application no longer wishes to keep display from blanking,
* it should make a #MCE_CANCEL_PREVENT_BLANK_REQ method call.
*
* @note If client drops from the system bus, it is handled as if
* the client would have made a #MCE_CANCEL_PREVENT_BLANK_REQ
* call.
* @note If client drops from the system bus, or misses the 60 second
* renew period, it is handled as if the client would have made
* a #MCE_CANCEL_PREVENT_BLANK_REQ method call.
*
* @note Previously mce waited exactly 60 seconds for renew calls
* which meant clients had to use shorter than 60 second
* renew periods to avoid hiccups. Since mce >= 1.93.0
* the hard limit is 65 seconds and thus clients can schedule
* renewing to occur once / 60 seconds.
*/
# define MCE_PREVENT_BLANK_REQ "req_display_blanking_pause"
@@ -397,6 +415,26 @@
*/
# define MCE_PREVENT_BLANK_SIG "display_blanking_pause_ind"
/** Query whether MCE_PREVENT_BLANK_REQ request can be made
*
* @since 1.93.0
*
* See #MCE_PREVENT_BLANK_REQ for details.
*
* @return boolean: true for allowed, false for not allowed
*/
# define MCE_PREVENT_BLANK_ALLOWED_GET "get_display_blanking_pause_allowed"
/** Notify change in whether MCE_PREVENT_BLANK_REQ request can be made
*
* @since 1.93.0
*
* See #MCE_PREVENT_BLANK_REQ for details.
*
* @param boolean: true for allowed, false for not allowed
*/
# define MCE_PREVENT_BLANK_ALLOWED_SIG "display_blanking_pause_allowed_ind"
/*@}*/
/////////////////////////////////////////////////////////////////////////////