// api
← Back to homeOllo SDK Docs | 6:14 PM

// API Reference

This reference covers the core surface shared across all engine bindings. State is kept internal. All calls are thread-safe unless noted.


start(optional_model_path: const char* = nullptr) -> bool

Initializes SDK.

Auto-resolves model and camera if no path is provided.


stop() -> bool

Stops capture and processing threads.


get_last_error() -> int

Returns last fatal code from start().


get_version() -> const char*

SDK version string.


poll_blink_events()

Drains the queue and invokes your event handlers.
Call exactly once per frame.


Event Struct (engine-specific name varies)

timestamp_ms : uint64
intensity    : float    # 0.0–1.0
side         : int      # 0=both, 1=left, 2=right

Engine Plugins

Each engine integration maps these functions into native engine constructs:

  • Godot → signals + autoload singleton
  • Unity → events + C# wrapper
  • Unreal → Blueprint nodes + native C++ module

Notes

  • Inference runs on CPU by default
  • Capture and inference run on background threads
  • Thread-safe access to blink events
  • Avoid calling start()/stop() repeatedly mid-frame