nuitrack.Nuitrack Class Reference

Public Types
enum	NuitrackMode {   NuitrackMode.RELEASE,   NuitrackMode.DEBUG }

Public Member Functions
delegate void	OnIssueUpdate (IssuesData issuesData)

Static Public Member Functions
static void	Init (string config="", NuitrackMode mode=NuitrackMode.RELEASE)
	Initialize Nuitrack C#. More...
static void	Run ()
	Start processing the data provided by the sensor. More...
static void	Update ()
	Initiate Nuitrack update. More...
static void	Update (Module module)
	Initiate Nuitrack module data update. More...
static void	WaitUpdate (Module module)
	Initiate Nuitrack module update and wait for it. More...
static void	Release ()
	Stop data processing and destroy all existing Nuitrack modules. More...
static void	SetConfigValue (string key, string value)
	Set the value of a Nuitrack configuration parameter. More...
static string	GetConfigValue (string key)
	Get the value of a Nuitrack configuration parameter. More...
static string	GetLicense ()
static string	GetInstancesJson ()
	Get the JSON string of Nuitrack instance-based API. More...
static int	GetVersion ()
	Get Nuitrack Version. The version is calculated by the formula: major * 10000 + minor * 100 + revision. More...
static List < device.NuitrackDevice >	GetDeviceList ()
	Get list of available devices. More...
static void	SetDevice (device.NuitrackDevice dev)
	Setting the default device. More...

Properties
static OnIssueUpdate	onIssueUpdateEvent
	Raised in case of an update issue.

Member Enumeration Documentation

enum nuitrack.Nuitrack.NuitrackMode

Enumerator
RELEASE	Initializes native Nuitrack C#.
DEBUG	Initializes wireless Nuitrack C#.

Member Function Documentation

static string nuitrack.Nuitrack.GetConfigValue ( string  key )

inlinestatic

Get the value of a Nuitrack configuration parameter.

Parameters

key	Parameter key

Returns

Parameter value

static List<device.NuitrackDevice> nuitrack.Nuitrack.GetDeviceList ( )

inlinestatic

Get list of available devices.

Returns

List of available devices.

See Also

NuitrackDeviceInfo

static string nuitrack.Nuitrack.GetInstancesJson ( )

inlinestatic

Get the JSON string of Nuitrack instance-based API.

Returns

JSON string

static int nuitrack.Nuitrack.GetVersion ( )

inlinestatic

Get Nuitrack Version. The version is calculated by the formula: major * 10000 + minor * 100 + revision.

Returns

An integer value of Nuitrack version.

static void nuitrack.Nuitrack.Init ( string  config = "", NuitrackMode  mode = NuitrackMode.RELEASE  )

inlinestatic

Initialize Nuitrack C#.

This should be called before using any other Nuitrack API functions.

Note

For Android OS: config file is located in the folder with unpacked assets after the installation of Nuitrack.apk

Parameters

config

Config file for Nuitrack initialization.

Warning

Do not specify the config and mode values as they're set automatically. Specify the path to nuitrack.config only if the default location of nuitrack.config (defined after the installation of Nuitrack runtime) was changed.

static void nuitrack.Nuitrack.Release ( )

inlinestatic

Stop data processing and destroy all existing Nuitrack modules.

Note

To restart Nuitrack after release you should call Nuitrack::init and create all required modules again.

static void nuitrack.Nuitrack.Run ( )

inlinestatic

Start processing the data provided by the sensor.

The stages of data processing are determined by the existing module objects. The data is processed asynchronously.

static void nuitrack.Nuitrack.SetConfigValue ( string  key, string  value  )

inlinestatic

Set the value of a Nuitrack configuration parameter.

Parameters

key	Parameter key
value	Parameter value

static void nuitrack.Nuitrack.SetDevice ( device.NuitrackDevice  dev )

inlinestatic

Setting the default device.

Parameters

dev	Device info.

See Also

NuitrackDeviceInfo

static void nuitrack.Nuitrack.Update ( )

inlinestatic

Initiate Nuitrack update.

Request new data from all created Nuitrack modules. No data synchronization is performed.

Note

Non-blocking operation.

static void nuitrack.Nuitrack.Update ( Module  module )

inlinestatic

Initiate Nuitrack module data update.

Request new data from Nuitrack module. When data becomes available, corresponding callbacks (event handlers) will be called for a given module and all the modules that are required for it. The data sent to these callbacks will be synchronized, so the callback calls will be consistent. Callback call order is defined by module dependency chain: from independent to dependent. The call order of callbacks belonging to a particular module is defined by internal organization of this module.

Note

Non-blocking operation.

static void nuitrack.Nuitrack.WaitUpdate ( Module  module )

inlinestatic

Initiate Nuitrack module update and wait for it.

Similar to the Nuitrack::Update, but waits until all the required callbacks (event handlers) are called.

Note

Blocking operation.