API
Overview
The DELTA SDK provides a C++ interface for connecting Delta series cameras, configuring the sensor, reading live event data, replaying saved files, generating frame-like outputs, and saving raw or rendered data.
Include the full public API with:
#include <delta/DELTA_SDK.hpp>
All public symbols are defined in the delta namespace.
API architecture
The image below shows the architecture of the DELTA SDK API
The DELTA SDK is divided into five main API modules. Each module owns one part of the data flow, from opening a Delta series camera or file to processing and saving the generated output.
| Module | Role | More detail |
|---|---|---|
DELTA_Device |
Handles USB connection and camera preparation before reading data from Delta series cameras. | DELTA_Device |
DELTA_LiveStream |
Controls live data flow from an opened Delta series camera into the SDK pipeline. | DELTA_LiveStream |
DELTA_Playback |
Provides recorded file input so saved data can be replayed through the SDK pipeline. | DELTA_Playback |
DELTA_Processing |
Converts live or playback input into application-ready event and frame outputs. | DELTA_Processing |
DELTA_Save |
Stores raw or generated SDK output for later use, review, or replay. | DELTA_Save |
DELTA_Status |
Provides shared status codes and readable error messages across SDK modules. | DELTA_Status |
| Source | Handle type | Open function |
|---|---|---|
| Live Streaming | DeviceHandle |
openDevice() |
| Recorded file | FileHandle |
openFile() |
| Either source | InputSource* |
Device or File handle |
DeviceHandle and FileHandle are semantic aliases of InputSource*. Device-only APIs should receive a DeviceHandle, file-only APIs should receive a FileHandle, and common processing APIs can receive either one.