Static Public Member Functions | List of all members
InteractionLibFactory Class Reference

Provides the entry point to the actual Interaction Library. More...

Static Public Member Functions

static IInteractionLib CreateInteractionLib (FieldOfUse fieldOfUse)
 Creates a new IInteractionLib instance with a default adapter, if available. More...
 
static IInteractionLib CreateInteractionLib (FieldOfUse fieldOfUse, LoggerCallback logger, LoggingLevel level)
 Creates a new IInteractionLib instance with a default adapter, if available. More...
 
static IInteractionLib CreateInteractionLib (FieldOfUse fieldOfUse, IntPtr adapterFunctions)
 Creates a new IInteractionLib instance with a custom adapter. More...
 
static IInteractionLib CreateInteractionLib (FieldOfUse fieldOfUse, LoggerCallback logger, LoggingLevel level, IntPtr adapterFunctions)
 Creates a new IInteractionLib instance with a custom adapter. More...
 

Detailed Description

Provides the entry point to the actual Interaction Library.

For testing purposes, Interaction Library SDK C# binding clients can "mock" or "stub" the Interaction Library functionality by providing their own implementation of the IInteractionLib interface. However, by using InteractionLibFactory.CreateInteractionLib(), the actual Interaction Library implementation will be used.

Member Function Documentation

◆ CreateInteractionLib() [1/4]

static IInteractionLib CreateInteractionLib ( FieldOfUse  fieldOfUse)
inlinestatic

Creates a new IInteractionLib instance with a default adapter, if available.

Parameters
fieldOfUseThis mandatory flag denotes if the Interaction Library is used for interactive or analytical purposes. Please see the EULA and documentation for more information.
Returns
A new disposable IInteractionLib instance.

◆ CreateInteractionLib() [2/4]

static IInteractionLib CreateInteractionLib ( FieldOfUse  fieldOfUse,
LoggerCallback  logger,
LoggingLevel  level 
)
inlinestatic

Creates a new IInteractionLib instance with a default adapter, if available.

Parameters
fieldOfUseThis mandatory flag denotes if the Interaction Library is used for interactive or analytical purposes. Please see the EULA and documentation for more information.
loggerA delegate that will be called by the Interaction Library for logging purposes. The level parameter denotes the highest log level at which the callback function will be called. The text parameter passed to the delegate contains a string formatted in a format specified by Tobii.
levelThis parameter denotes the highest log level at which the callback function will be called. For example, if "info" is specified, then the callback will be called for "error", "warning" and "info", but not for "debug" and "trace".
Returns
A new disposable IInteractionLib instance.

◆ CreateInteractionLib() [3/4]

static IInteractionLib CreateInteractionLib ( FieldOfUse  fieldOfUse,
IntPtr  adapterFunctions 
)
inlinestatic

Creates a new IInteractionLib instance with a custom adapter.

Parameters
fieldOfUseThis mandatory flag denotes if the Interaction Library is used for interactive or analytical purposes. Please see the EULA and documentation for more information.
adapterFunctionsPointer to an instance of the native IL_AdapterFunctions structure that defines the custom adapter. IntPtr.Zero is a valid parameter value which means the default adapter will not be set. Without a valid adapter the following functions will do nothing and return Result.Warning_NoAdapterSet.

WaitAndUpdate() , WaitForDeviceConnection() , Update() , UpdateStreamingDataOutput() , UpdateInteraction() ,

However, it is still possible to add interactors and subscribe to gaze focus events and data streams.

Returns
A new disposable IInteractionLib instance.

◆ CreateInteractionLib() [4/4]

static IInteractionLib CreateInteractionLib ( FieldOfUse  fieldOfUse,
LoggerCallback  logger,
LoggingLevel  level,
IntPtr  adapterFunctions 
)
inlinestatic

Creates a new IInteractionLib instance with a custom adapter.

Parameters
fieldOfUseThis mandatory flag denotes if the Interaction Library is used for interactive or analytical purposes. Please see the EULA and documentation for more information.
loggerA delegate that will be called by the Interaction Library for logging purposes. The level parameter denotes the highest log level at which the callback function will be called. The text parameter passed to the delegate contains a string formatted in a format specified by Tobii.
levelThis parameter denotes the highest log level at which the callback function will be called. For example, if "info" is specified, then the callback will be called for "error", "warning" and "info", but not for "debug" and "trace".
adapterFunctionsPointer to an instance of the native IL_AdapterFunctions structure that defines the custom adapter. IntPtr.Zero is a valid parameter value which means the default adapter will not be set. Without a valid adapter the following functions will do nothing and return Result.Warning_NoAdapterSet.

WaitAndUpdate() , WaitForDeviceConnection() , Update() , UpdateStreamingDataOutput() , UpdateInteraction() ,

However, it is still possible to add interactors and subscribe to gaze focus events and data streams.

Returns
A new disposable IInteractionLib instance.

The documentation for this class was generated from the following file: