getDetectionInfo

This method returns useful information about the mental command training or the facial expression training.
Parameters
Name
Type
Required
Description
detection
string
yes
Must be "mentalCommand" or "facialExpression".
Result
The result is an object containing information about the detection you specified in the parameters.
Name
Type
Description
actions
array of strings
The actions that this detection can detect.
controls
array of strings
The list of the status you can use when you call the training method.
events
array of strings
The events you can receive in the "sys" data stream when you train this detection.
signature
array of strings
The different types of signature that you can get or set with facialExpressionSignatureType.
Examples
Mental command
Request
Response
{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "getDetectionInfo",
    "params": {
        "detection": "mentalCommand"
    }
}
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "actions": [
            "neutral",
            "push",
            "pull",
            "lift",
            "drop",
            "left",
            "right",
            "rotateLeft",
            "rotateRight",
            "rotateClockwise",
            "rotateCounterClockwise",
            "rotateForwards",
            "rotateReverse",
            "disappear"
        ],
        "controls": [
            "start",
            "accept",
            "reject",
            "erase",
            "reset"
        ],
        "events": [
            "MC_Started",
            "MC_Succeeded",
            "MC_Failed",
            "MC_Completed",
            "MC_DataErased",
            "MC_Rejected",
            "MC_Reset",
            "MC_AutoSamplingNeutralCompleted",
            "MC_SignatureUpdated"
        ],
        "signature": []
    }
}
Facial expression
Request
Response
{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "getDetectionInfo",
    "params": {
        "detection": "facialExpression"
    }
}
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "actions": [
            "neutral",
            "blink",
            "winkL",
            "winkR",
            "horiEye",
            "surprise",
            "frown",
            "smile",
            "clench",
            "laugh",
            "smirkLeft",
            "smirkRight"
        ],
        "controls": [
            "start",
            "accept",
            "reject",
            "erase",
            "reset"
        ],
        "events": [
            "FE_Started",
            "FE_Succeeded",
            "FE_Failed",
            "FE_Completed",
            "FE_DataErased",
            "FE_Rejected",
            "FE_Reset"
        ],
        "signature": [
            "universal",
            "trained"
        ]
    }
}

loadGuestProfile

training

Last modified 3yr ago

Name	Type	Required	Description
detection	`string`	yes	Must be "mentalCommand" or "facialExpression".