| OrbbecSDK 1.5.7 OrbbecSDK: Software-Development-Kit for Orbbec 3D-Sensor devices

- 首页
- 命名空间
- 类
- 文件

- 类列表
- 类索引
- 类继承关系
- 类成员

Public 成员函数 | 所有成员列表
ob::VideoFrame类 参考

`#include <Frame.hpp>`

类 ob::VideoFrame 继承关系图:

## Public 成员函数
| VideoFrame (Frame &frame)
virtual | ~VideoFrame () noexcept
uint32_t | width ()
| 获取帧的宽 更多...
uint32_t | height ()
| 获取帧的高 更多...
void * | metadata ()
| 获取帧的元数据 更多...
uint32_t | metadataSize ()
| 获取帧的元数据大小 更多...
uint8_t | pixelAvailableBitSize ()
| 获取像素有效位数（如Y16格式帧，每个像素占16bit，但实际只有低10位是有效位，高6位填充0） 更多...
Public 成员函数 继承自 ob::Frame
| Frame (std::unique_ptr< FrameImpl > impl)
| Frame (Frame &frame)
virtual | ~Frame () noexcept
virtual OBFrameType | type ()
| 获取帧的类型 更多...
virtual OBFormat | format ()
| 获取帧的格式 更多...
virtual uint64_t | index ()
| 获取帧的序号 更多...
virtual void * | data ()
| 获取帧数据 更多...
virtual uint32_t | dataSize ()
| 获取帧数据大小 更多...
uint64_t | timeStamp ()
| 获取帧的硬件时间戳 更多...
uint64_t | timeStampUs ()
| 获取帧的硬件时间戳 更多...
uint64_t | systemTimeStamp ()
| 获取帧的系统时间戳 更多...
template<typename T >
bool | is ()
| 检查帧对象的运行时类型是否与给定类型兼容 更多...
template<typename T >
std::shared_ptr< T > | as ()
| 帧对象类型转换 更多...

## 额外继承的成员函数
Protected 属性 继承自 ob::Frame
std::unique_ptr< FrameImpl > | impl_

## 详细描述

在文件 Frame.hpp 第 201 行定义.

## 构造及析构函数说明

ob::VideoFrame::VideoFrame | ( | Frame & | frame | ) |

virtual ob::VideoFrame::~VideoFrame | ( |  | ) |
| inline virtual noexcept

在文件 Frame.hpp 第 204 行定义.

## 成员函数说明

uint32_t ob::VideoFrame::width | ( |  | ) |

获取帧的宽

返回
  uint32_t 返回帧的宽

uint32_t ob::VideoFrame::height | ( |  | ) |

获取帧的高

返回
  uint32_t 返回帧的高

void* ob::VideoFrame::metadata | ( |  | ) |

获取帧的元数据

返回
  void* 返回帧的元数据

uint32_t ob::VideoFrame::metadataSize | ( |  | ) |

获取帧的元数据大小

返回
  uint32_t 返回帧的元数据大小

uint8_t ob::VideoFrame::pixelAvailableBitSize | ( |  | ) |

获取像素有效位数（如Y16格式帧，每个像素占16bit，但实际只有低10位是有效位，高6位填充0）

注意
  仅对Y8/Y10/Y11/Y12/Y14/Y16格式有效

返回
  uint8_t 返回像素有效位数，如果是不支持的格式，返回0

该类的文档由以下文件生成:

- /root/libobsensor/include/libobsensor/hpp/Frame.hpp