#include <sys/types.h>

Macros
#define	EMOSTATE_DLL_API

Typedefs
typedef void *	EmoStateHandle
	Defining EmoStateHandle as a void pointer. More...

typedef enum IEE_EmotivSuite_enum	IEE_EmotivSuite_t
	Emotiv Detection Suite enumerator. More...

typedef enum IEE_FacialExpressionAlgo_enum	IEE_FacialExpressionAlgo_t
	FacialExpression facial expression type enumerator. More...

typedef enum IEE_MentalCommandAction_enum	IEE_MentalCommandAction_t
	MentalCommand action type enumerator. More...

typedef enum IEE_SignalStrength_enum	IEE_SignalStrength_t
	Wireless Signal Strength enumerator. More...

typedef enum IEE_InputChannels_enum	IEE_InputChannels_t
	Logical input channel identifiers. More...

typedef enum IEE_EEG_ContactQuality_enum	IEE_EEG_ContactQuality_t
	EEG Electrode Contact Quality enumeration. More...

Enumerations
enum	IEE_EmotivSuite_enum { IEE_FACIALEXPRESSION = 0, IEE_PERFORMANCEMETRIC, IEE_MENTALCOMMAND }
	Emotiv Detection Suite enumerator. More...

enum	IEE_FacialExpressionAlgo_enum { FE_NEUTRAL = 0x0001, FE_BLINK = 0x0002, FE_WINK_LEFT = 0x0004, FE_WINK_RIGHT = 0x0008, FE_HORIEYE = 0x0010, FE_SURPRISE = 0x0020, FE_FROWN = 0x0040, FE_SMILE = 0x0080, FE_CLENCH = 0x0100, FE_LAUGH = 0x0200, FE_SMIRK_LEFT = 0x0400, FE_SMIRK_RIGHT = 0x0800 }
	FacialExpression facial expression type enumerator. More...

enum	IEE_MentalCommandAction_enum { MC_NEUTRAL = 0x0001, MC_PUSH = 0x0002, MC_PULL = 0x0004, MC_LIFT = 0x0008, MC_DROP = 0x0010, MC_LEFT = 0x0020, MC_RIGHT = 0x0040, MC_ROTATE_LEFT = 0x0080, MC_ROTATE_RIGHT = 0x0100, MC_ROTATE_CLOCKWISE = 0x0200, MC_ROTATE_COUNTER_CLOCKWISE = 0x0400, MC_ROTATE_FORWARDS = 0x0800, MC_ROTATE_REVERSE = 0x1000, MC_DISAPPEAR = 0x2000 }
	MentalCommand action type enumerator. More...

enum	IEE_SignalStrength_enum { NO_SIG = 0, BAD_SIG, GOOD_SIG }
	Wireless Signal Strength enumerator. More...

enum	IEE_InputChannels_enum { IEE_CHAN_CMS = 0, IEE_CHAN_DRL, IEE_CHAN_FP1, IEE_CHAN_AF3, IEE_CHAN_F7, IEE_CHAN_F3, IEE_CHAN_FC5, IEE_CHAN_T7, IEE_CHAN_P7, IEE_CHAN_Pz, IEE_CHAN_O1 = IEE_CHAN_Pz, IEE_CHAN_O2, IEE_CHAN_P8, IEE_CHAN_T8, IEE_CHAN_FC6, IEE_CHAN_F4, IEE_CHAN_F8, IEE_CHAN_AF4, IEE_CHAN_FP2 }
	Logical input channel identifiers. More...

enum	IEE_EEG_ContactQuality_enum { IEEG_CQ_NO_SIGNAL, IEEG_CQ_VERY_BAD, IEEG_CQ_POOR, IEEG_CQ_FAIR, IEEG_CQ_GOOD }
	EEG Electrode Contact Quality enumeration. More...

Functions
EMOSTATE_DLL_API EmoStateHandle	IS_Create ()
	Create EmoState handle. More...

EMOSTATE_DLL_API void	IS_Free (EmoStateHandle state)
	Free EmoState handle. More...

