screen_input_guard_enable()

Enable Screen Input Guard.

Synopsis:

#include <bps/screen_input_guard.h>
 
BPS_API int screen_input_guard_enable(void)

Since:

BlackBerry 10.2.0

Arguments:

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

The screen_input_guard_enable() function enables Screen Input Guard. That is, when something (assumed to be a face) is detected to be near the device, the screen will turn off and the touchscreen will not respond to touch input. When that something is no longer near the device, the screen will turn on and the touchscreen will again respond to touch input.

To disable Screen Input Guard call screen_input_guard_disable(). Calls to screen_input_guard_enable() and screen_input_guard_disable() are reference counted. Thus if you call screen_input_guard_enable() multiple times, you must call screen_input_guard_disable() the same number of times before Screen Input Guard is actually disabled.

Calling screen_input_guard_stop_events() will forcibly disable Screen Input Guard, ignoring the reference count.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.

Last modified: 2014-05-14



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus