getTrainedSignatureActions

This method returns the list of the trained actions of a profile. For each action, you also see how many times the user trained this action.

Parameters

Name

Type

Required

Description

cortexToken

string

yes

A token returned by authorize.

detection

string

yes

Must be "mentalCommand" or "facialExpression".

profile

string

no

The name of a profile.

session

string

no

A session id returned by createSession.

You must set one of these 2 parameters: profile or session. Read this for details.

If you set the session, then this method reads information from the profile that is currently loaded for the headset of this session.

If you set profile then this method reads information from the hard drive. The values you get can be different from reading from the session, especially if the profile was load, edited, and not saved yet.

Result

The result is an object containing these fields:

Name

Type

Description

trainedActions

array of objects

Contains 1 object for each trained action.

totalTimesTraining

number

The total number of training the user did since the creation of this profile.

The objects in trainedActions have 2 fields:

Name

Type

Description

action

string

The name of the action.

times

number

How many times the user trained this action.

Examples

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "getTrainedSignatureActions",
    "params": {
        "cortexToken": "xxx",
        "detection": "mentalCommand",
        "profile": "cortex-v2-example"
    }
}

Last updated