arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

updateHeadsetCustomInfo

This method lets you set the headband position of an EPOC X headset.

The headband position is important to interpret the motion data coming from the headset. The motion sensor is located in the headband. So Cortex uses the headband position to know the orientation of the motion sensor.

When you start a record Cortex saves the current headband position into the record. So you should set the position before starting the record.

This method was added in Cortex 2.4

hashtag
Parameters

hashtag
Result

The result is an object containing these fields:

hashtag
Examples

yes

Must be "back" or "top".

Name

Type

Required

Description

cortexToken

string

yes

A token returned by authorize.

headsetId

string

yes

A headset id returned by queryHeadsets.

headbandPosition

Name

Type

Description

headsetId

string

The headset id used in the request.

customName

string

The custom name of the headset.

headbandPosition

string

The position of the headband. Can be "back" or "top".

string

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "updateHeadsetCustomInfo",
  "params": {
    "cortexToken": "xxx",
    "headbandPosition": "top",
    "headsetId": "EPOCX-12345678"
  }
}
{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "customName": "Epoc 1",
    "headbandPosition": "top",
    "headsetId": "EPOCX-12345678",
    "message": "Update headset customized information successfully."
  }
}