[][src]Function libeyelink_sys::start_recording

pub unsafe extern "C" fn start_recording(
    file_samples: INT16,
    file_events: INT16,
    link_samples: INT16,
    link_events: INT16
) -> INT16

Start recording with data types requested * Check that all requested link data is arriving * return 0 if OK, else trial exit code * Starts the EyeLink tracker recording, sets up link for data reception if enabled.

@remarks Recording may take 10 to 30 milliseconds to begin from this command. The function also waits until at least one of all requested link data types have been received. If the return value is not zero, return the result as the trial result code. @param file_samples If \c 1, writes samples to EDF file. If \c 0, disables sample recording. @param file_events If \c 1, writes events to EDF file. If \c 0, disables event recording. @param link_samples If \c 1, sends samples through link. If \c 0, disables link sample access. @param link_events If \c 1, sends events through link. If \c 0, disables link event access. @return \c 0 if successful, else trial return code.

\b Example:

\code

#include 

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

begin_realtime_mode(100);

...

while(1)
{
if((error=check_recording())!=0) return error;
...
}

end_realtime_mode();
pump_delay(100);
stop_recording();

while(getkey());          // dump any accumulated key presses

return check_record_exit();
\endcode

\sa \c check_record_exit(), \c check_recording(), \c eyelink_data_start() and \c stop_recording()