MentalCommandDetection.h
Go to the documentation of this file.
1 
11 
13 #ifndef MENTALCOMMANDDETECTION_H
14 #define MENTALCOMMANDDETECTION_H
15 
16 #ifdef __cplusplus
17 extern "C"
18 {
19 #endif
20 
21 #if (!EDK_STATIC_LIB)
22 # ifdef EDK_EXPORTS
23 # ifdef _WIN32
24 # define EDK_API __declspec(dllexport)
25 # else
26 # if (defined __GNUC__ && __GNUC__ >= 4) || defined __INTEL_COMPILER || defined __clang__
27 # define EDK_API __attribute__ ((visibility("default")))
28 # else
29 # define EDK_API
30 # endif
31 # endif
32 # else
33 # ifdef _WIN32
34 # define EDK_API __declspec(dllimport)
35 # else
36 # define EDK_API
37 # endif
38 # endif
39 #else
40 # define EDK_API extern
41 #endif
42 
43 #include "IEmoStateDLL.h"
44 
46 
49  typedef void* EmoEngineEventHandle;
50 
51 
54  MC_NONE = 0,
61 
62 
76 
77 
79 
86  EDK_API IEE_MentalCommandEvent_t
87  IEE_MentalCommandEventGetType(EmoEngineEventHandle hEvent);
88 
89 
91 
100  EDK_API int
101  IEE_MentalCommandSetActiveActions(unsigned int userId,
102  unsigned long activeActions);
103 
104 
106 
115  EDK_API int
116  IEE_MentalCommandGetActiveActions(unsigned int userId,
117  unsigned long* pActiveActionsOut);
118 
119 
121 
130  EDK_API int
131  IEE_MentalCommandGetTrainingTime(unsigned int userId,
132  unsigned int* pTrainingTimeOut);
133 
134 
136 
145  EDK_API int
146  IEE_MentalCommandSetTrainingControl(unsigned int userId,
147  IEE_MentalCommandTrainingControl_t control);
148 
149 
151 
160  EDK_API int
161  IEE_MentalCommandSetTrainingAction(unsigned int userId,
163 
164 
166 
175  EDK_API int
176  IEE_MentalCommandGetTrainingAction(unsigned int userId,
177  IEE_MentalCommandAction_t* pActionOut);
178 
179 
181 
192  EDK_API int
194  unsigned long* pTrainedActionsOut);
195 
196 
198 
209  EDK_API int
210  IEE_MentalCommandGetOverallSkillRating(unsigned int userId,
211  float* pOverallSkillRatingOut);
212 
213 
215 
227  EDK_API int
228  IEE_MentalCommandGetActionSkillRating(unsigned int userId,
230  float* pActionSkillRatingOut);
231 
232 
234 
243  EDK_API int
244  IEE_MentalCommandSetActivationLevel(unsigned int userId,
245  int level);
246 
247 
249 
261  EDK_API int
262  IEE_MentalCommandSetActionSensitivity(unsigned int userId,
263  int action1Sensitivity,
264  int action2Sensitivity,
265  int action3Sensitivity,
266  int action4Sensitivity);
267 
268 
270 
279  EDK_API int
280  IEE_MentalCommandGetActivationLevel(unsigned int userId,
281  int *pLevelOut);
282 
283 
285 
297  EDK_API int
298  IEE_MentalCommandGetActionSensitivity(unsigned int userId,
299  int* pAction1SensitivityOut,
300  int* pAction2SensitivityOut,
301  int* pAction3SensitivityOut,
302  int* pAction4SensitivityOut);
303 
304 
306 
314  EDK_API int
315  IEE_MentalCommandStartSamplingNeutral(unsigned int userId);
316 
317 
319 
327  EDK_API int
328  IEE_MentalCommandStopSamplingNeutral(unsigned int userId);
329 
330 
332 
344  EDK_API int
345  IEE_MentalCommandSetSignatureCaching(unsigned int userId,
346  unsigned int enabled);
347 
348 
350 
359  EDK_API int
360  IEE_MentalCommandGetSignatureCaching(unsigned int userId,
361  unsigned int* pEnabledOut);
362 
363 
365 
374  EDK_API int
375  IEE_MentalCommandSetSignatureCacheSize(unsigned int userId,
376  unsigned int size);
377 
378 
380 
389  EDK_API int
390  IEE_MentalCommandGetSignatureCacheSize(unsigned int userId,
391  unsigned int* pSizeOut);
392 #ifdef __cplusplus
393 }
394 #endif
395 
396 #endif // MENTALCOMMANDDETECTION_H
No action.
Definition: MentalCommandDetection.h:54
EDK_API int IEE_MentalCommandGetActionSkillRating(unsigned int userId, IEE_MentalCommandAction_t action, float *pActionSkillRatingOut)
Get the current skill rating for particular MentalCommand actions of the user.
EDK_API int IEE_MentalCommandStartSamplingNeutral(unsigned int userId)
Start the sampling of Neutral state in MentalCommand.
EDK_API int IEE_MentalCommandGetSignatureCaching(unsigned int userId, unsigned int *pEnabledOut)
Query the status of signature caching in MentalCommand.
The training is succeeded, waiting for MC_ACCEPT or MC_REJECT.
Definition: MentalCommandDetection.h:67
EDK_API int IEE_MentalCommandGetActiveActions(unsigned int userId, unsigned long *pActiveActionsOut)
Get the current MentalCommand active action types.
The training has begun after MC_START is sent.
Definition: MentalCommandDetection.h:66
EDK_API int IEE_MentalCommandSetTrainingAction(unsigned int userId, IEE_MentalCommandAction_t action)
Set the type of MentalCommand action to be trained.
Start a new training.
Definition: MentalCommandDetection.h:55
The mental command signature has been updated for new actions.
Definition: MentalCommandDetection.h:74
EDK_API int IEE_MentalCommandGetSignatureCacheSize(unsigned int userId, unsigned int *pSizeOut)
Get the current cache size for the signature caching in MentalCommand.
enum IEE_MentalCommandAction_enum IEE_MentalCommandAction_t
MentalCommand action type enumerator.
enum IEE_MentalCommandTrainingControl_enum IEE_MentalCommandTrainingControl_t
MentalCommand Suite training control enumerator.
IEE_MentalCommandTrainingControl_enum
MentalCommand Suite training control enumerator.
Definition: MentalCommandDetection.h:53
EDK_API int IEE_MentalCommandGetTrainingAction(unsigned int userId, IEE_MentalCommandAction_t *pActionOut)
Get the type of MentalCommand action currently selected for training.
The training has been reset after MC_RESET is sent.
Definition: MentalCommandDetection.h:72
Reset current training.
Definition: MentalCommandDetection.h:59
Reject current training.
Definition: MentalCommandDetection.h:57
The training is failed due to signal issues. Please restart training.
Definition: MentalCommandDetection.h:68
EDK_API int IEE_MentalCommandSetSignatureCaching(unsigned int userId, unsigned int enabled)
Enable or disable signature caching in MentalCommand.
EDK_API int IEE_MentalCommandGetTrainedSignatureActions(unsigned int userId, unsigned long *pTrainedActionsOut)
Get a list of the actions that have been trained by the user.
void * EmoEngineEventHandle
Handle to EmoEngine event structure allocated by IEE_EmoEngineEventCreate.
Definition: MentalCommandDetection.h:49
EDK_API int IEE_MentalCommandGetTrainingTime(unsigned int userId, unsigned int *pTrainingTimeOut)
Return the duration of a MentalCommand training session.
EDK_API int IEE_MentalCommandStopSamplingNeutral(unsigned int userId)
Stop the sampling of Neutral state in MentalCommand.
No new event.
Definition: MentalCommandDetection.h:65
EDK_API int IEE_MentalCommandGetActivationLevel(unsigned int userId, int *pLevelOut)
Get the overall sensitivity for all MentalCommand actions.
The training data for a particular action has been erased by MC_ERASE.
Definition: MentalCommandDetection.h:70
The neutral training is completed.
Definition: MentalCommandDetection.h:73
Erase training data for an action.
Definition: MentalCommandDetection.h:58
The training is completed after MC_ACCEPT is sent.
Definition: MentalCommandDetection.h:69
EDK_API int IEE_MentalCommandSetSignatureCacheSize(unsigned int userId, unsigned int size)
Set the cache size for the signature caching in MentalCommand.
EDK_API int IEE_MentalCommandSetTrainingControl(unsigned int userId, IEE_MentalCommandTrainingControl_t control)
Set the training control flag for MentalCommand training.
#define EDK_API
Definition: MentalCommandDetection.h:36
EDK_API int IEE_MentalCommandGetActionSensitivity(unsigned int userId, int *pAction1SensitivityOut, int *pAction2SensitivityOut, int *pAction3SensitivityOut, int *pAction4SensitivityOut)
Query the sensitivity of MentalCommand actions.
EDK_API int IEE_MentalCommandSetActionSensitivity(unsigned int userId, int action1Sensitivity, int action2Sensitivity, int action3Sensitivity, int action4Sensitivity)
Set the sensitivity of MentalCommand actions.
IEE_MentalCommandEvent_enum
MentalCommand event types.
Definition: MentalCommandDetection.h:64
EDK_API int IEE_MentalCommandGetOverallSkillRating(unsigned int userId, float *pOverallSkillRatingOut)
Get the current overall skill rating of the user in MentalCommand.
EDK_API int IEE_MentalCommandSetActivationLevel(unsigned int userId, int level)
Set the overall sensitivity for all MentalCommand actions.
Accept current training.
Definition: MentalCommandDetection.h:56
EDK_API int IEE_MentalCommandSetActiveActions(unsigned int userId, unsigned long activeActions)
Set the current MentalCommand active action types.
EDK_API IEE_MentalCommandEvent_t IEE_MentalCommandEventGetType(EmoEngineEventHandle hEvent)
Return the MentalCommand-specific event type.
enum IEE_MentalCommandEvent_enum IEE_MentalCommandEvent_t
MentalCommand event types.
The training is rejected after MC_REJECT is sent.
Definition: MentalCommandDetection.h:71