EMOSTATE_DLL_API void	IS_Init (EmoStateHandle state)
	Initialize the EmoState into neutral state. More...

EMOSTATE_DLL_API float	IS_GetTimeFromStart (EmoStateHandle state)
	Return the time since EmoEngine has been successfully connected to the headset. More...

EMOSTATE_DLL_API int	IS_GetHeadsetOn (EmoStateHandle state)
	Return whether the headset has been put on correctly or not. More...

EMOSTATE_DLL_API int	IS_GetNumContactQualityChannels (EmoStateHandle state)
	Query the number of channels of available sensor contact quality data. More...

EMOSTATE_DLL_API IEE_EEG_ContactQuality_t	IS_GetContactQuality (EmoStateHandle state, IEE_InputChannels_t electroIdx)
	Query the contact quality of a specific EEG electrode. More...

EMOSTATE_DLL_API int	IS_GetContactQualityFromAllChannels (EmoStateHandle state, IEE_EEG_ContactQuality_t *contactQuality, size_t numChannels)
	Query the contact quality of all the electrodes in one single call. More...

EMOSTATE_DLL_API IEE_SignalStrength_t	IS_GetWirelessSignalStatus (EmoStateHandle state)
	Query of the current wireless signal strength. More...

EMOSTATE_DLL_API void	IS_GetBatteryChargeLevel (EmoStateHandle state, int chargeLevel, int maxChargeLevel)
	Get the level of charge remaining in the headset battery. More...

EMOSTATE_DLL_API int	IS_FacialExpressionIsBlink (EmoStateHandle state)
	Query whether the user is blinking at the time the EmoState is captured. More...

EMOSTATE_DLL_API int	IS_FacialExpressionIsLeftWink (EmoStateHandle state)
	Query whether the user is winking left at the time the EmoState is captured. More...

EMOSTATE_DLL_API int	IS_FacialExpressionIsRightWink (EmoStateHandle state)
	Query whether the user is winking right at the time the EmoState is captured. More...

EMOSTATE_DLL_API int	IS_FacialExpressionIsEyesOpen (EmoStateHandle state)
	Query whether the eyes of the user are opened at the time the EmoState is captured. More...

EMOSTATE_DLL_API int	IS_FacialExpressionIsLookingUp (EmoStateHandle state)
	Query whether the user is looking up at the time the EmoState is captured. More...

EMOSTATE_DLL_API int	IS_FacialExpressionIsLookingDown (EmoStateHandle state)
	Query whether the user is looking down at the time the EmoState is captured. More...

EMOSTATE_DLL_API int	IS_FacialExpressionIsLookingLeft (EmoStateHandle state)
	Query whether the user is looking left at the time the EmoState is captured with EPOC/EPOC+ headset. More...

EMOSTATE_DLL_API int	IS_FacialExpressionIsLookingRight (EmoStateHandle state)
	Query whether the user is looking right at the time the EmoState is captured with EPOC/EPOC+ headset. More...

EMOSTATE_DLL_API void	IS_FacialExpressionGetEyelidState (EmoStateHandle state, float leftEye, float rightEye)
	Query the eyelids state of the user. More...

EMOSTATE_DLL_API void	IS_FacialExpressionGetEyeLocation (EmoStateHandle state, float x, float y)
	Query the eyes position of the user. More...

EMOSTATE_DLL_API float	IS_FacialExpressionGetEyebrowExtent (EmoStateHandle state)
	Returns the eyebrow extent of the user (Obsolete function) More...

EMOSTATE_DLL_API float	IS_FacialExpressionGetSmileExtent (EmoStateHandle state)
	Returns the smile extent of the user (Obsolete function) More...

EMOSTATE_DLL_API float	IS_FacialExpressionGetClenchExtent (EmoStateHandle state)
	Returns the clench extent of the user (Obsolete function) More...

EMOSTATE_DLL_API IEE_FacialExpressionAlgo_t	IS_FacialExpressionGetUpperFaceAction (EmoStateHandle state)
	Returns the detected upper face FacialExpression action of the user. More...

EMOSTATE_DLL_API float	IS_FacialExpressionGetUpperFaceActionPower (EmoStateHandle state)
	Returns the detected upper face FacialExpression action power of the user. More...

EMOSTATE_DLL_API IEE_FacialExpressionAlgo_t	IS_FacialExpressionGetLowerFaceAction (EmoStateHandle state)
	Returns the detected lower face FacialExpression action of the user. More...

EMOSTATE_DLL_API float	IS_FacialExpressionGetLowerFaceActionPower (EmoStateHandle state)
	Returns the detected lower face FacialExpression action power of the user. More...

EMOSTATE_DLL_API int	IS_FacialExpressionIsActive (EmoStateHandle state, IEE_FacialExpressionAlgo_t type)
	Query whether the signal is too noisy for FacialExpression detection to be active. More...

EMOSTATE_DLL_API IEE_MentalCommandAction_t	IS_MentalCommandGetCurrentAction (EmoStateHandle state)
	Returns the detected MentalCommand action of the user. More...

EMOSTATE_DLL_API float	IS_MentalCommandGetCurrentActionPower (EmoStateHandle state)
	Returns the detected MentalCommand action power of the user. More...

EMOSTATE_DLL_API int	IS_MentalCommandIsActive (EmoStateHandle state)
	Query whether the signal is too noisy for MentalCommand detection to be active. More...

EMOSTATE_DLL_API int	IS_FacialExpressionEqual (EmoStateHandle a, EmoStateHandle b)
	Check whether two states are with identical FacialExpression state, i.e. are both state representing the same facial expression. More...

EMOSTATE_DLL_API int	IS_MentalCommandEqual (EmoStateHandle a, EmoStateHandle b)
	Check whether two states are with identical MentalCommand state. More...

EMOSTATE_DLL_API void	IS_Copy (EmoStateHandle a, EmoStateHandle b)
	Clone EmoStateHandle. More...

EMOSTATE_DLL_API int	IS_EmoEngineEqual (EmoStateHandle a, EmoStateHandle b)
	Check whether two states are with identical EmoEngine state. More...

EMOSTATE_DLL_API int	IS_Equal (EmoStateHandle a, EmoStateHandle b)
	Check whether two EmoStateHandles are identical. More...

Detailed Description

This file is part of the Emotiv SDK.

Header file to define constants and interfaces to access the EmoState structure.

EmoStates are generated by the Emotiv detection engine (EmoEngine) and represent the emotional status of the user at a given time.

EmoStateHandle is an opaque reference to an internal EmoState structure

None of the EmoState interface functions are thread-safe.

This header file is designed to be included under C and C++ environment.

Macro Definition Documentation

#define EMOSTATE_DLL_API

Typedef Documentation

typedef void* EmoStateHandle

Defining EmoStateHandle as a void pointer.

typedef enum IEE_EEG_ContactQuality_enum IEE_EEG_ContactQuality_t

EEG Electrode Contact Quality enumeration.

Used to characterize the EEG signal reception or electrode contact for a sensor on the headset. Note that this differs from the wireless signal strength, which refers to the radio communication between the headset transmitter and USB dongle receiver.

typedef enum IEE_EmotivSuite_enum IEE_EmotivSuite_t

Emotiv Detection Suite enumerator.

typedef enum IEE_FacialExpressionAlgo_enum IEE_FacialExpressionAlgo_t

FacialExpression facial expression type enumerator.

typedef enum IEE_InputChannels_enum IEE_InputChannels_t

Logical input channel identifiers.

Note: the number of channels may not necessarily match the number of electrodes on your headset. Signal quality and input data for some sensors will be identical: CMS = DRL

typedef enum IEE_MentalCommandAction_enum IEE_MentalCommandAction_t

MentalCommand action type enumerator.

typedef enum IEE_SignalStrength_enum IEE_SignalStrength_t

Wireless Signal Strength enumerator.

Enumeration Type Documentation

enum IEE_EEG_ContactQuality_enum

EEG Electrode Contact Quality enumeration.

Used to characterize the EEG signal reception or electrode contact for a sensor on the headset. Note that this differs from the wireless signal strength, which refers to the radio communication between the headset transmitter and USB dongle receiver.

Enumerator
IEEG_CQ_NO_SIGNAL
IEEG_CQ_VERY_BAD
IEEG_CQ_POOR
IEEG_CQ_FAIR
IEEG_CQ_GOOD

enum IEE_EmotivSuite_enum

Emotiv Detection Suite enumerator.

Enumerator
IEE_FACIALEXPRESSION
IEE_PERFORMANCEMETRIC
IEE_MENTALCOMMAND

enum IEE_FacialExpressionAlgo_enum

FacialExpression facial expression type enumerator.

Enumerator
FE_NEUTRAL
FE_BLINK
FE_WINK_LEFT
FE_WINK_RIGHT
FE_HORIEYE
FE_SURPRISE
FE_FROWN
FE_SMILE
FE_CLENCH
FE_LAUGH
FE_SMIRK_LEFT
FE_SMIRK_RIGHT

enum IEE_InputChannels_enum

Logical input channel identifiers.

Note: the number of channels may not necessarily match the number of electrodes on your headset. Signal quality and input data for some sensors will be identical: CMS = DRL

Enumerator
IEE_CHAN_CMS
IEE_CHAN_DRL
IEE_CHAN_FP1
IEE_CHAN_AF3
IEE_CHAN_F7
IEE_CHAN_F3
IEE_CHAN_FC5
IEE_CHAN_T7
IEE_CHAN_P7
IEE_CHAN_Pz
IEE_CHAN_O1
IEE_CHAN_O2
IEE_CHAN_P8
IEE_CHAN_T8
IEE_CHAN_FC6
IEE_CHAN_F4
IEE_CHAN_F8
IEE_CHAN_AF4
IEE_CHAN_FP2

enum IEE_MentalCommandAction_enum

MentalCommand action type enumerator.

Enumerator
MC_NEUTRAL
MC_PUSH
MC_PULL
MC_LIFT
MC_DROP
MC_LEFT
MC_RIGHT
MC_ROTATE_LEFT
MC_ROTATE_RIGHT
MC_ROTATE_CLOCKWISE
MC_ROTATE_COUNTER_CLOCKWISE
MC_ROTATE_FORWARDS
MC_ROTATE_REVERSE
MC_DISAPPEAR

enum IEE_SignalStrength_enum

Wireless Signal Strength enumerator.

Enumerator
NO_SIG
BAD_SIG
GOOD_SIG

Function Documentation

EMOSTATE_DLL_API void IS_Copy	(	EmoStateHandle	a,
		EmoStateHandle	b
	)

Clone EmoStateHandle.

Parameters

a	- Destination of EmoStateHandle
b	- Source of EmoStateHandle

See also: IS_Create

EMOSTATE_DLL_API EmoStateHandle IS_Create ( )

Create EmoState handle.

NOTE: THIS FUNCTION HAS BEEN DEPRECATED - please use IEE_EmoStateCreate instead.

IS_Init is called automatically after the creation of the EmoState handle. IS_Free must be called to free up resources during the creation of the EmoState handle.

Returns: the EmoStateHandle if succeeded

See also: IEE_EmoStateCreate, IS_Free, IS_Init

EMOSTATE_DLL_API int IS_EmoEngineEqual	(	EmoStateHandle	a,
		EmoStateHandle	b
	)

Check whether two states are with identical EmoEngine state.

This function is comparing the time since EmoEngine start, the wireless signal strength and the signal quality of different channels

Parameters

a	- EmoStateHandle
b	- EmoStateHandle

Returns: 1: Equal, 0: Different

See also: IS_PerformanceMetricEqual, IS_FacialExpressionEqual, IS_MentalCommandEqual, IS_Equal

EMOSTATE_DLL_API int IS_Equal	(	EmoStateHandle	a,
		EmoStateHandle	b
	)

Check whether two EmoStateHandles are identical.

Parameters

a	- EmoStateHandle
b	- EmoStateHandle

Returns: 1: Equal, 0: Different

See also: IS_PerformanceMetricEqual, IS_FacialExpressionEqual, IS_EmoEngineEqual

