Orbbec SDK V2 Python Wrapper

• 1. Overview
  • 1.1. Introduction
    • 1.1.1. Device Support Comparison
    • 1.1.2. Supported Platforms
    • 1.1.3. Support Hardware Products
    • 1.1.4. Support Platforms
  • 1.2. Orbbec SDK Overview
    • 1.2.1. Terms
    • 1.2.2. Orbbec SDK v2 Architecture Overview
    • 1.2.3. SDK Concept Overview
    • 1.2.4. SDK Programming Model
• 2. Installation
  • 2.1. Virtual Environment Installation Guide
    • 2.1.1. 📋 Table of Contents
    • 2.1.2. 📊 Tool Selection Guide
    • 2.1.3. Quick Start
    • 2.1.4. 1. Using venv (Recommended for Beginners)
    • 2.1.5. 2. Using pyenv (Multiple Python Versions)
    • 2.1.6. 3. Using conda (Data Science Users)
    • 2.1.7. Platform-Specific Notes
    • 2.1.8. Troubleshooting
    • 2.1.9. 📝 Best Practices
    • 2.1.10. 🔗 Related Documentation
  • 2.2. Environment Setup (One-Time Configuration)
    • 2.2.1. Quick Setup (Recommended)
    • 2.2.2. What This Setup Does
    • 2.2.3. Manual Configuration (Advanced)
  • 2.3. Installation Guide
    • 2.3.1. 📋 System Requirements
    • 2.3.2. 📖 Detailed Installation
    • 2.3.3. 🚀 Quick Install (TL;DR)
    • 2.3.4. 🐛 Troubleshooting
    • 2.3.5. 📚 Next Steps
    • 2.3.6. 📖 Additional Resources
• 3. QuickStarts
  • 3.1. QuickStart Guide
  • 3.2. 🎯 Overview
    • 3.2.1. What You’ll Learn
    • 3.2.2. Time to Complete
    • 3.2.3. Final Result
  • 3.3. ✅ Prerequisites
    • 3.3.1. Hardware
    • 3.3.2. Software
    • 3.3.3. Quick Verification
    • 3.3.4. Platform-Specific Notes
  • 3.4. 🚀 Your First Application
    • 3.4.1. Step 1: Run the Quick Start Example
    • 3.4.2. Step 2: How It Works
    • 3.4.3. Step 3: Common Customizations
  • 3.5. 🐛 Troubleshooting
    • 3.5.1. “No device found” (Linux)
    • 3.5.2. Permission denied (macOS)
    • 3.5.3. Import Error
    • 3.5.4. Empty Frames
    • 3.5.5. Display Issues
    • 3.5.6. Metadata/Timestamp Issues (Windows)
  • 3.6. 📚 Next Steps
    • 3.6.1. 🗺️ Recommended Learning Path
    • 3.6.2. 🎓 Learn by Example
    • 3.6.3. Level 1 — Beginner ⭐
    • 3.6.4. Level 2 — Advanced ⭐⭐
    • 3.6.5. Level 3 — Applications ⭐⭐⭐
    • 3.6.6. Specialized — LiDAR ⭐⭐⭐
    • 3.6.7. 🔗 Additional Resources
    • 3.6.8. 📝 SDK Feature Overview
  • 3.7. 💡 Tips for Success
• 4. Package
  • 4.1. Build from Source with UV (Recommended)
    • 4.1.1. Prerequisites
    • 4.1.2. Build Scripts
    • 4.1.3. Quick Start
    • 4.1.4. Script Options
    • 4.1.5. Offline Build
    • 4.1.6. Build Output
    • 4.1.7. Build Process Details
    • 4.1.8. Troubleshooting
    • 4.1.9. Advanced Usage
    • 4.1.10. Comparison with Traditional Build
    • 4.1.11. Next Steps
    • 4.1.12. See Also
  • 4.2. Build from Source (Traditional CMake Method - Deprecated)
    • 4.2.1. Environment
    • 4.2.2. Linux Python SDK Compilation
    • 4.2.3. Windows Python SDK Compilation
