API Reference

The Zivid SDK API organized by concept. The Camera section covers connecting to the camera and capturing data. The Applications section covers processing and using the captured data. See also the Zivid API documentation.

        %%{init: {'themeVariables': {'fontSize': '18px'}, 'flowchart': {'nodeSpacing': 30, 'rankSpacing': 35, 'subGraphTitleMargin': {'top': 8, 'bottom': 5}}}}%%
flowchart TD
  Application

  subgraph cameraSection [Camera]
    direction LR
    Settings
    Settings2D
    Camera
  end

  subgraph projectorSection [Projector]
    direction LR
    projectionOp(["showImage()"])
  end

  subgraph outputSection [Capture output]
    direction LR
    Frame
    Frame2D
  end

  subgraph appsBasic [Applications Basic]
    direction LR
    PointCloud
    Image
    DeviceArray
    moreBasic["…"]
  end

  subgraph appsAdv [Applications Advanced]
    direction LR
    HandEye["Hand-Eye Calibration"]
    ProjectedImage
    moreAdv["…"]
  end

  connectOp(["connect()"])
  capture3DOp(["capture3D()"])
  capture2D3DOp(["capture2D3D()"])
  capture2DOp(["capture2D()"])

  Application --> connectOp --> Camera
  Settings -.-> capture3DOp
  Settings -.-> capture2D3DOp
  Settings2D -.-> capture2DOp
  Camera -.-> projectionOp
  Camera --> capture3DOp --> Frame
  Camera --> capture2D3DOp --> Frame
  Camera --> capture2DOp --> Frame2D
  Frame --> PointCloud
  Frame --> DeviceArray
  Frame2D --> Image
  Frame2D --> DeviceArray
  Frame --> HandEye

  classDef zividClass fill:#4A8FA4,stroke:#34323D,color:#FFFFFF
  classDef api fill:#91D2C8,stroke:#4A8FA4,color:#000000
  classDef moreClass fill:#FFFFFF,stroke:#4A8FA4,color:#4A8FA4,stroke-dasharray:5 5
  class Application,Camera,Settings,Settings2D,Frame,Frame2D,PointCloud,Image,DeviceArray,HandEye,ProjectedImage zividClass
  class connectOp,capture2D3DOp,capture2DOp,capture3DOp,projectionOp api
  class moreBasic,moreAdv moreClass

Camera
Applications