6. API Reference

This section contains the complete API reference for the pyorbbecsdk Python wrapper. The API is organized into the following modules:

• 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

• Context - Entry point for device management

• Pipeline - Data streaming and processing pipeline

• Device - Device configuration and control

• Frame - Base class for all frame types

• Filter - Post-processing filters

• Config - Pipeline configuration

• FrameSet - Collection of synchronized frames

6.10. Module Overview

Core

Core classes for device management including Context, Device, Sensor and related lists.

Pipeline

Pipeline for data streaming and processing configuration.

Frames

All frame-related classes for video, depth, IMU, and point cloud data.

Stream Profile

Classes for configuring and working with stream profiles.

Filters

Post-processing filters for enhancing and processing frames.

Record & Playback

Recording and playback functionality for saving and replaying sensor data.

Data Structures

Data structures, enumerations, and constants used throughout the SDK.

Utilities

Utility functions for working with the pyorbbecsdk.