arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

requestToDownloadRecordData

This method is to ask Cortex to download the EEG/motion/CQ/detections data of a record from the EMOTIV cloud.

hashtag
Use case

Suppose that the user has installed Cortex on 2 computers, named computer A and computer B. On computer A, the user creates a record, and Cortex uploads this record to the EMOTIV cloud.

Then, on computer B, Cortex automatically downloads the metadata of this record, ie its name, description, start time, end time, etc... So this record is visible when you call methods like queryRecord or getRecordInfos.

But Cortex doesn't automatically download the actual data of the record, ie the EEG, motion, CQ, the results of the detections, etc... So you cannot this record. To download the actual data, you must call the method "requestToDownloadRecordData".

hashtag
Parameters

Name
Type
Required
Description

hashtag
Result

The result is an object with 2 fields:

Name
Type
Description

Each object in the success array include these fields:

Name
Type
Description

Each object in the failure array include these fields:

Name
Type
Description

hashtag
Example

cortexToken

string

yes

A token returned by .

recordIds

array of strings

yes

A list of record ids.

success

array of objects

List of the records that Cortex will start to download.

failure

array of objects

List of the records that Cortex will not download.

recordId

string

The id of a record that was added to the Cortex download queue.

Cortex will now start the download.

recordId

string

The id of a record that Cortex cannot download.

code

number

The error code for this record.

message

string

The error message for this record.

export
{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "requestToDownloadRecordData",
  "params": {
    "cortexToken": "xxx",
    "recordIds": [
        "33a9aa44-5a90-4881-8613-78493752b86d", 
        "3a4b7eb0-3b6c-4e16-a480-cbda8181f092"
      ]
  }
}
{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "failure": [{
      "code": -32186,
      "message": "The record already exists.",
      "recordId": "33a9aa44-5a90-4881-8613-78493752b86d"
    }],
    "success": [{
      "recordId": "3a4b7eb0-3b6c-4e16-a480-cbda8181f092"
    }]
  }
}
authorize