Function libeyelink_sys::begin_realtime_mode

pub unsafe extern "C" fn begin_realtime_mode(delay: UINT32)

Sets up for realtime execution (minimum delays) This may take some time (assume up to 100 msec) sets min time so delay may be useful Effects vary by operating system Keyboard, mouse, and sound may be disabled in some OS Has little effect in Win9x/ME Sets the application priority and cleans up pending Windows activity to place the application in realtime mode. This could take up to 100 milliseconds, depending on the operation system, to set the application priority. Use the \c <delay> value to set the minimum time this function takes, so that this function can act as a useful delay.

@remarks Warning: Under Windows XP, on single core machines, this call will lock out all keyboard input. The Task Manager will take about 30 seconds to respond to CTRL-ALT-DEL, so press this once and be patient. The keyboard functions well in realtime mode under Windows 2000. This function has little or no effect under Windows 95/98/Me. Keyboard, mouse, and sound may be disabled in some OS.

@remarks Under Windowns Xp the application need to run under administrator credentials to get the realtime priorities.

@remarks Under Windows Vista and later, the application need to be run as "Run as Administrator" to get realtime priorities.

@remarks Under Linux, the application need to be run as root to get realtime priorities.

@param delay Minimum delay in milliseconds (should be about 100).

\b Example:

\code
#include 

int error;

error = start_recording(1,1,1,1);
if(error != 0)  return error;     // return error code if failed

begin_realtime_mode(100);

...

end_realtime_mode();

...
\endcode

\sa \c end_realtime_mode()