DepthAI SDK Docs
Getting started
What is DepthAI SDK?
Quickstart
Installation
Working with camera
Blocking behavior
Creating color and depth streams
Creating YOLO neural network for object detection
Adding custom callbacks
Recording
Output syncing
Encoded streams
Fundamentals
Components
Available components
Reference
CameraComponent
Usage
Component outputs
Reference
IMUComponent
Usage
Component outputs
Reference
NNComponent
DepthAI API nodes
StereoComponent
Usage
Component outputs
Reference
Packets
API Usage
Reference
FramePacket
SpatialBbMappingPacket
DetectionPacket
NNDataPacket
DepthPacket
TrackerPacket
TwoStagePacket
IMUPacket
Visualizer
Getting Started
Configs
Objects
Create your own object
Example usage
Serialization
JSON schemas
General config
Objects
Example JSON output
References
Features
AI models
SDK supported models
Automatic IR power control
Usage
Conditional actions
Overview
Triggers
Actions
Usage
Reference
Recording
Supported recording types
1. Video
2. Rosbag
3. MCAP recording
Replaying
Replaying support
Replaying a depthai-recording
Public depthai-recordings
Examples
Code Samples
FFC Camera Visualization
Setup
Pipeline
Source Code
Camera Control
Demo
Setup
Pipeline
Source Code
Camera Control with NN
Demo
Setup
Pipeline
Source Code
Camera Preview
Demo
Setup
Pipeline
Source Code
Mono Camera Preview
Demo
Setup
Pipeline
Source Code
Preview All Cameras
Demo
Setup
Pipeline
Source Code
RGB and Mono Preview
Demo
Setup
Pipeline
Source Code
Camera Rotated Preview
Demo
Setup
Pipeline
Source Code
API Interoperability Example
Demo
Setup
Pipeline
Source Code
Car Tracking Example
Demo
Setup
Pipeline
Source Code
Collision Avoidance
Demo
Setup
Pipeline
Source Code
Speed Calculation Preview
Demo
Setup
Pipeline
Source Code
Switch Between Models
Setup
Pipeline
Source Code
Sync Multiple Outputs
Demo
Setup
Pipeline
Source Code
IMU Demonstration
Demo
Setup
Pipeline
Source Code
IMU Rerun Demonstration
Demo
Setup
Pipeline
Source Code
Age-Gender Inference
Demo
Setup
Pipeline
Source Code
Custom Decode Function
Setup
Pipeline
Source Code
Deeplabv3 Person Segmentation
Setup
Pipeline
Source Code
Emotion Recognition
Demo
Setup
Pipeline
Source Code
Face Detection RGB
Demo
Setup
Pipeline
Source Code
Face Detection Mono
Demo
Setup
Pipeline
Source Code
Human Pose Estimation
Demo
Setup
Pipeline
Source Code
MobileNet Encoded
Setup
Pipeline
Source Code
Neural Network Component
Setup
Pipeline
Source Code
Object Tracking
Demo
Setup
Pipeline
Source Code
Roboflow Integration
Setup
Pipeline
Source Code
Spatial Detection
Demo
Setup
Pipeline
Source Code
YOLO SDK
Demo
Setup
Pipeline
Source Code
Pointcloud Demo
Demo
Setup
Pipeline
Source Code
Encode Multiple Streams
Setup
Pipeline
Source Code
Preview Encoder
Setup
Pipeline
Source Code
MCAP Recording
Setup
Source Code
MCAP IMU Recording
Setup
Source Code
Hardcode Recording Duration
Setup
Pipeline
Source Code
ROSBAG Recording
Setup
Pipeline
Source Code
Stereo Recording
Setup
Pipeline
Source Code
Object counting on images
Demo
Setup
Pipeline
Source Code
Looped Replay
Setup
Pipeline
Source Code
People Tracker on Video Replay
Setup
Pipeline
Source Code
Face Detection Inference on Downloaded Image
Demo
Setup
Pipeline
Source Code
Vehicle Detection on a Youtube Video
Setup
Pipeline
Source Code
Stereo Preview
Setup
Pipeline
Source Code
Auto IR Brightness
Setup
Pipeline
Source Code
Stereo Control
Demo
Setup
Pipeline
Source Code
Stereo Encoding
Setup
Pipeline
Source Code
ROS Publishing
Setup
Source Code
Custom Trigger Action
Setup
Pipeline
Source Code
Custom Trigger
Setup
Pipeline
Source Code
Person Record
Setup
Pipeline
Source Code
Visualizer Demo
Setup
Pipeline
Source Code
Visualizer Callback Function
Demo
Setup
Pipeline
Source Code
References
API Reference
DepthAI SDK Docs
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
A
add_bbox() (depthai_sdk.visualize.visualizer.Visualizer method)
add_child() (depthai_sdk.visualize.objects.GenericObject method)
add_circle() (depthai_sdk.visualize.visualizer.Visualizer method)
add_detections() (depthai_sdk.visualize.visualizer.Visualizer method)
add_line() (depthai_sdk.visualize.visualizer.Visualizer method)
add_mask() (depthai_sdk.visualize.visualizer.Visualizer method)
add_object() (depthai_sdk.visualize.visualizer.Visualizer method)
add_text() (depthai_sdk.visualize.visualizer.Visualizer method)
add_trail() (depthai_sdk.visualize.visualizer.Visualizer method)
angle (depthai_sdk.classes.nn_results.Detection attribute)
auto_scale (depthai_sdk.visualize.configs.TextConfig attribute)
B
background_color (depthai_sdk.visualize.configs.TextConfig attribute)
background_transparency (depthai_sdk.visualize.configs.TextConfig attribute)
bbox (depthai_sdk.classes.nn_results.Detection attribute)
bbox_style (depthai_sdk.visualize.configs.DetectionConfig attribute)
BboxStyle (class in depthai_sdk.visualize.configs)
BOTTOM_LEFT (depthai_sdk.visualize.configs.TextPosition attribute)
BOTTOM_MID (depthai_sdk.visualize.configs.TextPosition attribute)
BOTTOM_RIGHT (depthai_sdk.visualize.configs.TextPosition attribute)
bottom_right() (depthai_sdk.classes.nn_results.Detection property)
box_roundness (depthai_sdk.visualize.configs.DetectionConfig attribute)
C
children() (depthai_sdk.visualize.objects.GenericObject property)
circle (depthai_sdk.visualize.configs.VisConfig attribute)
CircleConfig (class in depthai_sdk.visualize.configs)
clickable (depthai_sdk.visualize.configs.OutputConfig attribute)
close() (depthai_sdk.visualize.visualizer.Visualizer method)
color (depthai_sdk.classes.nn_results.Detection attribute)
(depthai_sdk.visualize.configs.CircleConfig attribute)
(depthai_sdk.visualize.configs.DetectionConfig attribute)
colorize (depthai_sdk.visualize.configs.StereoConfig attribute)
colormap (depthai_sdk.visualize.configs.StereoConfig attribute)
confidence (depthai_sdk.classes.nn_results.Detection attribute)
CORNERS (depthai_sdk.visualize.configs.BboxStyle attribute)
D
decode() (depthai_sdk.classes.packets.FramePacket method)
deletion_lost_threshold (depthai_sdk.visualize.configs.TrackingConfig attribute)
depth_score (depthai_sdk.visualize.configs.StereoConfig attribute)
depthai_sdk.classes.nn_results
module
depthai_sdk.visualize.configs
module
DepthPacket (class in depthai_sdk.classes.packets)
Detection (class in depthai_sdk.classes.nn_results)
detection (depthai_sdk.visualize.configs.VisConfig attribute)
DetectionConfig (class in depthai_sdk.visualize.configs)
DetectionPacket (class in depthai_sdk.classes.packets)
Detections (class in depthai_sdk.classes.nn_results)
detections() (depthai_sdk.visualize.visualizer.Visualizer method)
drawn() (depthai_sdk.visualize.visualizer.Visualizer method)
E
ExtendedImgDetection (class in depthai_sdk.classes.nn_results)
F
fading_tails (depthai_sdk.visualize.configs.TrackingConfig attribute)
fill_transparency (depthai_sdk.visualize.configs.DetectionConfig attribute)
filtered_2d (depthai_sdk.classes.nn_results.TrackingDetection attribute)
filtered_3d (depthai_sdk.classes.nn_results.TrackingDetection attribute)
font_color (depthai_sdk.visualize.configs.TextConfig attribute)
font_face (depthai_sdk.visualize.configs.TextConfig attribute)
font_position (depthai_sdk.visualize.configs.TextConfig attribute)
font_scale (depthai_sdk.visualize.configs.TextConfig attribute)
font_thickness (depthai_sdk.visualize.configs.TextConfig attribute)
font_transparency (depthai_sdk.visualize.configs.TextConfig attribute)
frame() (depthai_sdk.classes.packets.FramePacket property)
frame_shape() (depthai_sdk.visualize.visualizer.Visualizer property)
FramePacket (class in depthai_sdk.classes.packets)
G
GenericNNOutput (class in depthai_sdk.classes.nn_results)
GenericObject (class in depthai_sdk.visualize.objects)
get_detections() (depthai_sdk.visualize.objects.VisDetections method)
get_imu_vals() (depthai_sdk.classes.packets.IMUPacket method)
get_rect_centroid() (depthai_sdk.visualize.objects.VisTrail static method)
get_sequence_num() (depthai_sdk.classes.packets.FramePacket method)
(depthai_sdk.classes.packets.IMUPacket method)
(depthai_sdk.classes.packets.NNDataPacket method)
get_size() (depthai_sdk.classes.packets.FramePacket method)
get_timestamp() (depthai_sdk.classes.packets.FramePacket method)
(depthai_sdk.classes.packets.IMUPacket method)
(depthai_sdk.classes.packets.NNDataPacket method)
getSequenceNum() (depthai_sdk.classes.nn_results.GenericNNOutput method)
getTimestamp() (depthai_sdk.classes.nn_results.GenericNNOutput method)
GRAY (depthai_sdk.visualize.configs.StereoColor attribute)
groupby_tracklet() (depthai_sdk.visualize.objects.VisTrail method)
H
hide_label (depthai_sdk.visualize.configs.DetectionConfig attribute)
I
img_detection (depthai_sdk.classes.nn_results.Detection attribute)
img_scale (depthai_sdk.visualize.configs.OutputConfig attribute)
ImgLandmarks (class in depthai_sdk.classes.nn_results)
IMUPacket (class in depthai_sdk.classes.packets)
InstanceSegmentation (class in depthai_sdk.classes.nn_results)
L
label_padding (depthai_sdk.visualize.configs.DetectionConfig attribute)
label_position (depthai_sdk.visualize.configs.DetectionConfig attribute)
label_str (depthai_sdk.classes.nn_results.Detection attribute)
labels (depthai_sdk.classes.nn_results.InstanceSegmentation attribute)
line_color (depthai_sdk.visualize.configs.TrackingConfig attribute)
line_height (depthai_sdk.visualize.configs.DetectionConfig attribute)
line_thickness (depthai_sdk.visualize.configs.TrackingConfig attribute)
line_type (depthai_sdk.visualize.configs.CircleConfig attribute)
(depthai_sdk.visualize.configs.TextConfig attribute)
(depthai_sdk.visualize.configs.TrackingConfig attribute)
line_width (depthai_sdk.visualize.configs.DetectionConfig attribute)
M
mask (depthai_sdk.classes.nn_results.SemanticSegmentation attribute)
mask_alpha (depthai_sdk.visualize.configs.SegmentationConfig attribute)
masks (depthai_sdk.classes.nn_results.InstanceSegmentation attribute)
max_length (depthai_sdk.visualize.configs.TrackingConfig attribute)
MID (depthai_sdk.visualize.configs.TextPosition attribute)
MID_LEFT (depthai_sdk.visualize.configs.TextPosition attribute)
MID_RIGHT (depthai_sdk.visualize.configs.TextPosition attribute)
module
depthai_sdk.classes.nn_results
depthai_sdk.visualize.configs
N
nn_data (depthai_sdk.classes.nn_results.TwoStageDetection attribute)
NNDataPacket (class in depthai_sdk.classes.packets)
O
outline_color (depthai_sdk.visualize.configs.TextConfig attribute)
output (depthai_sdk.visualize.configs.VisConfig attribute)
output() (depthai_sdk.visualize.visualizer.Visualizer method)
OutputConfig (class in depthai_sdk.visualize.configs)
P
prepare() (depthai_sdk.visualize.objects.GenericObject method)
(depthai_sdk.visualize.objects.VisDetections method)
(depthai_sdk.visualize.objects.VisLine method)
(depthai_sdk.visualize.objects.VisTrail method)
prepare_visualizer_objects() (depthai_sdk.classes.packets.DetectionPacket method)
(depthai_sdk.classes.packets.SpatialBbMappingPacket method)
(depthai_sdk.classes.packets.TrackerPacket method)
R
RECTANGLE (depthai_sdk.visualize.configs.BboxStyle attribute)
register_detection() (depthai_sdk.visualize.objects.VisDetections method)
reset() (depthai_sdk.visualize.visualizer.Visualizer method)
RGB (depthai_sdk.visualize.configs.StereoColor attribute)
RGBD (depthai_sdk.visualize.configs.StereoColor attribute)
ROUNDED_CORNERS (depthai_sdk.visualize.configs.BboxStyle attribute)
ROUNDED_RECTANGLE (depthai_sdk.visualize.configs.BboxStyle attribute)
S
segmentation() (depthai_sdk.visualize.visualizer.Visualizer method)
SegmentationConfig (class in depthai_sdk.visualize.configs)
SemanticSegmentation (class in depthai_sdk.classes.nn_results)
serialize() (depthai_sdk.visualize.objects.GenericObject method)
(depthai_sdk.visualize.objects.VisDetections method)
(depthai_sdk.visualize.objects.VisLine method)
(depthai_sdk.visualize.objects.VisText method)
(depthai_sdk.visualize.objects.VisTrail method)
(depthai_sdk.visualize.visualizer.Visualizer method)
set_config() (depthai_sdk.visualize.objects.GenericObject method)
set_decode_codec() (depthai_sdk.classes.packets.FramePacket method)
set_frame_shape() (depthai_sdk.visualize.objects.GenericObject method)
show() (depthai_sdk.visualize.visualizer.Visualizer method)
show_fps (depthai_sdk.visualize.configs.OutputConfig attribute)
show_speed (depthai_sdk.visualize.configs.TrackingConfig attribute)
SpatialBbMappingPacket (class in depthai_sdk.classes.packets)
speed (depthai_sdk.classes.nn_results.TrackingDetection attribute)
speed_kmph() (depthai_sdk.classes.nn_results.TrackingDetection property)
speed_mph() (depthai_sdk.classes.nn_results.TrackingDetection property)
stereo (depthai_sdk.visualize.configs.VisConfig attribute)
stereo() (depthai_sdk.visualize.visualizer.Visualizer method)
StereoColor (class in depthai_sdk.visualize.configs)
StereoConfig (class in depthai_sdk.visualize.configs)
T
text (depthai_sdk.visualize.configs.VisConfig attribute)
text() (depthai_sdk.visualize.visualizer.Visualizer method)
TextConfig (class in depthai_sdk.visualize.configs)
TextPosition (class in depthai_sdk.visualize.configs)
thickness (depthai_sdk.visualize.configs.CircleConfig attribute)
(depthai_sdk.visualize.configs.DetectionConfig attribute)
TOP_LEFT (depthai_sdk.visualize.configs.TextPosition attribute)
top_left() (depthai_sdk.classes.nn_results.Detection property)
TOP_MID (depthai_sdk.visualize.configs.TextPosition attribute)
TOP_RIGHT (depthai_sdk.visualize.configs.TextPosition attribute)
TrackerPacket (class in depthai_sdk.classes.packets)
tracking (depthai_sdk.visualize.configs.VisConfig attribute)
tracking() (depthai_sdk.visualize.visualizer.Visualizer method)
TrackingConfig (class in depthai_sdk.visualize.configs)
TrackingDetection (class in depthai_sdk.classes.nn_results)
tracklet (depthai_sdk.classes.nn_results.TrackingDetection attribute)
ts (depthai_sdk.classes.nn_results.Detection attribute)
TwoStageDetection (class in depthai_sdk.classes.nn_results)
TwoStagePacket (class in depthai_sdk.classes.packets)
V
VisConfig (class in depthai_sdk.visualize.configs)
VisDetections (class in depthai_sdk.visualize.objects)
VisLine (class in depthai_sdk.visualize.objects)
VisText (class in depthai_sdk.visualize.objects)
VisTrail (class in depthai_sdk.visualize.objects)
Visualizer (class in depthai_sdk.visualize.visualizer)
W
wls_filter (depthai_sdk.visualize.configs.StereoConfig attribute)
wls_lambda (depthai_sdk.visualize.configs.StereoConfig attribute)
wls_sigma (depthai_sdk.visualize.configs.StereoConfig attribute)