start_replay
Replay a recorded EEG session in real time to test pipelines against a live stream, complete with original annotations and event timings.
Instructions
Replay a recording against a wall clock, re-emitting its events.
This is the safe way to build a real-time pipeline: the session behaves exactly like a live stream -- same buffering, same chunked delivery, same tools -- so code developed here runs unchanged against hardware. The recording's annotations arrive in the event log at their original timings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| loop | No | Restart from the beginning on reaching the end, emitting a 'replay_loop' event each time. Good for long-running rehearsals. | |
| path | Yes | Absolute path, or a filename inside the configured recordings dir. | |
| board | No | Required only for BrainFlow CSV files. | |
| picks | No | MNE channel selection, e.g. 'eeg' or 'mag'. Defaults to EEG. | |
| speed | No | Playback rate. 1.0 is true recording rate; 2.0 is twice as fast; 0.5 is half. Faster-than-real-time is useful for testing a pipeline over a long recording, but stops being a realistic latency test. | |
| start_sec | No | Offset into the recording to begin from. | |
| session_id | Yes | Name you will pass to every later call for this session. | |
| use_stim_channel | No | Also extract events from a hardware trigger channel, not just annotations. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||