eSDK Pro API Reference

Use this reference to identify which APIs to call, when to use them, and why. For full signatures, overloads, enums, and members, follow the Doxygen links.

Modules

• Core API — System, Server, Pipeline, ports, PTP sync, global logging.
• Camera API — camera lifecycle + typed camera parameters.
• Processing API — tasks, frames, task parameters, FlexTrans (Linux).
• Plugin API — custom processing via Plugin::TaskWorker, plugin ports/params.
• Support API — ESdkProException, ErrorCode, LogLevel, version constants.

‍

Typical flow

1. Create a System.
2. Connect a Server.
3. Discover and add Cameras; set parameters.
4. Build a Pipeline of Tasks (and plugins).
5. Start, monitor, stop; handle exceptions.

‍

Doxygen entry point: class index (link → annotated.html).

‍

Core API

Manages systems, servers, pipelines, and synchronization between components. Also provides basic configuration and logging utilities.

Common Tasks

‍

Key Classes and Functions

• System — creates and manages servers and pipelines. Used as the main entry point for initializing and shutting down SDK components.
• Server — discovers, connects, and manages camera devices on the network.
• Pipeline — builds and runs processing graphs that connect cameras, tasks, and plugins.
  Supports Precision Time Protocol (PTP) synchronization through SetPtpSyncMode(bool enable), which aligns timestamps across multiple servers and cameras.
• Ports — represents task input and output connections that define data flow within the pipeline.
• LogLevel — defines SDK logging verbosity (Off, Error, Warning, Info, Debug).
• SetLogLevel(LogLevel level) — free function that sets SDK-wide logging verbosity. Not a System method; call it early in program initialization.

‍

Usage Notes

• Create one System instance per process.
• Configure tasks and connections before starting the pipeline.
• Enable PTP only when required for multi-camera or multi-server synchronization.
• Call SetLogLevel() before initialization to ensure consistent verbosity across logs.

‍

Example

System sys = System::Create();
Server srv = sys.ConnectServer("127.0.0.1");

auto infos = srv.DiscoverCameras();
Camera cam = srv.AddCamera(infos.front());

Pipeline pipe = sys.GetPipeline();
CameraTask camTask = pipe.CreateCameraTask(cam);
RawSavingTask rawTask = pipe.CreateRawSavingTask(srv, "/data/out");
pipe.ConnectTasks(camTask.GetOutput(), rawTask.GetInput());

SetLogLevel(LogLevel::Info);
pipe.SetPtpSyncMode(true);
pipe.Start();
// ...
pipe.Stop();

‍

Camera API

Controls camera lifecycle and typed parameters for exposure, gain, and other adjustable values.

Common Tasks

‍

Key Classes and Functions

• Camera — represents a single camera (link → classeSdkPro_1_1Camera.html)
• UInt32CameraParam / Int32CameraParam / FloatCameraParam / BoolCameraParam / EnumCameraParam / StringCameraParam — typed parameter interfaces (link → parameter pages)
• CameraDiscoveryInfo — metadata from camera discovery (link → discovery page)

‍

Usage Notes

• Set parameters before starting the stream.
• Use GetRange() to validate values.
• Observe parameter units (e.g., exposure in microseconds).

‍

Example

auto exp = cam.GetParameter<UInt32CameraParam>("Exposure"); // µs
auto [minExp, maxExp, step] = exp.GetRange();
uint32_t desired = 5000;
uint32_t clamped = std::max(minExp, std::min(maxExp, desired - (desired % std::max(step, 1u))));
exp.SetValue(clamped);

cam.StartStreaming();
// ...
cam.StopStreaming();

‍

Processing API

Builds a graph of tasks that process frames through the pipeline. Supports zero-copy FlexTrans connectors on Linux.

Common Tasks

‍

Key Classes and Functions

• Task — base class for processing nodes (CameraTask, NvencTask, RawSavingTask) (link → task pages)
• Frame — container for image data and metadata (link → classeSdkPro_1_1Frame.html)
• TaskParam<T> — typed parameter interface (link → task parameter pages)
• Pipeline::ConnectTasksFlexTrans(...) — zero-copy linking (Linux only) (link → classeSdkPro_1_1Pipeline.html)

‍

Usage Notes

• Create and connect tasks before starting.
• Delete a task before rebuilding the graph.
• Some parameters cannot change at runtime.
• Use FlexTrans for GPU↔GPU or NIC↔NIC transfers on supported hardware.

‍

Example

CameraTask camTask = pipe.CreateCameraTask(cam);
NvencTask encTask = pipe.CreateNvencTask(srv /*, codec/bitrate/etc. */);
RawSavingTask rawTask = pipe.CreateRawSavingTask(srv, "/data/out");

pipe.ConnectTasks(camTask.GetOutput(), encTask.GetInput());
pipe.ConnectTasks(camTask.GetOutput(), rawTask.GetInput());

// Linux zero-copy variants:
// pipe.ConnectTasksFlexTrans(camTask.GetOutput(), encTask.GetInput());
// pipe.ConnectTasksFlexTrans(camTask.GetOutput(), "192.168.10.11", rawTask.GetInput(), "192.168.10.12");

pipe.Start();
// ...
pipe.Stop();

‍

Plugin API

Enables custom processing through user-defined plugins. Implement a Plugin::TaskWorker, define ports, and expose optional parameters.

Common Tasks

‍

Key Classes and Functions

• Plugin::TaskWorker — base class for custom processing nodes (link → classeSdkPro_1_1Plugin_1_1TaskWorker.html)
• FrameInput / FrameOutput — plugin ports for data exchange (link → plugin port pages)
• TaskParam<T> — plugin-side parameter interface (link → plugin task param pages)

‍

Usage Notes

• Create ports in the constructor.
• Keep Process() non-blocking and fast.
• Match HWPlatform between tasks to avoid unnecessary copies.
• Validate parameters at startup and document thread safety.

‍

Example

class CustomTask : public Plugin::TaskWorker {
public:
    static inline const std::string c_name{"CustomTask"};
    static inline const std::string c_in{"InputFrame"};
    static inline const std::string c_out{"OutputFrame"};

    CustomTask() {
        SetName(c_name);
        in_  = CreateFrameInput(c_in,  HWPlatform::Host);
        out_ = CreateFrameOutput(c_out, HWPlatform::Host);
    }

    bool Process() override {
        auto frame = in_.GetFrame();
        if (!frame.IsValid()) return false;
        // ... processing ...
        out_.Push(frame);
        return true;
    }
private:
    Plugin::FrameInput  in_{};
    Plugin::FrameOutput out_{};
};

‍

Support API

Provides diagnostics, exceptions, logging, and version information.

Common Tasks

‍

Key Classes and Functions

• ESdkProException — exception type thrown by SDK operations; retrieve reason codes with GetErrorCode().
• ErrorCode — defines SDK error results: Success, General, NotFound, Invalid.
• LogLevel — defines log output verbosity: Off, Error, Warning, Info, Debug.
• SetLogLevel(LogLevel level) — free function that adjusts SDK-wide log verbosity. Should be called early in program execution.
• Version Constants — compile-time identifiers for the SDK version:
  • c_eSdkProVersionStr = "1.3.0"
  • c_eSdkProVersionMajor = 1
  • c_eSdkProVersionMinor = 3

‍

Usage Notes

• Call SetLogLevel() early in main().
• Catch ESdkProException at critical boundaries.
• Include c_eSdkProVersionStr in support logs to match builds.

‍

Example

SetLogLevel(LogLevel::Info);
try {
    System sys = System::Create();
    sys.GetPipeline().Start();
    // ...
    sys.GetPipeline().Stop();
} catch (const ESdkProException& ex) {
    auto code = ex.GetErrorCode(); // ErrorCode::{Success,General,NotFound,Invalid}
    // log/report
}

‍

See Also

• eSDK Pro Programmer’s Guide Overview — Introduction, use cases, and key concepts.
• eSDK Pro System Architecture — Core components and plugin model.
• Using eSDK Pro Examples — Sample code projects included with the installer.