Skip to main content

Module types

Module types 

Source
Expand description

FFI types matching cmn_type.h from the NeuroSDK2 C API.

These are #[repr(C)] structs and enums that are ABI-compatible with the neurosdk2 shared library on Windows, Linux, and macOS.

Structs§

BrainBit2AmplifierParam
BrainBit2 amplifier parameters.
BrainBitResistData
BrainBit (original) 4-channel resistance data.
BrainBitSignalData
BrainBit (original) 4-channel EEG signal sample.
CallibriEnvelopeData
Callibri envelope data.
CallibriMotionAssistantParams
Callibri motion assistant parameters.
CallibriMotionCounterParam
Callibri motion counter parameters.
CallibriRespirationData
Callibri respiration data.
CallibriSignalData
Callibri signal data.
CallibriStimulationParams
Callibri stimulation parameters.
CallibriStimulatorMAState
Callibri stimulator + motion assistant state.
EEGChannelInfo
EEG channel information.
FPGData
FPG (photoplethysmography) data sample.
HeadbandResistData
Headband 4-channel resistance data.
HeadbandSignalData
Headband 4-channel signal data.
Headphones2AmplifierParam
Headphones2 amplifier parameters.
Headphones2ResistData
Headphones2 4-channel resistance data.
Headphones2SignalData
Headphones2 4-channel signal data.
HeadphonesAmplifierParam
Headphones (v1) amplifier parameters.
HeadphonesResistData
Headphones (v1) 7-channel resistance data.
HeadphonesSignalData
Headphones (v1) 7-channel signal data.
MEMSData
MEMS (accelerometer + gyroscope) data sample.
NeuroEEGAmplifierParam
NeuroEEG amplifier parameters.
NeuroEEGFSStatus
NeuroEEG filesystem composite status.
OpStatus
Status returned by most SDK functions.
ParameterInfo
Parameter information.
QuaternionData
Quaternion data (MEMS orientation).
ResistChannelsData
NeuroEEG resistance data (with A1, A2, Bias).
ResistRefChannelsData
Multi-channel resistance data with referents.
SensorDiskInfo
Disk information.
SensorFileData
File data (for read/write operations).
SensorFileInfo
File information on the NeuroEEG filesystem.
SensorInfo
Discovered device information (from scanner).
SensorVersion
Firmware/hardware version information.
SignalChannelsData
Multi-channel signal data (BrainBit2, NeuroEEG, etc.).
SmartBandAmplifierParam
SmartBand amplifier parameters.
StimulPhase
Stimulation phase parameters.

Enums§

BrainBit2ChannelMode
BrainBit2 channel mode.
CallibriColorType
Callibri device colour.
CallibriElectrodeState
Callibri electrode state.
CallibriMotionAssistantLimb
Callibri motion assistant limb.
CallibriStimulatorState
Callibri stimulator state.
EEGChannelId
EEG channel identifiers (10-20 system).
EEGChannelMode
EEG channel mode (NeuroEEG).
EEGChannelType
EEG channel type.
EEGRefMode
EEG reference mode (NeuroEEG).
GenCurrent
Generator current.
IrAmplitude
IR amplitude for FPG.
RedAmplitude
Red amplitude for FPG.
SensorADCInput
ADC input mode.
SensorAccelerometerSensitivity
Accelerometer sensitivity.
SensorAmpMode
Amplifier mode.
SensorCommand
Commands that can be sent to a sensor.
SensorDataOffset
Data offset settings.
SensorExternalSwitchInput
External switch input.
SensorFSIOStatus
NeuroEEG filesystem I/O status.
SensorFSStatus
NeuroEEG filesystem status.
SensorFSStreamStatus
NeuroEEG filesystem stream status.
SensorFamily
Device family used for scanner filtering and identification.
SensorFeature
Sensor feature capabilities.
SensorFilter
Hardware filter presets.
SensorFirmwareMode
Firmware mode.
SensorGain
Signal gain settings.
SensorGyroscopeSensitivity
Gyroscope sensitivity.
SensorParamAccess
Parameter access mode.
SensorParameter
Sensor parameter identifiers.
SensorSamplingFrequency
Sampling frequency presets.
SensorState
Connection state.
SensorStimulMode
Stimulation mode.
SensorStimulSyncState
Stimulation sync state.
SignalTypeCallibri
Callibri signal type.

Constants§

BRAINBIT2_MAX_CH_COUNT
ERR_MSG_LEN
FILE_NAME_MAX_LEN
NEURO_EEG_MAX_CH_COUNT
SENSOR_ADR_LEN
SENSOR_CHANNEL_NAME_LEN
SENSOR_NAME_LEN
SENSOR_SN_LEN
SMART_BAND_MAX_CH_COUNT

Type Aliases§

AmpModeListenerHandle
BattPowerListenerHandle
BattVoltageListenerHandle
BrainBit2ResistDataListenerHandle
BrainBit2SignalDataListenerHandle
BrainBitResistDataListenerHandle
BrainBitSignalDataListenerHandle
CallibriElectrodeStateListenerHandle
CallibriEnvelopeDataListenerHandle
CallibriRespirationDataListenerHandle
CallibriSignalDataListenerHandle
FPGDataListenerHandle
HeadbandResistDataListenerHandle
HeadbandSignalDataListenerHandle
Headphones2ResistDataListenerHandle
Headphones2SignalDataListenerHandle
HeadphonesResistDataListenerHandle
HeadphonesSignalDataListenerHandle
MEMSDataListenerHandle
NeuroEEGFileStreamDataListenerHandle
NeuroEEGResistDataListenerHandle
NeuroEEGSignalDataListenerHandle
NeuroEEGSignalProcessParam
NeuroEEGSignalRawDataListenerHandle
NeuroEEGSignalResistDataListenerHandle
PhotoStimulSyncStateListenerHandle
QuaternionDataListenerHandle
Sensor
Opaque sensor/device handle (pointer to C struct).
SensorScanner
Opaque scanner handle (pointer to C struct).
SensorStateListenerHandle
SensorsListenerHandle
StimulModeListenerHandle