OrbbecSDK  1.0.0
函数
Frame.h 文件参考

帧相关函数,主要用于获取帧数据及帧的信息 更多...

#include "ObTypes.h"
Frame.h 的引用(Include)关系图:
此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

函数

uint64_t ob_frame_index (ob_frame *frame, ob_error **error)
 获取帧索引 更多...
 
uint32_t ob_frame_width (ob_frame *frame, ob_error **error)
 获取帧宽 更多...
 
uint32_t ob_frame_height (ob_frame *frame, ob_error **error)
 获取帧高 更多...
 
ob_format ob_frame_format (ob_frame *frame, ob_error **error)
 获取帧格式 更多...
 
ob_frame_type ob_frame_get_type (ob_frame *frame, ob_error **error)
 获取帧类型 更多...
 
uint64_t ob_frame_time_stamp (ob_frame *frame, ob_error **error)
 获取帧硬件时间戳 更多...
 
uint64_t ob_frame_system_time_stamp (ob_frame *frame, ob_error **error)
 获取帧系统时间戳 更多...
 
float ob_depth_frame_get_value_scale (ob_frame *frame, ob_error **error)
 获取深度帧的值刻度,单位为 mm/step, 如valueScale=0.1, 某坐标像素值为pixelValue=10000, 则表示深度值value = pixelValue*valueScale = 10000*0.1=1000mm。 更多...
 
void * ob_frame_data (ob_frame *frame, ob_error **error)
 获取帧数据 更多...
 
uint32_t ob_frame_data_size (ob_frame *frame, ob_error **error)
 获取帧数据大小 更多...
 
void * ob_frame_metadata (ob_frame *frame, ob_error **error)
 获取帧的元数据 更多...
 
uint32_t ob_frame_metadata_size (ob_frame *frame, ob_error **error)
 获取帧的元数据大小 更多...
 
ob_stream_type ob_frame_get_stream_type (ob_frame *frame, ob_error **error)
 获取帧的流类型 更多...
 
void ob_delete_frame (ob_frame *frame, ob_error **error)
 删除帧 更多...
 
uint32_t ob_frame_set_frame_count (ob_frame_set *frame_set, ob_error **error)
 获取帧集合包含的帧数量 更多...
 
ob_frame * ob_frame_set_depth_frame (ob_frame_set *frame_set, ob_error **error)
 从帧集合中获取深度帧 更多...
 
ob_frame * ob_frame_set_color_frame (ob_frame_set *frame_set, ob_error **error)
 从帧集合中获取彩色帧 更多...
 
ob_frame * ob_frame_set_ir_frame (ob_frame_set *frame_set, ob_error **error)
 从帧集合中获取红外帧 更多...
 
void ob_delete_frame_set (ob_frame_set *frame_set, ob_error **error)
 删除帧集合 更多...
 

详细描述

帧相关函数,主要用于获取帧数据及帧的信息

在文件 Frame.h 中定义.

函数说明

void ob_delete_frame ( ob_frame *  frame,
ob_error **  error 
)

删除帧

参数
[in]frame要删除的帧对象
[out]error记录错误信息
void ob_delete_frame_set ( ob_frame_set *  frame_set,
ob_error **  error 
)

删除帧集合

参数
[in]frame_set帧集合对象
[out]error记录错误信息
float ob_depth_frame_get_value_scale ( ob_frame *  frame,
ob_error **  error 
)

获取深度帧的值刻度,单位为 mm/step, 如valueScale=0.1, 某坐标像素值为pixelValue=10000, 则表示深度值value = pixelValue*valueScale = 10000*0.1=1000mm。

参数
[in]frame帧对象
[out]error记录错误信息
返回
float 值刻度
void* ob_frame_data ( ob_frame *  frame,
ob_error **  error 
)

获取帧数据

参数
[in]frame帧对象
[out]error记录错误信息
返回
void* 返回帧数据指针
uint32_t ob_frame_data_size ( ob_frame *  frame,
ob_error **  error 
)

获取帧数据大小

参数
[in]frame帧对象
[out]error记录错误信息
返回
uint32_t 返回帧数据大小
ob_format ob_frame_format ( ob_frame *  frame,
ob_error **  error 
)

获取帧格式

参数
[in]frame帧对象
[out]error记录错误信息
返回
ob_format 返回帧格式
ob_stream_type ob_frame_get_stream_type ( ob_frame *  frame,
ob_error **  error 
)

获取帧的流类型

参数
[in]frame帧对象
[out]error记录错误信息
返回
ob_stream_type 返回流类型
ob_frame_type ob_frame_get_type ( ob_frame *  frame,
ob_error **  error 
)

获取帧类型

参数
[in]frame帧对象
[out]error记录错误信息
返回
ob_frame_type 返回帧类型
uint32_t ob_frame_height ( ob_frame *  frame,
ob_error **  error 
)

获取帧高

参数
[in]frame帧对象
[out]error记录错误信息
返回
uint32_t 返回帧高
uint64_t ob_frame_index ( ob_frame *  frame,
ob_error **  error 
)

获取帧索引

参数
[in]frame帧对象
[out]error记录错误信息
返回
uint64_t 返回帧索引
void* ob_frame_metadata ( ob_frame *  frame,
ob_error **  error 
)

获取帧的元数据

参数
[in]frame帧对象
[out]error记录错误信息
返回
void* 返回帧的元数据指针
uint32_t ob_frame_metadata_size ( ob_frame *  frame,
ob_error **  error 
)

获取帧的元数据大小

参数
[in]frame帧对象
[out]error记录错误信息
返回
uint32_t 返回帧的元数据大小
ob_frame* ob_frame_set_color_frame ( ob_frame_set *  frame_set,
ob_error **  error 
)

从帧集合中获取彩色帧

参数
[in]frame_set帧集合对象
[out]error记录错误信息
返回
ob_frame* 返回彩色帧
ob_frame* ob_frame_set_depth_frame ( ob_frame_set *  frame_set,
ob_error **  error 
)

从帧集合中获取深度帧

参数
[in]frame_set帧集合对象
[out]error记录错误信息
返回
ob_frame* 返回深度帧
uint32_t ob_frame_set_frame_count ( ob_frame_set *  frame_set,
ob_error **  error 
)

获取帧集合包含的帧数量

参数
[in]frame_set帧集合对象
[out]error记录错误信息
返回
uint32_t 返回帧数量
ob_frame* ob_frame_set_ir_frame ( ob_frame_set *  frame_set,
ob_error **  error 
)

从帧集合中获取红外帧

参数
[in]frame_set帧集合对象
[out]error记录错误信息
返回
ob_frame* 返回红外帧
uint64_t ob_frame_system_time_stamp ( ob_frame *  frame,
ob_error **  error 
)

获取帧系统时间戳

参数
[in]frame帧对象
[out]error记录错误信息
返回
uint64_t 返回帧系统时间戳
uint64_t ob_frame_time_stamp ( ob_frame *  frame,
ob_error **  error 
)

获取帧硬件时间戳

参数
[in]frame帧对象
[out]error记录错误信息
返回
uint64_t 返回帧硬件时间戳
uint32_t ob_frame_width ( ob_frame *  frame,
ob_error **  error 
)

获取帧宽

参数
[in]frame帧对象
[out]error记录错误信息
返回
uint32_t 返回帧宽