Scol functions definition

Functions
int	_OpenSmiDevice (mmachine m)
	_OpenSmiDevice : This function opens a remote connection to SMI RED system
int	_CloseSmiDevice (mmachine m)
	_CloseSmiDevice : This function closes a remote connection to SMI RED system
int	_CBSmiConnected (mmachine m)
	_CBSmiConnected : This function sets the Callback for a connected event from SMI RED system
int	_CBSmiDisconnected (mmachine m)
	_CBSmiDisconnected : This function sets the Callback for a disconnected event from SMI RED system
int	_CBSmiCalibrationDone (mmachine m)
	_CBSmiCalibrationDone : This function sets the Callback for a calibration done event from SMI RED system
int	_CBSmiNewFixation (mmachine m)
	_CBSmiNewFixation : This function sets the Callback for new fixation data available from SMI RED system
int	_CBSmiNewSample (mmachine m)
	_CBSmiNewSample : This function sets the Callback for new sample data available from SMI RED system
int	_StartCalibration (mmachine m)
	_StartCalibration : This function starts the calibration process for SMI RED system
int	_ShowEyes (mmachine m)
	_ShowEyes : This function displays/hides eye tracking window for SMI RED system

---

Detailed Description

Scol functions definition

---

Function Documentation

int _CBSmiCalibrationDone

(

mmachine

m

)

_CBSmiCalibrationDone : This function sets the Callback for a calibration done event from SMI RED system

Prototype: fun [ObjSmi fun [ObjSmi u0] u1 u0] ObjSmi

Parameters:

ObjSmi	: the current ObjSmi
fun	[ObjSmi u0] : SCOL CallBack function to call
u1	: user parameter
u0	: user parameter

Returns:

I : ObjSmi if success

Definition at line 310 of file Plugin.cpp.

int _CBSmiConnected

(

mmachine

m

)

_CBSmiConnected : This function sets the Callback for a connected event from SMI RED system

Prototype: fun [ObjSmi fun [ObjSmi u0] u1 u0] ObjSmi

Parameters:

ObjSmi	: the current ObjSmi
fun	[ObjSmi u0] : SCOL CallBack function to call
u1	: user parameter
u0	: user parameter

Returns:

I : ObjSmi if success

Definition at line 246 of file Plugin.cpp.

int _CBSmiDisconnected

(

mmachine

m

)

_CBSmiDisconnected : This function sets the Callback for a disconnected event from SMI RED system

Prototype: fun [ObjSmi fun [ObjSmi u0] u1 u0] ObjSmi

Parameters:

ObjSmi	: the current ObjSmi
fun	[ObjSmi u0] : SCOL CallBack function to call
u1	: user parameter
u0	: user parameter

Returns:

I : ObjSmi if success

Definition at line 278 of file Plugin.cpp.

int _CBSmiNewFixation

(

mmachine

m

)

_CBSmiNewFixation : This function sets the Callback for new fixation data available from SMI RED system

Prototype: fun [ObjSmi fun [ObjSmi u0 F I I] u1 u0] ObjSmi

Parameters:

ObjSmi	: the current ObjSmi
fun	[ObjSmi u0 F I I] : SCOL CallBack function to call
u1	: user parameter
u0	: user parameter

Returns:

I : ObjSmi if success

Definition at line 342 of file Plugin.cpp.

int _CBSmiNewSample

(

mmachine

m

)

_CBSmiNewSample : This function sets the Callback for new sample data available from SMI RED system

Prototype: fun [ObjSmi fun [ObjSmi u0 [F I I] [F I I]] u1 u0] ObjSmi

Parameters:

ObjSmi	: the current ObjSmi
fun	[ObjSmi u0 [F I I] [F I I]] : SCOL CallBack function to call
u1	: user parameter
u0	: user parameter

Returns:

I : ObjSmi if success

Definition at line 383 of file Plugin.cpp.

int _CloseSmiDevice

(

mmachine

m

)

_CloseSmiDevice : This function closes a remote connection to SMI RED system

Prototype: fun [ObjSmi] I

Parameters:

ObjSmi

: the current ObjSmi

Returns:

I : 0 if success, NIL otherwise

Definition at line 205 of file Plugin.cpp.

int _OpenSmiDevice

(

mmachine

m

)

_OpenSmiDevice : This function opens a remote connection to SMI RED system

Prototype: fun [Chn S I S I] ObjSmi

Parameters:

Chn	: the current channel
S	: IP address for iViewX workstation to enable UDP communication
I	: port for iViewX workstation to enable UDP communication
S	: IP address for stimulus PC to enable UDP communication
I	: port for stimulus PC to enable UDP communication

Returns:

ObjSmi : The EyeTracking object or NIL if creation fails

Definition at line 124 of file Plugin.cpp.

int _ShowEyes

(

mmachine

m

)

_ShowEyes : This function displays/hides eye tracking window for SMI RED system

Prototype: fun [ObjSmi I] I

Parameters:

ObjSmi	: the current ObjSmi
I	: 1 to display eye tracking window, 0 to hide it

Returns:

I : 0 if success, NIL otherwise

Definition at line 555 of file Plugin.cpp.

int _StartCalibration

(

mmachine

m

)

_StartCalibration : This function starts the calibration process for SMI RED system

Prototype: fun [ObjSmi I I I I I I I I] I

Parameters:

ObjSmi	: the current ObjSmi
I	: number of calibration points (2, 5, 9 or 13)
I	: validation for calibration process (1 if required, 0 otherwise)
I	: device to display calibration process (0 for Primary device, 1 for Secondary device)
I	: speed for calibration process (0 for Slow, 1 for Fast)
I	: brightness of foreground displayed during calibration (from 0 to 255)
I	: brightness of background displayed during calibration (from 0 to 255)
I	: shape displayed during calibration (0 for Circle1, 1 for Circle2, 2 for Cross)
I	: shape size (from 1 to 50)

Returns:

I : 0 if success, NIL otherwise

Definition at line 452 of file Plugin.cpp.