EMOSTATE_DLL_API int IS_FacialExpressionEqual	(	EmoStateHandle	a,
		EmoStateHandle	b
	)

Check whether two states are with identical FacialExpression state, i.e. are both state representing the same facial expression.

Parameters

a	- EmoStateHandle
b	- EmoStateHandle

Returns: 1: Equal, 0: Different

See also: IS_FacialExpressionEqual, IS_MentalCommandEqual, IS_EmoEngineEqual, IS_Equal

EMOSTATE_DLL_API float IS_FacialExpressionGetClenchExtent ( EmoStateHandle state )

Returns the clench extent of the user (Obsolete function)

Parameters

state - EmoStatehandle

Returns: clench extent value (0.0 to 1.0)

See also: IS_FacialExpressionGetLowerFaceAction, IS_FacialExpressionGetLowerFaceActionPower

EMOSTATE_DLL_API float IS_FacialExpressionGetEyebrowExtent ( EmoStateHandle state )

Returns the eyebrow extent of the user (Obsolete function)

Parameters

state - EmoStateHandle

Returns: eyebrow extent value (0.0 to 1.0)

See also: IS_FacialExpressionGetUpperFaceAction, IS_FacialExpressionGetUpperFaceActionPower

EMOSTATE_DLL_API void IS_FacialExpressionGetEyelidState	(	EmoStateHandle	state,
		float *	leftEye,
		float *	rightEye
	)

Query the eyelids state of the user.

The left and right eyelid state are stored in the parameter leftEye and rightEye respectively. They are floating point values ranging from 0.0 to 1.0. 0.0 indicates that the eyelid is fully opened while 1.0 indicates that the eyelid is fully closed.

Parameters

state	- EmoStatehandle
leftEye	- the left eyelid state (0.0 to 1.0)
rightEye	- the right eyelid state (0.0 to 1.0)

EMOSTATE_DLL_API void IS_FacialExpressionGetEyeLocation	(	EmoStateHandle	state,
		float *	x,
		float *	y
	)

Query the eyes position of the user.

The horizontal and vertical position of the eyes are stored in the parameter x and y respectively. They are floating point values ranging from -1.0 to 1.0.

For horizontal position, -1.0 indicates that the user is looking left while 1.0 indicates that the user is looking right.

For vertical position, -1.0 indicates that the user is looking down while 1.0 indicatest that the user is looking up.

This function assumes that both eyes have the same horizontal or vertical positions. (i.e. no cross eyes)

Parameters

state	- EmoStateHandle
x	- the horizontal position of the eyes
y	- the veritcal position of the eyes

EMOSTATE_DLL_API IEE_FacialExpressionAlgo_t IS_FacialExpressionGetLowerFaceAction ( EmoStateHandle state )

Returns the detected lower face FacialExpression action of the user.

Parameters

state - EmoStatehandle

Returns: pre-defined FacialExpression action types

See also: IS_FacialExpressionGetLowerFaceActionPower

EMOSTATE_DLL_API float IS_FacialExpressionGetLowerFaceActionPower ( EmoStateHandle state )

Returns the detected lower face FacialExpression action power of the user.

Parameters

state - EmoStatehandle

Returns: power value (0.0 to 1.0)

See also: IS_FacialExpressionGetLowerFaceAction

EMOSTATE_DLL_API float IS_FacialExpressionGetSmileExtent ( EmoStateHandle state )

Returns the smile extent of the user (Obsolete function)

Parameters

state - EmoStatehandle

Returns: smile extent value (0.0 to 1.0)

See also: IS_FacialExpressionGetLowerFaceAction, IS_FacialExpressionGetLowerFaceActionPower

EMOSTATE_DLL_API IEE_FacialExpressionAlgo_t IS_FacialExpressionGetUpperFaceAction ( EmoStateHandle state )

Returns the detected upper face FacialExpression action of the user.

Parameters

state - EmoStatehandle

Returns: pre-defined FacialExpression action types

See also: IS_FacialExpressionGetUpperFaceActionPower

EMOSTATE_DLL_API float IS_FacialExpressionGetUpperFaceActionPower ( EmoStateHandle state )

