start_stream
Begin EEG acquisition by opening a board and starting background buffering into a ring buffer, so subsequent read_window calls retrieve buffered samples until stop_stream ends the session.
Instructions
Open a board and begin buffering EEG in the background.
Data flows into a ring buffer from a background thread as soon as this returns, so a subsequent read_window will have samples waiting. The session keeps running until stop_stream is called.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| board | No | Board name ('synthetic', 'cyton', 'muse_2', ...) or numeric id. Call list_boards to see the options. | synthetic |
| params | No | BrainFlow connection settings, e.g. {"serial_port": "COM3"} for a Cyton, {"mac_address": "..."} for a Muse, or {"file": "rec.csv", "master_board": "cyton"} for PLAYBACK_FILE_BOARD. | |
| channels | No | Optional subset of BrainFlow EEG row indices. Defaults to all. | |
| session_id | Yes | Name you will pass to every later call for this stream. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||