Some methods of the API return one or more record objects, for example queryRecords.
Description
A record object includes these fields:
Name
Depending on how you get the record, it may contains an additional field for the markers:
syncStatus
Record object returned from getRecordInfos has an additional field syncStatus:
Available values for status:
"pending": the record is waiting for being downloaded.
"downloading": the record's data is being downloaded. Check progress in percent field.
"downloaded": the record's data is on both the Emotiv Cloud and the local machine.
For example:
A record is created but waiting for being uploaded to the Emotiv Cloud:
A record is waiting for downloaded from the Emotiv Cloud:
A record is created and is uploading to the Emotiv Cloud:
Examples
"notDownloaded": the record's data is on the Emotiv Cloud and not on the local machine.
"failedEncryption", "failedDownload": sync status of the record if fails.
"notUploaded": the record is not uploaded to the Emotiv Cloud yet.
"uploading": the record is being uploaded to the Emotiv Cloud. Check progress in percent field.
"uploaded": the record is on both the Emotiv Cloud and the local machine.
"failedAccessFile", "failedDecryption", "failedUpload": sync status of the record whose uploading fails. Cortex will try uploading again.
"neverUploaded": The record will never be uploaded to the Emotiv Cloud. The record is created with virtual headsets in this case.
Type
Description
uuid
string
The id of this record.
ownerId
string
The id of the user this record belongs to. It is a GUID, it is not the EmotivID of the user.
applicationId
string
The id of the application that created this record.
applicationVersion
string
The version of the application that created this record.
title
string
The title of this record.
description
string
The description of this record.
tags
array of strings
The tags associated to this record.
experimentId
number (integer)
The experiment id associated to this record.
startDatetime
string (ISO datetime)
When this record was created.
endDatetime
string (ISO datetime)
When this record was stopped.
licenseId
string
The id of the license used by this record.
licenseScope
array of strings
List of the data streams the license has access to.
The scope "eeg" gives access to the raw EEG data.
The scope "pm" gives access to the 2 hertz performance metrics.
subject
object
This object has a single field "subjectName".
It is the subject name used to create this record. You can use to get more information about the subject. If the record was created without a subject name, then the field "subjectName" contains the EmotivID of the user.
localOnly
boolean
If true then this record will not be uploaded to the EMOTIV cloud.
If false then it will be uploaded.
headbandPosition
string
If the headset is an EPOC X, then this field tells you the position of the headband of this headset during this record. Can be "back" or "top".
If the headset is not an EPOC X, then this field is null.
See for details.
This field was added in Cortex 2.4
Name
Type
Description
markers
array of objects
A list of . The markers added to this record.
Name
Type
Description
syncStatus
object
contain information of sync status (status field) and/or uploading/downloading progress (percent field).