Cortex API
  • Getting Started
  • Connecting to the Cortex API
  • Overview of API flow
  • Authentication
    • getCortexInfo
    • getUserLogin
    • requestAccess
    • hasAccessRight
    • authorize
    • generateNewToken
    • getUserInformation
    • getLicenseInfo
  • Headsets
    • controlDevice
    • queryHeadsets
    • updateHeadset
    • updateHeadsetCustomInfo
    • syncWithHeadsetClock
    • Headset object
  • Sessions
    • createSession
    • updateSession
    • querySessions
    • Session object
  • Data Subscription
    • subscribe
    • unsubscribe
    • Data sample object
  • Records
    • createRecord
    • stopRecord
    • updateRecord
    • deleteRecord
    • exportRecord
    • queryRecords
    • getRecordInfos
    • configOptOut
    • requestToDownloadRecordData
    • Record object
  • Markers
    • injectMarker
    • updateMarker
    • Marker object
  • Subjects
    • createSubject
    • updateSubject
    • deleteSubjects
    • querySubjects
    • getDemographicAttributes
    • Subject object
  • BCI
    • queryProfile
    • getCurrentProfile
    • setupProfile
    • loadGuestProfile
    • getDetectionInfo
    • training
    • Readonly profile
  • Advanced BCI
    • getTrainedSignatureActions
    • getTrainingTime
    • facialExpressionSignatureType
    • facialExpressionThreshold
    • mentalCommandActiveAction
    • mentalCommandBrainMap
    • mentalCommandGetSkillRating
    • mentalCommandTrainingThreshold
    • mentalCommandActionSensitivity
  • Warning Objects
  • Error Codes
  • Troubleshooting Guide
  • Release Notes
  • cortexaccess tool
Powered by GitBook
On this page
  • Parameters
  • Result
  • Examples
  • Mental command
  • Facial expression
  1. BCI

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

events

array of strings

signature

array of strings

Examples

Mental command

{
    "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

{
    "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"
        ]
    }
}
PreviousloadGuestProfileNexttraining

Last updated 1 year ago

The list of the status you can use when you call the method.

The events you can receive in the "sys" when you train this detection.

The different types of signature that you can get or set with .

training
data stream
facialExpressionSignatureType