start_recording
Begin writing live EEG data to disk continuously. Start recording right after session begins to prevent data loss, since the ring buffer retains only about a minute of signal.
Instructions
Begin writing the live signal to disk, continuously.
Call this as soon as the session starts if you intend to keep the data. The ring buffer only holds the last minute or so, so anything not recorded is gone -- a session streamed for an hour without recording leaves nothing but whatever reports you exported.
The raw, unfiltered signal is written. Filter settings are stored alongside it so a filtered view is reproducible; the amplifier's actual output is not reconstructible from anything else.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| run | No | Run number within the task, e.g. '01'. | |
| name | No | Explicit filename stem, overriding the BIDS-style name built from subject/session/task/run. | |
| task | No | What the participant is doing, e.g. 'rest', 'motor-imagery'. | |
| notes | No | Free text kept with the recording. | |
| dataset | No | Study or collection name that groups recordings together. | |
| subject | No | Participant identifier, e.g. 'sub-04' or a study code. Becomes the subject row in the metadata store. Avoid direct identifiers. | |
| session_id | Yes | The running session to record. | |
| session_label | No | Visit or session label, e.g. '01' or 'baseline'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||