Returns the detected upper face FacialExpression action power of the user.

Parameters

state - EmoStatehandle

Returns: power value (0.0 to 1.0)

See also: IS_FacialExpressionGetUpperFaceAction

EMOSTATE_DLL_API int IS_FacialExpressionIsActive	(	EmoStateHandle	state,
		IEE_FacialExpressionAlgo_t	type
	)

Query whether the signal is too noisy for FacialExpression detection to be active.

Parameters

state	- EmoStateHandle
type	- FacialExpression detection type

Returns: detection state (0: Not Active, 1: Active)

See also: IEE_FacialExpressionAlgo_t

EMOSTATE_DLL_API int IS_FacialExpressionIsBlink ( EmoStateHandle state )

Query whether the user is blinking at the time the EmoState is captured.

Parameters

state - EmoStateHandle

Returns: blink status (1: blink, 0: not blink)

EMOSTATE_DLL_API int IS_FacialExpressionIsEyesOpen ( EmoStateHandle state )

Query whether the eyes of the user are opened at the time the EmoState is captured.

Parameters

state - EmoStateHandle

Returns: eye open status (1: eyes open, 0: eyes closed)

EMOSTATE_DLL_API int IS_FacialExpressionIsLeftWink ( EmoStateHandle state )

Query whether the user is winking left at the time the EmoState is captured.

Parameters

state - EmoStateHandle

Returns: left wink status (1: wink, 0: not wink)

See also: IS_FacialExpressionIsRightWink

EMOSTATE_DLL_API int IS_FacialExpressionIsLookingDown ( EmoStateHandle state )

Query whether the user is looking down at the time the EmoState is captured.

Parameters

state - EmoStateHandle

Returns: eyes position (1: looking down, 0: not looking down)

See also: IS_FacialExpressionIsLookingUp

EMOSTATE_DLL_API int IS_FacialExpressionIsLookingLeft ( EmoStateHandle state )

Query whether the user is looking left at the time the EmoState is captured with EPOC/EPOC+ headset.

Remarks: Available with EPOC/EPOC+ headset.

Parameters

state - EmoStatehandle

Returns: eye position (1: looking left, 0: not looking left)

See also: IS_FacialExpressionIsLookingLeft

EMOSTATE_DLL_API int IS_FacialExpressionIsLookingRight ( EmoStateHandle state )

Query whether the user is looking right at the time the EmoState is captured with EPOC/EPOC+ headset.

Remarks: Available with EPOC/EPOC+ headset.

Parameters

state - EmoStatehandle

Returns: eye position (1: looking right, 0: not looking right)

See also: IS_FacialExpressionIsLookingRight

EMOSTATE_DLL_API int IS_FacialExpressionIsLookingUp ( EmoStateHandle state )

Query whether the user is looking up at the time the EmoState is captured.

Parameters

state - EmoStateHandle

Returns: eyes position (1: looking up, 0: not looking up)

See also: IS_FacialExpressionIsLookingDown

EMOSTATE_DLL_API int IS_FacialExpressionIsRightWink ( EmoStateHandle state )

Query whether the user is winking right at the time the EmoState is captured.

Parameters

state - EmoStateHandle

Returns: right wink status (1: wink, 0: not wink)

See also: IS_FacialExpressionIsLeftWink

EMOSTATE_DLL_API void IS_Free ( EmoStateHandle state )

Free EmoState handle.

NOTE: THIS FUNCTION HAS BEEN DEPRECATED - please use IEE_EmoStateFree instead.

Parameters

state - EmoStateHandle that was created by IS_Create function call

See also: IEE_EmoStateFree, IS_Create

EMOSTATE_DLL_API void IS_GetBatteryChargeLevel	(	EmoStateHandle	state,
		int *	chargeLevel,
		int *	maxChargeLevel
	)

Get the level of charge remaining in the headset battery.

Parameters

state	- EmoStateHandle
chargeLevel	- the current level of charge in the headset battery
maxChargeLevel	- the maximum level of charge in the battery

EMOSTATE_DLL_API IEE_EEG_ContactQuality_t IS_GetContactQuality	(	EmoStateHandle	state,
		IEE_InputChannels_t	electroIdx
	)