• 5. Application Guide
  • 5.1. Create Device
  • 5.2. Create Pipeline
  • 5.3. Obtain the Sensor List
  • 5.4. Obtain Video Data Streams
    • 5.4.1. Blocking Polling Mode (Video Data Streams)
    • 5.4.2. Asynchronous Callback Mode (Video Data Streams)
  • 5.5. Obtain Imu Data Streams
    • 5.5.1. Blocking Polling Mode (Imu Data Streams)
    • 5.5.2. Asynchronous Callback Mode (Imu Data Streams)
  • 5.6. Obtain the Camera Intrinsic and Extrinsic Parameters
  • 5.7. Frame Aggregate
  • 5.8. D2C
    • 5.8.1. Hardware D2C
    • 5.8.2. Software D2C
  • 5.9. Software C2D
  • 5.10. Depth Point Cloud
  • 5.11. RGBD Point Cloud
  • 5.12. Noise Removeal Filter
    • 5.12.1. Hardware Noise Removeal Filter
    • 5.12.2. Software Noise Removeal Filter
  • 5.13. Depth Post-Processing Filters
  • 5.14. Recording and Playback
    • 5.14.1. Recording
    • 5.14.2. Playback
  • 5.15. Firmware Update
  • 5.16. Update Preset
  • 5.17. Device Disconnection and Reconnection
  • 5.18. Commonly Used Interfaces
    • 5.18.1. Device Reboot
    • 5.18.2. Obtain the Serial Number
    • 5.18.3. Obtain the IP Config
    • 5.18.4. Obtain Local Network Configuration
    • 5.18.5. IP Configuration
    • 5.18.6. Obtain Device Temperature
    • 5.18.7. Obtain Device Baseline
    • 5.18.8. Stream Profile
    • 5.18.9. Obtain IMU StreamProfile
    • 5.18.10. Obtain Intrinsic and Extrinsic Parameters
    • 5.18.11. Obtain IMU Intrinsic Parameters
    • 5.18.12. LDP Switch
    • 5.18.13. HDR Merge
    • 5.18.14. Obtain LDP Measurement Value
    • 5.18.15. Obtain LDP Protection Status
    • 5.18.16. Laser Switch
    • 5.18.17. Obtain MetaData
    • 5.18.18. Triggered Capture
    • 5.18.19. Timestamp Reset
    • 5.18.20. Device Time Synchronization
    • 5.18.21. D2D (Disparity to depth)
    • 5.18.22. Depth Settings
    • 5.18.23. IR Parameter Settings
    • 5.18.24. Color Parameter Settings
    • 5.18.25. Multi-Camera Synchronization
    • 5.18.26. Frame Interleave
    • 5.18.27. Heart Beat Control
    • 5.18.28. Log Management
• 6. API Reference
  • 6.1. Core
    • 6.1.1. Classes
  • 6.2. Pipeline
    • 6.2.1. Classes
  • 6.3. Frames
    • 6.3.1. Class Hierarchy
    • 6.3.2. Inheritance Overview
    • 6.3.3. Classes
    • 6.3.4. Enumerations
    • 6.3.5. Constants
  • 6.4. Stream Profile
    • 6.4.1. Class Hierarchy
    • 6.4.2. Inheritance Overview
    • 6.4.3. Classes
    • 6.4.4. Enumerations
    • 6.4.5. Constants
  • 6.5. Filters
    • 6.5.1. Class Hierarchy
    • 6.5.2. Inheritance Overview
    • 6.5.3. Classes
    • 6.5.4. Enumerations
  • 6.6. Record & Playback
    • 6.6.1. Classes
  • 6.7. Data Structures
    • 6.7.1. Enumerations
  • 6.8. Utilities
    • 6.8.1. Functions
  • 6.9. Quick Links
  • 6.10. Module Overview
• 7. FAQ
  • 7.1. Table of Contents
  • 7.2. Installation Issues
    • 7.2.1. No device found on Linux
    • 7.2.2. Permission denied on macOS
    • 7.2.3. ImportError on Windows
    • 7.2.4. Python version mismatch
    • 7.2.5. Offline installation fails
    • 7.2.6. Package name confusion
    • 7.2.7. Open3D and NumPy version compatibility
  • 7.3. Build Issues
    • 7.3.1. uv command not found
    • 7.3.2. CMake configuration failed
    • 7.3.3. pybind11 not found in offline mode
    • 7.3.4. Build fails on Windows with Visual Studio not found
  • 7.4. Runtime Issues
    • 7.4.1. Empty frames or frames is None
    • 7.4.2. Display issues with OpenCV
    • 7.4.3. Jetson Nano illegal instruction
    • 7.4.4. Import Error ModuleNotFoundError
  • 7.5. Platform-Specific Issues
    • 7.5.1. USB device access permission error on Linux
    • 7.5.2. Metadata or timestamp issues on Windows
    • 7.5.3. macOS camera and terminal authorization
  • 7.6. Camera and Streaming
    • 7.6.1. Frame synchronization failures
    • 7.6.2. Resolution or FPS configuration issues
  • 7.7. Configuration
    • 7.7.1. How to configure or disable SDK logging
  • 7.8. Firmware
    • 7.8.1. Firmware version mismatch
    • 7.8.2. How to update firmware
  • 7.9. Additional Resources
• 8. License