DepthAI API Docs
latest

Content:

  • Home

Components:

  • Device
    • Device API
    • Multiple devices
    • Device queues
    • Specifying arguments for getOutputQueue method
      • Blocking behaviour
      • Non-Blocking behaviour
      • Some additional information
    • Reference
  • Bootloader
    • API
    • DepthAI Application Package (.dap)
    • Example
  • Pipeline
    • Pipeline first steps
    • Specifying OpenVINO version
    • Using multiple devices
    • How to place it
    • Reference
  • Nodes
    • ColorCamera
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • EdgeDetector
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • FeatureTracker
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
      • Image cells
      • Initial Harris Threshold
      • Entry conditions for new features
      • Harris Threshold for Tracked Features
      • Feature Maintenance
      • New position calculation
    • ImageManip
      • How to place it
      • Inputs and Outputs
      • Usage
      • Image formats supported
      • Limitations
      • Examples of functionality
      • Reference
    • IMU
      • How to place it
      • Inputs and Outputs
      • Maximum frequencies
      • Usage
      • IMU devices
      • IMU sensors
      • Examples of functionality
      • Reference
    • MobileNetDetectionNetwork
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • MobileNetSpatialDetectionNetwork
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • MonoCamera
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • NeuralNetwork
      • How to place it
      • Inputs and Outputs
      • Passthrough mechanism
      • Usage
      • Examples of functionality
      • Reference
    • ObjectTracker
      • How to place it
      • Inputs and Outputs
      • Zero term tracking
      • Short term tracking
      • Supported object tracker types
      • Maximum number of tracked objects
      • Usage
      • Examples of functionality
      • Reference
    • Script
      • How to place it
      • Inputs and Outputs
      • Usage
      • Interfacing with GPIOs
      • Using DepthAI Messages
      • Available modules and libraries
      • Examples of functionality
      • Reference
    • SpatialLocationCalculator
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • SPIIn
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • SPIOut
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • StereoDepth
      • How to place it
      • Inputs and Outputs
      • Internal block diagram of StereoDepth node
        • Currently configurable blocks
      • Current limitations
      • Stereo depth FPS
      • Usage
      • Examples of functionality
      • Reference
      • Disparity
      • Calculate depth using disparity map
      • Min stereo depth distance
      • Max stereo depth distance
      • Depth perception accuracy
      • Limitation
    • SystemLogger
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • VideoEncoder
      • How to place it
      • Inputs and Outputs
      • Usage
      • Limitations
      • Examples of functionality
      • Reference
    • XLinkIn
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • XLinkOut
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • YoloDetectionNetwork
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • YoloSpatialDetectionNetwork
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
  • Messages
    • Buffer
      • Reference
    • CameraControl
      • Examples of functionality
      • Reference
    • EdgeDetectorConfig
      • Examples of functionality
      • Reference
    • FeatureTrackerConfig
      • Reference
    • ImageManipConfig
      • Examples of functionality
      • Reference
    • ImgDetections
      • Examples of functionality
      • Reference
    • ImgFrame
      • Examples of functionality
      • Reference
    • IMUData
      • Reference
    • NNData
      • Reference
    • SpatialImgDetections
      • Examples of functionality
      • Reference
    • SpatialLocationCalculatorConfig
      • Examples of functionality
      • Reference
    • SpatialLocationCalculatorData
      • Examples of functionality
      • Reference
    • StereoDepthConfig
      • Examples of functionality
      • Reference
    • SystemInformation
      • Examples of functionality
      • Reference
    • TrackedFeatures
      • Reference
    • Tracklets
      • Examples of functionality
      • Reference

Tutorials:

  • Hello World
    • Demo
    • Dependencies
    • Code Overview
    • File Setup
    • Install pip dependencies
    • Test your environment
    • Define a pipeline
    • Initialize the DepthAI Device
    • Adding helpers
    • Consuming the results
    • Display the results
    • Running the example
  • Multiple DepthAI per Host
    • Demo code
    • Dependencies
    • Discover DepthAI-USB Port Mapping
    • Selecting a Specific DepthAI device to be used
      • Specifying POE device to be used
  • How to maximize FOV
    • Change aspect ratio
    • Letterboxing
  • Debugging DepthAI pipeline
    • DepthAI debugging level
    • Script node logging
  • RAM usage
    • Decreasing RAM consumption
  • Displaying detections in High-Res
    • 1. Passthrough
    • 2. Crop high resolution frame
    • 3. Stretch the frame
    • 4. Edit bounding boxes

Code:

  • Code Samples
    • Bootloader Config
      • Demo
      • Setup
      • Source code
    • Bootloader Version
      • Demo
      • Setup
      • Source code
    • Flash Bootloader
      • Demo
      • Setup
      • Source code
    • POE set IP
      • Demo
      • Setup
      • Source code
    • Calibration Flash
      • Demo
      • Setup
      • Source code
    • Calibration Flash v5
      • Setup
      • Source code
    • Calibration Load
      • Setup
      • Source code
    • Calibration Reader
      • Setup
      • Source code
    • Auto Exposure on ROI
      • Demo
      • Setup
      • Source code
    • RGB Camera Control
      • Demo
      • Setup
      • Source code
    • RGB Preview
      • Demo
      • Setup
      • Source code
    • RGB scene
      • Demo
      • Setup
      • Source code
    • RGB video
      • Demo
      • Setup
      • Source code
    • Edge Detector
      • Demo
      • Setup
      • Source code
    • Feature Detector
      • Demo
      • Setup
      • Source code
    • Feature Tracker
      • Demo
      • Setup
      • Source code
    • Device Queue Event
      • Demo
      • Setup
      • Source code
    • OpenCV support
      • Demo
      • Setup
      • Source code
    • Queue add callback
      • Demo
      • Setup
      • Source code
    • ImageManip Rotate
      • Demos
      • Setup
      • Source code
    • ImageManip Tiling
      • Demo
      • Setup
      • Source code
    • RGB Rotate Warp
      • Setup
      • Demo
      • Source code
    • IMU Accelerometer & Gyroscope
      • Demo
      • Setup
      • Source code
    • IMU Rotation Vector
      • Demo
      • Setup
      • Source code
    • Mono & MobilenetSSD & Depth
      • Demo
      • Setup
      • Source code
    • RGB Encoding & MobilenetSSD
      • Demo
      • Setup
      • Source code
    • RGB Encoding & Mono & MobilenetSSD
      • Demo
      • Setup
      • Source code
    • RGB Encoding & Mono with MobilenetSSD & Depth
      • Demo
      • Setup
      • Source code
    • Mono & MobilenetSSD
      • Demo
      • Setup
      • Source code
    • RGB & MobilenetSSD
      • Demo
      • Setup
      • Source code
    • RGB & MobileNetSSD @ 4K
      • Demo
      • Setup
      • Source code
    • Video & MobilenetSSD
      • Demo
      • Setup
      • Source code
    • Mono Camera Control
      • Demo
      • Setup
      • Source code
    • Mono Full Resolution Saver
      • Demo
      • Setup
      • Source code
    • Mono Preview
      • Demo
      • Setup
      • Source code
    • Object tracker on RGB
      • Demo
      • Setup
      • Source code
    • Object tracker on video
      • Demo
      • Setup
      • Source code
    • Spatial object tracker on RGB
      • Demo
      • Setup
      • Source code
    • Script camera control
      • Demo
      • Setup
      • Source code
    • Script forward frames
      • Demo
      • Setup
      • Source code
    • Script get local IP
      • Demo
      • Setup
      • Source code
    • Script HTTP client
      • Demo
      • Setup
      • Source code
    • Script HTTP server
      • Demo
      • Setup
      • Source code
    • Script JSON communication
      • Demo
      • Setup
      • Source code
    • Script MJPEG server
      • Demo
      • Setup
      • Source code
    • Script NNData example
      • Demo
      • Setup
      • Source code
    • Spatial location calculator
      • Demo
      • Setup
      • Source code
    • RGB & MobilenetSSD with spatial data
      • Demo
      • Setup
      • Source code
    • Mono & MobilenetSSD with spatial data
      • Demo
      • Setup
      • Source code
    • RGB & TinyYolo with spatial data
      • Demo
      • Setup
      • Source code
    • Depth Crop Control
      • Demo
      • Setup
      • Source code
    • Depth Preview
      • Demo
      • Setup
      • Source code
    • RGB Depth
      • Demo
      • Setup
      • Source code
    • Stereo Depth from host
      • Setup
      • Source code
    • Stereo Depth Video
      • Setup
      • Source code
    • System information
      • Demo
      • Setup
      • Source code
    • Disparity encoding
      • Demo
      • Setup
      • Source code
    • Encoding Max Limit
      • Demo
      • Setup
      • Source code
    • RGB Encoding
      • Demo
      • Setup
      • Source code
    • RGB Full Resolution Saver
      • Demo
      • Setup
      • Source code
    • RGB & Mono Encoding
      • Demo
      • Setup
      • Source code
    • RGB & Tiny YOLO
      • Demo
      • Setup
      • Source code
  • Experiments (GitHub)

References:

  • Python API Reference
    • Nodes
  • C++ API Reference
DepthAI API Docs
  • »
  • Search

© Copyright 2022, Luxonis. Revision 963c7814.

Built with Sphinx using a theme provided by Read the Docs.