Query the contact quality of a specific EEG electrode.

Parameters

state	- EmoStateHandle
electroIdx	- The index of the electrode for query

Returns: IEE_EEG_ContactQuality_t - Enumerated value that characterizes the EEG electrode contact for the specified input channel

See also: IS_GetContactQuality

EMOSTATE_DLL_API int IS_GetContactQualityFromAllChannels	(	EmoStateHandle	state,
		IEE_EEG_ContactQuality_t *	contactQuality,
		size_t	numChannels
	)

Query the contact quality of all the electrodes in one single call.

The contact quality will be stored in the array, contactQuality, passed to the function. The value stored in contactQuality[0] is identical to the result returned by IS_GetContactQuality(state, 0) The value stored in contactQuality[1] is identical to the result returned by IS_GetContactQuality(state, 1). etc. The ordering of the array is consistent with the ordering of the logical input channels in IEE_InputChannels_enum.

Parameters

state	- EmoStateHandle
contactQuality	- array of 32-bit float of size numChannels
numChannels	- size (number of floats) of the input array

Returns: Number of signal quality values copied to the contactQuality array.

See also: IS_GetContactQualityFromAllChannels

EMOSTATE_DLL_API int IS_GetHeadsetOn ( EmoStateHandle state )

Return whether the headset has been put on correctly or not.

If the headset cannot not be detected on the head, then signal quality will not report any results for all the channels

Parameters

state - EmoStatehandle

Returns: int - (1: On, 0: Off)

EMOSTATE_DLL_API int IS_GetNumContactQualityChannels ( EmoStateHandle state )

Query the number of channels of available sensor contact quality data.

Parameters

state - EmoStateHandle

Returns: number of channels for which contact quality data is available (int)

See also: IS_GetNumContactQualityChannels

EMOSTATE_DLL_API float IS_GetTimeFromStart ( EmoStateHandle state )

Return the time since EmoEngine has been successfully connected to the headset.

If the headset is disconnected from EmoEngine due to low battery or weak wireless signal, the time will be reset to zero.

Parameters

state - EmoStateHandle

Returns: float - time in second

EMOSTATE_DLL_API IEE_SignalStrength_t IS_GetWirelessSignalStatus ( EmoStateHandle state )

Query of the current wireless signal strength.

Parameters

state - EmoStateHandle

Returns: wireless signal strength [No Signal, Bad, Fair, Good, Excellent].

See also: IEE_SignalStrength_t

EMOSTATE_DLL_API void IS_Init ( EmoStateHandle state )

Initialize the EmoState into neutral state.

Parameters

state - EmoStateHandle

See also: IS_Create, IS_Free

EMOSTATE_DLL_API int IS_MentalCommandEqual	(	EmoStateHandle	a,
		EmoStateHandle	b
	)

Check whether two states are with identical MentalCommand state.

Parameters

a	- EmoStateHandle
b	- EmoStateHandle

Returns: 1: Equal, 0: Different

See also: IS_PerformanceMetricEqual, IS_FacialExpressionEqual, IS_EmoEngineEqual, IS_Equal

EMOSTATE_DLL_API IEE_MentalCommandAction_t IS_MentalCommandGetCurrentAction ( EmoStateHandle state )

Returns the detected MentalCommand action of the user.

Parameters

state - EmoStateHandle

Returns: MentalCommand action type

See also: IEE_MentalCommandAction_t, IS_MentalCommandGetCurrentActionPower

EMOSTATE_DLL_API float IS_MentalCommandGetCurrentActionPower ( EmoStateHandle state )

Returns the detected MentalCommand action power of the user.

Parameters

state - EmoStateHandle

Returns: MentalCommand action power (0.0 to 1.0)

See also: IS_MentalCommandGetCurrentAction

EMOSTATE_DLL_API int IS_MentalCommandIsActive ( EmoStateHandle state )

Query whether the signal is too noisy for MentalCommand detection to be active.

Parameters

state - EmoStateHandle

Returns: detection state (0: Not Active, 1: Active)

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation