API Reference

This section is generated from the inline MATLAB help in the public ba_*.m wrapper files.

Setup And Lifecycle

• ba_setup Add MATLAB paths and validate the BrainAccess MEX gateway.

• ba_init Initialize the BrainAccess native MEX runtime.

• ba_status Return BrainAccess MEX runtime status.

• ba_close Close the BrainAccess native MEX runtime.

Discovery And Connection

• ba_scan Scan for nearby BrainAccess devices.

• ba_connect Connect to a BrainAccess device by Bluetooth name.

• ba_disconnect Disconnect the active BrainAccess device.

• ba_is_connected Return true when a device connection is active.

• ba_get_device_info Return static information about the connected device.

• ba_get_device_features Return capabilities of the connected device.

• ba_get_battery_info Return battery information for the connected device.

Configuration

• ba_set_channel_enabled Enable or disable a stream channel.

• ba_set_channel_gain Set channel gain using a multiplier or SDK gain value.

• ba_set_channel_bias Configure bias polarity for a channel.

• ba_set_sample_rate Set the device sample rate in Hz.

• ba_load_config Apply current stream configuration to the device.

• ba_configure_eeg Apply a simple EEG acquisition configuration.

Streaming

• ba_start_stream Start streaming and attach the native chunk buffer.

• ba_read_chunk Read buffered stream data from the active backend.

• ba_collect_seconds Collect stream data for a bounded wall-clock duration.

• ba_stop_stream Stop streaming and clear the native chunk buffer.

• ba_is_streaming Return true when the device is streaming.

Annotations

• ba_annotate Add a text annotation to the active device session.

• ba_get_annotations Return annotation texts and timestamps.

• ba_clear_annotations Clear stored annotations from the active session.