API reference

Auto-generated from docstrings via mkdocstrings. Pick the part of the library you're working with — or, for a signatures-only lookup, use the API cheatsheet.

• Core

  ---

  App lifecycle, shared context, streams, layout, and event helpers.

  App · Stream · Context

  Core API

• Control standard

  ---

  Declare what an app controls by name; a Target drives it.

  Target · Capability · ControlBus · load_control_map

  Control standard

• Keyboard

  ---

  Press keys when a control is active — a target that is not a hand.

  KeyboardTarget · keyboard_capabilities

  Keyboard

• Sources

  ---

  Live devices, LSL inlets, serial transports, or recorded replays.

  LSLSource · ReplaySource

  Sources API

• Outlets

  ---

  Publish a vector to a downstream consumer at a steady rate. To drive something, see Target.

  LSLOutlet

  Outlets API

• Bridges

  ---

  Subprocess acquisition for heavy data that doesn't fit the LSL pull model.

  WebCamBridge · CustomBridge

  Bridges API

• ML pipeline

  ---

  Train / predict hooks, pipeline state, and model persistence.

  Pipeline · save_pickle

  ML API

• Widgets

  ---

  Every public widget: viewers, plots, recording, training, status.

  SignalViewer · RecordingControls

  Widgets API

• Models

  ---

  Constructor recipes for CatBoost / scikit-learn estimators.

  catboost_classifier · sklearn_classifier

  Models API

• Session

  ---

  Read back recorded sessions: labeled / aligned windows, raw store.

  open_session_store · iter_labeled_windows

  Session API

• Filters

  ---

  Output-side smoothing for prediction control vectors.

  OneEuroFilter · GaussianFilter

  Filters API