Skip to content

C++ API reference

The full C++ core reference is generated with Doxygen from the public headers (core/include/mef3io), including the flat C ABI (c_api.h).

Browse the full C++ / C ABI reference →

For a task-oriented walkthrough — consuming the library with CMake, reading, writing, the error hierarchy, and the C ABI — see the C++ guide.

The key entry points:

  • mef3io::Reader — high-level windowed reads, segment map, TOC, records. Reads on one Reader may run from several threads at once (see the C++ guide for the limits).
  • mef3io::SessionWriter — high-level writes, in-segment append, records.
  • mef3io::Session — the lower-level session tree and indexed reads.
  • mef3io::inspect_session (inspect.hpp) — everything about a session without reading its samples. Not in the C ABI.
  • mef3io::validate_session / mef3io::repair_session (validate.hpp) and mef3io::recover_session (recover.hpp) — checking, repairing and recovering sessions (Validation).
  • mef3io::anonymize_session / mef3io::check_anonymize / mef3io::verify_anonymized (anonymize.hpp) — a de-identified copy with every time kept (the default) or shifted, every check it makes before writing (without writing), and its check against the source (De-identification). Refusals are thrown with the mef3io::AnonymizeError mixin carrying a stable code (Refusal codes). Not in the C ABI.
  • c_api.h — the flat extern "C" ABI the MATLAB MEX (and any FFI) builds on.