OrbbecSDK V2 Python Wrapper
1. Overview
1.1. Introduction
1.1.1. Support Hardware Products
1.1.2. 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. Registration script (required)
2.1.1. install udev rules script (Linux)
2.1.2. Registering Metadata Using a Script (Windows)
2.2. Linux
2.2.1. Installation
2.2.1.1. Online installation
2.2.1.2. Offline installation
2.2.1.2.1. Prerequisites
2.2.1.2.2. Download the Appropriate .whl Package
2.2.1.2.3. Install the Package
2.2.2. Verify the Installation
2.2.3. Run the Example
2.3. Windows
2.3.1. Installation
2.3.1.1. Online installation
2.3.1.2. Offline installation
2.3.1.2.1. Prerequisites
2.3.1.2.2. Download the Appropriate .whl Package
2.3.1.2.3. Install the Package
2.3.2. Verify the Installation
2.3.3. Run the Example
2.4. Build from Source
2.4.1. Environment
2.4.1.1. Compilation Platform Requirements
2.4.1.2. Python Version
2.4.2. Linux Python SDK Compilation
2.4.2.1. Install Dependencies (Ubuntu)
2.4.2.2. Custom Python Path (Optional)
2.4.2.3. Build the Project
2.4.2.4. Run the Examples
2.4.2.5. Generate Python Stubs
2.4.2.6. Making a Python Wheel
2.4.3. Windows Python SDK Compilation
2.4.3.1. Download the Python SDK Source Code
2.4.3.2. Install Dependencies
2.4.3.3. Configure Visual Studio Project
2.4.3.4. Compile the Python SDK
2.4.3.5. Test Examples
3. QuickStarts
3.1. Introduction
3.2. Build your First Camera Application
3.3. Sample Features
4. Application Guide
4.1. Create Device
4.2. Create Pipeline
4.3. Obtain the Sensor List
4.4. Obtain Video Data Streams
4.4.1. Blocking Polling Mode (Video Data Streams)
4.4.2. Asynchronous Callback Mode (Video Data Streams)
4.5. Obtain Imu Data Streams
4.5.1. Blocking Polling Mode (Imu Data Streams)
4.5.2. Asynchronous Callback Mode (Imu Data Streams)
4.6. Obtain the Camera Intrinsic and Extrinsic Parameters
4.7. Frame Aggregate
4.8. D2C
4.8.1. Hardware D2C
4.8.2. Software D2C
4.9. Software C2D
4.10. Depth Point Cloud
4.11. RGBD Point Cloud
4.12. Noise Removeal Filter
4.12.1. Hardware Noise Removeal Filter
4.13. Depth Post-Processing Filters
4.14. Recording and Playback
4.14.1. Recording
4.14.2. Playback
4.15. Firmware Update
4.16. Update Preset
4.17. Device Disconnection and Reconnection
4.18. Commonly Used Interfaces
4.18.1. Device Reboot
4.18.2. Obtain the Serial Number
4.18.3. Obtain the IP Config
4.18.4. Obtain Local Network Configuration
4.18.5. IP Configuration
4.18.5.1. Set IP Configuration (Persistent)
4.18.5.2. Force IP Configuration (Temporary)
4.18.6. Stream Profile
4.18.7. Obtain IMU StreamProfile
4.18.8. Obtain Intrinsic and Extrinsic Parameters
4.18.9. Obtain IMU Intrinsic Parameters
4.18.10. LDP Switch
4.18.11. Obtain LDP Measurement Value
4.18.12. Obtain LDP Protection Status
4.18.13. Laser Switch
4.18.14. Obtain MetaData
4.18.15. Triggered Capture
4.18.15.1. Software Triggered Capture
4.18.16. Timestamp Reset
4.18.17. Device Time Synchronization
4.18.18. D2D (Disparity to depth)
4.18.18.1. Hardware D2D
4.18.18.2. Software D2D
4.18.19. Depth Settings
4.18.19.1. Depth Working Mode
4.18.19.2. Preset Configuration
4.18.19.3. Set Depth AE
4.18.19.4. Set Depth Exposure
4.18.19.5. Set Depth Gain
4.18.19.6. Set Depth Mirror
4.18.19.7. Set Depth Flip
4.18.19.8. Set Depth Rotation
4.18.19.9. Set the Unit of Depth
4.18.19.10. Set Min and Max Depth
4.18.20. IR Parameter Settings
4.18.20.1. Set IR AE
4.18.20.2. Set IR Exposure
4.18.20.3. Set IR Gain
4.18.20.4. Set IR Target Brightness
4.18.20.5. Set IR Maximum Exposure Value
4.18.20.6. set IR Mirror
4.18.20.7. Set IR Flip
4.18.20.8. Set IR Rotation
4.18.21. Color Parameter Settings
4.18.21.1. Set Color AE
4.18.21.2. Set Color Exposure
4.18.21.3. Set Color Gain
4.18.21.4. set Color Mirror
4.18.21.5. Set Color Flip
4.18.21.6. Set Color Rotation
4.18.21.7. Set Color Automatic White Balance (AWB)
4.18.21.8. Set Color White Balance Parameters
4.18.21.9. Set the Color Brightness
4.18.21.10. Set Color Sharpness
4.18.21.11. Set Color Gamma
4.18.21.12. Set Color Saturation
4.18.21.13. Set Color Hue
4.18.21.14. Set Color Auto Exposure Priority
4.18.21.15. Set Color Backlight Compensation
4.18.21.16. Set Color Contrast
4.18.21.17. Set Color Power Line Frequency
4.18.22. Multi-Camera Synchronization
4.18.22.1. Multi-Camera Synchronous Hardware Connection
4.18.22.2. Multi-Camera Synchronization Software Configuration
4.18.23. Frame Interleave
4.18.23.1. Load Frame Interleave
4.18.23.2. Check Frame Interleave Support
4.18.24. Heart Beat Control
5. FAQ
6. License
OrbbecSDK V2 Python Wrapper
Index
Index