6.3. Frames
All frame-related classes for video, depth, IMU, and point cloud data.
6.3.1. Class Hierarchy
The Frame class is the base class for all frame types.
![digraph FrameHierarchy {
rankdir=TB;
bgcolor=transparent;
node [shape=box, style="filled,rounded", fillcolor="#e3f2fd", color="#2196f3", fontname="Helvetica Neue, Helvetica, Arial, sans-serif", fontsize=11];
edge [color="#666666", arrowsize=0.8, penwidth=1.2];
Frame [label="Frame"];
VideoFrame [label="VideoFrame"];
ColorFrame [label="ColorFrame"];
DepthFrame [label="DepthFrame"];
IRFrame [label="IRFrame"];
ConfidenceFrame [label="ConfidenceFrame"];
PointsFrame [label="PointsFrame"];
LiDARPointsFrame [label="LiDARPointsFrame"];
AccelFrame [label="AccelFrame"];
GyroFrame [label="GyroFrame"];
FrameSet [label="FrameSet"];
Frame -> VideoFrame;
Frame -> PointsFrame;
Frame -> LiDARPointsFrame;
Frame -> AccelFrame;
Frame -> GyroFrame;
Frame -> FrameSet;
VideoFrame -> ColorFrame;
VideoFrame -> DepthFrame;
VideoFrame -> IRFrame;
VideoFrame -> ConfidenceFrame;
}](../../_images/graphviz-273828a95cab3d54e847d7e21d22d5f5e99484cb.png)
6.3.2. Inheritance Overview
Class |
Inherits From |
Description |
|---|---|---|
object |
Base class for all frame types |
|
Base class for video frames |
||
Color image frame |
||
Depth image frame |
||
Infrared image frame |
||
Confidence frame |
||
Point cloud frame |
||
LiDAR point cloud frame |
||
Accelerometer frame |
||
Gyroscope frame |
||
Collection of synchronized frames |
6.3.3. Classes
6.3.3.1. Frame
- class pyorbbecsdk.Frame
Bases:
pybind11_object- __init__(*args, **kwargs)
- as_accel_frame(self: pyorbbecsdk.Frame) ob::AccelFrame
- as_color_frame(self: pyorbbecsdk.Frame) ob::ColorFrame
- as_confidence_frame(self: pyorbbecsdk.Frame) ob::ConfidenceFrame
- as_depth_frame(self: pyorbbecsdk.Frame) ob::DepthFrame
- as_frame_set(self: pyorbbecsdk.Frame) ob::FrameSet
- as_gyro_frame(self: pyorbbecsdk.Frame) ob::GyroFrame
- as_ir_frame(self: pyorbbecsdk.Frame) ob::IRFrame
- as_lidar_points_frame(self: pyorbbecsdk.Frame) ob::LiDARPointsFrame
- as_points_frame(self: pyorbbecsdk.Frame) ob::PointsFrame
- as_video_frame(self: pyorbbecsdk.Frame) ob::VideoFrame
DISCOURAGED: This method is rarely needed in normal usage.
- copy_frame_info(self: pyorbbecsdk.Frame, arg0: pyorbbecsdk.Frame) None
- get_data(self: pyorbbecsdk.Frame) numpy.typing.NDArray[numpy.uint8]
- get_data_pointer(self: pyorbbecsdk.Frame) object
- get_data_size(self: pyorbbecsdk.Frame) int
- get_device(self: pyorbbecsdk.Frame) pyorbbecsdk.Device
- get_format(self: pyorbbecsdk.Frame) pyorbbecsdk.OBFormat
- get_global_timestamp_us(self: pyorbbecsdk.Frame) int
- get_index(self: pyorbbecsdk.Frame) int
- get_metadata_value(self: pyorbbecsdk.Frame, arg0: pyorbbecsdk.OBFrameMetadataType) int
- get_sensor(self: pyorbbecsdk.Frame) pyorbbecsdk.Sensor
- get_stream_profile(self: pyorbbecsdk.Frame) pyorbbecsdk.StreamProfile
- get_system_timestamp(self: pyorbbecsdk.Frame) int
- get_system_timestamp_us(self: pyorbbecsdk.Frame) int
- get_timestamp(self: pyorbbecsdk.Frame) int
Get the hardware timestamp of the frame in milliseconds
- get_timestamp_us(self: pyorbbecsdk.Frame) int
- get_type(self: pyorbbecsdk.Frame) pyorbbecsdk.OBFrameType
- has_metadata(self: pyorbbecsdk.Frame, arg0: pyorbbecsdk.OBFrameMetadataType) bool
- set_stream_profile(self: pyorbbecsdk.Frame, arg0: pyorbbecsdk.StreamProfile) None
- set_system_timestamp_us(self: pyorbbecsdk.Frame, arg0: SupportsInt | SupportsIndex) None
- update_data(self: pyorbbecsdk.Frame, arg0: typing_extensions.Buffer) None
- update_metadata(self: pyorbbecsdk.Frame, arg0: typing_extensions.Buffer) None
6.3.3.2. VideoFrame
- class pyorbbecsdk.VideoFrame
Bases:
Frame- __init__(*args, **kwargs)
- as_color_frame(self: pyorbbecsdk.VideoFrame) ob::ColorFrame
- as_confidence_frame(self: pyorbbecsdk.VideoFrame) ob::ConfidenceFrame
- as_depth_frame(self: pyorbbecsdk.VideoFrame) ob::DepthFrame
- as_ir_frame(self: pyorbbecsdk.VideoFrame) ob::IRFrame
- as_points_frame(self: pyorbbecsdk.VideoFrame) ob::PointsFrame
- get_height(self: pyorbbecsdk.VideoFrame) int
- get_metadata(self: pyorbbecsdk.VideoFrame) numpy.typing.NDArray[numpy.uint8]
- get_metadata_size(self: pyorbbecsdk.VideoFrame) int
- get_pixel_available_bit_size(self: pyorbbecsdk.VideoFrame) int
- get_pixel_type(self: pyorbbecsdk.VideoFrame) pyorbbecsdk.OBPixelType
- get_width(self: pyorbbecsdk.VideoFrame) int
- set_pixel_available_bit_size(self: pyorbbecsdk.VideoFrame, arg0: SupportsInt | SupportsIndex) None
- set_pixel_type(self: pyorbbecsdk.VideoFrame, arg0: pyorbbecsdk.OBPixelType) None
6.3.3.3. ColorFrame
- class pyorbbecsdk.ColorFrame
Bases:
VideoFrame- __init__(*args, **kwargs)
6.3.3.4. DepthFrame
- class pyorbbecsdk.DepthFrame
Bases:
VideoFrame- __init__(*args, **kwargs)
- get_depth_scale(self: pyorbbecsdk.DepthFrame) float
- set_value_scale(self: pyorbbecsdk.DepthFrame, arg0: SupportsFloat | SupportsIndex) None
6.3.3.5. IRFrame
- class pyorbbecsdk.IRFrame
Bases:
VideoFrame- __init__(*args, **kwargs)
6.3.3.6. ConfidenceFrame
- class pyorbbecsdk.ConfidenceFrame
Bases:
VideoFrame- __init__(*args, **kwargs)
6.3.3.7. PointsFrame
- class pyorbbecsdk.PointsFrame
Bases:
Frame- __init__(*args, **kwargs)
- get_height(self: pyorbbecsdk.PointsFrame) int
- get_position_value_scale(self: pyorbbecsdk.PointsFrame) float
- get_width(self: pyorbbecsdk.PointsFrame) int
6.3.3.8. LiDARPointsFrame
6.3.3.9. AccelFrame
- class pyorbbecsdk.AccelFrame
Bases:
Frame- __init__(*args, **kwargs)
- get_temperature(self: pyorbbecsdk.AccelFrame) float
- get_value(self: pyorbbecsdk.AccelFrame) pyorbbecsdk.OBAccelValue
- get_x(self: pyorbbecsdk.AccelFrame) float
- get_y(self: pyorbbecsdk.AccelFrame) float
- get_z(self: pyorbbecsdk.AccelFrame) float
6.3.3.10. GyroFrame
- class pyorbbecsdk.GyroFrame
Bases:
Frame- __init__(*args, **kwargs)
- get_temperature(self: pyorbbecsdk.GyroFrame) float
- get_value(self: pyorbbecsdk.GyroFrame) pyorbbecsdk.OBAccelValue
- get_x(self: pyorbbecsdk.GyroFrame) float
- get_y(self: pyorbbecsdk.GyroFrame) float
- get_z(self: pyorbbecsdk.GyroFrame) float
6.3.3.11. FrameSet
- class pyorbbecsdk.FrameSet
Bases:
Frame- __init__(*args, **kwargs)
- get_accel_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.AccelFrame
- get_color_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.ColorFrame
- get_confidence_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.ConfidenceFrame
- get_count(self: pyorbbecsdk.FrameSet) int
- get_depth_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.DepthFrame
- get_frame(self: pyorbbecsdk.FrameSet, arg0: pyorbbecsdk.OBFrameType) pyorbbecsdk.Frame
- get_frame_by_index(self: pyorbbecsdk.FrameSet, arg0: SupportsInt | SupportsIndex) pyorbbecsdk.Frame
- get_frame_by_type(self: pyorbbecsdk.FrameSet, arg0: pyorbbecsdk.OBFrameType) pyorbbecsdk.Frame
- get_frame_count(self: pyorbbecsdk.FrameSet) int
- get_gyro_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.GyroFrame
- get_ir_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.IRFrame
- get_left_color_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.ColorFrame
- get_left_ir_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.IRFrame
- get_lidar_points_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.LiDARPointsFrame
- get_points_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.PointsFrame
- get_right_color_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.ColorFrame
- get_right_ir_frame(self: pyorbbecsdk.FrameSet) pyorbbecsdk.IRFrame
- push_frame(self: pyorbbecsdk.FrameSet, arg0: pyorbbecsdk.Frame) None
6.3.4. Enumerations
6.3.4.1. OBFrameType
- class pyorbbecsdk.OBFrameType
Bases:
pybind11_objectOBFrameType Members Name
C++ Binding Object
Value
Description
ACCEL_FRAME<OBFrameType.ACCEL_FRAME: 4>4
Auto-generated from C++ bindings
COLOR_FRAME<OBFrameType.COLOR_FRAME: 2>2
Auto-generated from C++ bindings
CONFIDENCE_FRAME<OBFrameType.CONFIDENCE_FRAME: 11>11
Auto-generated from C++ bindings
DEPTH_FRAME<OBFrameType.DEPTH_FRAME: 3>3
Auto-generated from C++ bindings
FRAME_SET<OBFrameType.FRAME_SET: 5>5
Auto-generated from C++ bindings
GYRO_FRAME<OBFrameType.GYRO_FRAME: 7>7
Auto-generated from C++ bindings
IR_FRAME<OBFrameType.IR_FRAME: 1>1
Auto-generated from C++ bindings
LEFT_COLOR_FRAME<OBFrameType.LEFT_COLOR_FRAME: 13>13
Auto-generated from C++ bindings
LEFT_IR_FRAME<OBFrameType.LEFT_IR_FRAME: 8>8
Auto-generated from C++ bindings
LIDAR_POINTS_FRAME<OBFrameType.LIDAR_POINTS_FRAME: 12>12
Auto-generated from C++ bindings
RAW_PHASE_FRAME<OBFrameType.RAW_PHASE_FRAME: 10>10
Auto-generated from C++ bindings
RIGHT_COLOR_FRAME<OBFrameType.RIGHT_COLOR_FRAME: 14>14
Auto-generated from C++ bindings
RIGHT_IR_FRAME<OBFrameType.RIGHT_IR_FRAME: 9>9
Auto-generated from C++ bindings
TYPE_COUNT_FRAME<OBFrameType.TYPE_COUNT_FRAME: 15>15
Auto-generated from C++ bindings
UNKNOWN_FRAME<OBFrameType.UNKNOWN_FRAME: -1>-1
Auto-generated from C++ bindings
VIDEO_FRAME<OBFrameType.VIDEO_FRAME: 0>0
Auto-generated from C++ bindings
6.3.4.2. OBFrameMetadataType
- class pyorbbecsdk.OBFrameMetadataType
Bases:
pybind11_objectOBFrameMetadataType Members Name
C++ Binding Object
Value
Description
ACTUAL_FRAME_RATE<OBFrameMetadataType.ACTUAL_FRAME_RATE: 18>18
Auto-generated from C++ bindings
AE_ROI_BOTTOM<OBFrameMetadataType.AE_ROI_BOTTOM: 23>23
Auto-generated from C++ bindings
AE_ROI_LEFT<OBFrameMetadataType.AE_ROI_LEFT: 20>20
Auto-generated from C++ bindings
AE_ROI_RIGHT<OBFrameMetadataType.AE_ROI_RIGHT: 22>22
Auto-generated from C++ bindings
AE_ROI_TOP<OBFrameMetadataType.AE_ROI_TOP: 21>21
Auto-generated from C++ bindings
AUTO_EXPOSURE<OBFrameMetadataType.AUTO_EXPOSURE: 3>3
Auto-generated from C++ bindings
AUTO_WHITE_BALANCE<OBFrameMetadataType.AUTO_WHITE_BALANCE: 6>6
Auto-generated from C++ bindings
BRIGHTNESS<OBFrameMetadataType.BRIGHTNESS: 8>8
Auto-generated from C++ bindings
CONTRAST<OBFrameMetadataType.CONTRAST: 9>9
Auto-generated from C++ bindings
COUNT<OBFrameMetadataType.COUNT: 34>34
Auto-generated from C++ bindings
EXPOSURE<OBFrameMetadataType.EXPOSURE: 4>4
Auto-generated from C++ bindings
EXPOSURE_PRIORITY<OBFrameMetadataType.EXPOSURE_PRIORITY: 24>24
Auto-generated from C++ bindings
FRAME_NUMBER<OBFrameMetadataType.FRAME_NUMBER: 2>2
Auto-generated from C++ bindings
FRAME_RATE<OBFrameMetadataType.FRAME_RATE: 19>19
Auto-generated from C++ bindings
GAIN<OBFrameMetadataType.GAIN: 5>5
Auto-generated from C++ bindings
GAMMA<OBFrameMetadataType.GAMMA: 14>14
Auto-generated from C++ bindings
GPIO_INPUT_DATA<OBFrameMetadataType.GPIO_INPUT_DATA: 31>31
Auto-generated from C++ bindings
HDR_SEQUENCE_INDEX<OBFrameMetadataType.HDR_SEQUENCE_INDEX: 27>27
Auto-generated from C++ bindings
HDR_SEQUENCE_NAME<OBFrameMetadataType.HDR_SEQUENCE_NAME: 25>25
Auto-generated from C++ bindings
HDR_SEQUENCE_SIZE<OBFrameMetadataType.HDR_SEQUENCE_SIZE: 26>26
Auto-generated from C++ bindings
HUE<OBFrameMetadataType.HUE: 13>13
Auto-generated from C++ bindings
LASER_POWER<OBFrameMetadataType.LASER_POWER: 28>28
Auto-generated from C++ bindings
LASER_POWER_LEVEL<OBFrameMetadataType.LASER_POWER_LEVEL: 29>29
Auto-generated from C++ bindings
LASER_STATUS<OBFrameMetadataType.LASER_STATUS: 30>30
Auto-generated from C++ bindings
MANUAL_WHITE_BALANCE<OBFrameMetadataType.MANUAL_WHITE_BALANCE: 17>17
Auto-generated from C++ bindings
POWER_LINE_FREQUENCY<OBFrameMetadataType.POWER_LINE_FREQUENCY: 15>15
Auto-generated from C++ bindings
SATURATION<OBFrameMetadataType.SATURATION: 10>10
Auto-generated from C++ bindings
SENSOR_TIMESTAMP<OBFrameMetadataType.SENSOR_TIMESTAMP: 1>1
Auto-generated from C++ bindings
SHARPNESS<OBFrameMetadataType.SHARPNESS: 11>11
Auto-generated from C++ bindings
TIMESTAMP<OBFrameMetadataType.TIMESTAMP: 0>0
Auto-generated from C++ bindings
WHITE_BALANCE<OBFrameMetadataType.WHITE_BALANCE: 7>7
Auto-generated from C++ bindings
6.3.4.3. OBFormat
- class pyorbbecsdk.OBFormat
Bases:
pybind11_objectOBFormat Members Name
C++ Binding Object
Value
Description
ACCEL<OBFormat.ACCEL: 16>16
Auto-generated from C++ bindings
BA81<OBFormat.BA81: 30>30
Auto-generated from C++ bindings
BGR<OBFormat.BGR: 23>23
Auto-generated from C++ bindings
BGRA<OBFormat.BGRA: 25>25
Auto-generated from C++ bindings
BYR2<OBFormat.BYR2: 32>32
Auto-generated from C++ bindings
COMPRESSED<OBFormat.COMPRESSED: 26>26
Auto-generated from C++ bindings
GRAY<OBFormat.GRAY: 13>13
Auto-generated from C++ bindings
GYRO<OBFormat.GYRO: 17>17
Auto-generated from C++ bindings
H264<OBFormat.H264: 6>6
Auto-generated from C++ bindings
H265<OBFormat.H265: 7>7
Auto-generated from C++ bindings
HEVC<OBFormat.HEVC: 14>14
Auto-generated from C++ bindings
I420<OBFormat.I420: 15>15
Auto-generated from C++ bindings
LIDAR_CALIBRATION<OBFormat.LIDAR_CALIBRATION: 38>38
Auto-generated from C++ bindings
LIDAR_POINT<OBFormat.LIDAR_POINT: 35>35
Auto-generated from C++ bindings
LIDAR_SCAN<OBFormat.LIDAR_SCAN: 37>37
Auto-generated from C++ bindings
LIDAR_SPHERE_POINT<OBFormat.LIDAR_SPHERE_POINT: 36>36
Auto-generated from C++ bindings
MJPG<OBFormat.MJPG: 5>5
Auto-generated from C++ bindings
NV12<OBFormat.NV12: 3>3
Auto-generated from C++ bindings
NV21<OBFormat.NV21: 4>4
Auto-generated from C++ bindings
POINT<OBFormat.POINT: 19>19
Auto-generated from C++ bindings
RGB<OBFormat.RGB: 22>22
Auto-generated from C++ bindings
RGBA<OBFormat.RGBA: 31>31
Auto-generated from C++ bindings
RGB_POINT<OBFormat.RGB_POINT: 20>20
Auto-generated from C++ bindings
RLE<OBFormat.RLE: 21>21
Auto-generated from C++ bindings
RVL<OBFormat.RVL: 27>27
Auto-generated from C++ bindings
RW16<OBFormat.RW16: 33>33
Auto-generated from C++ bindings
UNKNOWN_FORMAT<OBFormat.UNKNOWN_FORMAT: -1>-1
Auto-generated from C++ bindings
UYVY<OBFormat.UYVY: 2>2
Auto-generated from C++ bindings
Y10<OBFormat.Y10: 10>10
Auto-generated from C++ bindings
Y11<OBFormat.Y11: 11>11
Auto-generated from C++ bindings
Y12<OBFormat.Y12: 12>12
Auto-generated from C++ bindings
Y12C4<OBFormat.Y12C4: 34>34
Auto-generated from C++ bindings
Y14<OBFormat.Y14: 24>24
Auto-generated from C++ bindings
Y16<OBFormat.Y16: 8>8
Auto-generated from C++ bindings
Y8<OBFormat.Y8: 9>9
Auto-generated from C++ bindings
YUY2<OBFormat.YUY2: 1>1
Auto-generated from C++ bindings
YUYV<OBFormat.YUYV: 0>0
Auto-generated from C++ bindings
YV12<OBFormat.YV12: 29>29
Auto-generated from C++ bindings
Z16<OBFormat.Z16: 28>28
Auto-generated from C++ bindings
6.3.4.4. OBMediaType
- class pyorbbecsdk.OBMediaType
Bases:
pybind11_objectOBMediaType Members Name
C++ Binding Object
Value
Description
ACCEL<OBMediaType.ACCEL: 16>16
Auto-generated from C++ bindings
CAMERA_PARAM<OBMediaType.CAMERA_PARAM: 32>32
Auto-generated from C++ bindings
COLOR<OBMediaType.COLOR: 1>1
Auto-generated from C++ bindings
DEPTH<OBMediaType.DEPTH: 2>2
Auto-generated from C++ bindings
DEVICE_INFO<OBMediaType.DEVICE_INFO: 64>64
Auto-generated from C++ bindings
GYRO<OBMediaType.GYRO: 8>8
Auto-generated from C++ bindings
IR<OBMediaType.IR: 4>4
Auto-generated from C++ bindings
LEFT_IR<OBMediaType.LEFT_IR: 256>256
Auto-generated from C++ bindings
RIGHT_IR<OBMediaType.RIGHT_IR: 512>512
Auto-generated from C++ bindings
STREAM_INFO<OBMediaType.STREAM_INFO: 128>128
Auto-generated from C++ bindings
6.3.4.5. OBMediaState
- class pyorbbecsdk.OBMediaState
Bases:
pybind11_objectOBMediaState Members Name
C++ Binding Object
Value
Description
OB_MEDIA_BEGIN<OBMediaState.OB_MEDIA_BEGIN: 0>0
Auto-generated from C++ bindings
OB_MEDIA_END<OBMediaState.OB_MEDIA_END: 3>3
Auto-generated from C++ bindings
OB_MEDIA_PAUSE<OBMediaState.OB_MEDIA_PAUSE: 1>1
Auto-generated from C++ bindings
OB_MEDIA_RESUME<OBMediaState.OB_MEDIA_RESUME: 2>2
Auto-generated from C++ bindings
6.3.4.6. OBPlaybackStatus
- class pyorbbecsdk.OBPlaybackStatus
Bases:
pybind11_objectOBPlaybackStatus Members Name
C++ Binding Object
Value
Description
COUNT<OBPlaybackStatus.COUNT: 4>4
Auto-generated from C++ bindings
PAUSED<OBPlaybackStatus.PAUSED: 2>2
Auto-generated from C++ bindings
PLAYING<OBPlaybackStatus.PLAYING: 1>1
Auto-generated from C++ bindings
STOPPED<OBPlaybackStatus.STOPPED: 3>3
Auto-generated from C++ bindings
UNKNOWN<OBPlaybackStatus.UNKNOWN: 0>0
Auto-generated from C++ bindings
6.3.5. Constants
- pyorbbecsdk.UNKNOWN = <OBPlaybackStatus.UNKNOWN: 0>
Members:
UNKNOWN
PLAYING
PAUSED
STOPPED
COUNT
- pyorbbecsdk.PAUSED = <OBPlaybackStatus.PAUSED: 2>
Members:
UNKNOWN
PLAYING
PAUSED
STOPPED
COUNT
- pyorbbecsdk.PLAYING = <OBPlaybackStatus.PLAYING: 1>
Members:
UNKNOWN
PLAYING
PAUSED
STOPPED
COUNT
- pyorbbecsdk.STOPPED = <OBPlaybackStatus.STOPPED: 3>
Members:
UNKNOWN
PLAYING
PAUSED
STOPPED
COUNT
- pyorbbecsdk.COUNT = <OBPlaybackStatus.COUNT: 4>
Members:
UNKNOWN
PLAYING
PAUSED
STOPPED
COUNT