| OrbbecSDK 1.10.18 OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras

Loading...
Searching...
No Matches
Frame.h
Go to the documentation of this file.
1
6#pragma once
7
8#ifdef __cplusplus
9 extern "C" {
10#endif
11
12#include "ObTypes.h"
13
21uint64_t ob_frame_index(ob_frame *frame, ob_error **error);
22
30 ob_format ob_frame_format(ob_frame *frame, ob_error **error);
31
39 ob_frame_type ob_frame_get_type(ob_frame *frame, ob_error **error);
40
49uint64_t ob_frame_time_stamp(ob_frame *frame, ob_error **error);
50
59uint64_t ob_frame_time_stamp_us(ob_frame *frame, ob_error **error);
60
69uint64_t ob_frame_system_time_stamp(ob_frame *frame, ob_error **error);
70
79uint64_t ob_frame_system_time_stamp_us(ob_frame *frame, ob_error **error);
80
93uint64_t ob_frame_global_time_stamp_us(ob_frame *frame, ob_error **error);
94
102 void *ob_frame_data(ob_frame *frame, ob_error **error);
103
113uint32_t ob_frame_data_size(ob_frame *frame, ob_error **error);
114
122 void *ob_frame_metadata(ob_frame *frame, ob_error **error);
123#define ob_video_frame_metadata ob_frame_metadata // for compatibility
124
132uint32_t ob_frame_metadata_size(ob_frame *frame, ob_error **error);
133#define ob_video_frame_metadata_size ob_frame_metadata_size // for compatibility
134
142 bool ob_frame_has_metadata(ob_frame *frame, ob_frame_metadata_type type, ob_error **error);
143
152int64_t ob_frame_get_metadata_value(ob_frame *frame, ob_frame_metadata_type type, ob_error **error);
153
163 ob_stream_profile* ob_frame_get_stream_profile(ob_frame *frame, ob_error **error);
164
174 ob_sensor* ob_frame_get_sensor(ob_frame *frame, ob_error **error);
175
185 ob_device* ob_frame_get_device(ob_frame *frame, ob_error **error);
186
194uint32_t ob_video_frame_width(ob_frame *frame, ob_error **error);
195
203uint32_t ob_video_frame_height(ob_frame *frame, ob_error **error);
204
213uint8_t ob_video_frame_pixel_available_bit_size(ob_frame *frame, ob_error **error);
214
222 ob_sensor_type ob_ir_frame_get_source_sensor_type(ob_frame *frame, ob_error **ob_error);
223
232 float ob_depth_frame_get_value_scale(ob_frame *frame, ob_error **error);
233
243 float ob_points_frame_get_position_value_scale(ob_frame *frame, ob_error **error);
244
251 void ob_delete_frame(ob_frame *frame, ob_error **error);
259uint32_t ob_frameset_frame_count(ob_frame *frameset, ob_error **error);
267 ob_frame *ob_frameset_depth_frame(ob_frame *frameset, ob_error **error);
268
276 ob_frame *ob_frameset_color_frame(ob_frame *frameset, ob_error **error);
277
285 ob_frame *ob_frameset_ir_frame(ob_frame *frameset, ob_error **error);
286
294 ob_frame *ob_frameset_points_frame(ob_frame *frameset, ob_error **error);
295
304 ob_frame *ob_frameset_get_frame(ob_frame *frameset, ob_frame_type frame_type, ob_error **error);
305
314 ob_frame *ob_frameset_get_frame_by_index(ob_frame *frameset, int index, ob_error **error);
315
323 ob_accel_value ob_accel_frame_value(ob_frame *frame, ob_error **error);
324
332 float ob_accel_frame_temperature(ob_frame *frame, ob_error **error);
333
341 ob_gyro_value ob_gyro_frame_value(ob_frame *frame, ob_error **error);
342
350 float ob_gyro_frame_temperature(ob_frame *frame, ob_error **error);
351
358 void ob_frame_add_ref(ob_frame *frame, ob_error **error);
359
371 ob_frame *ob_create_frame(ob_format frame_format, int width, int height, int stride_bytes, ob_frame_type frame_type, ob_error **error);
372
386 ob_frame *ob_create_frame_from_buffer(ob_format frame_format, uint32_t frame_width, uint32_t frame_height, uint8_t *buffer, uint32_t buffer_size,
387 ob_frame_destroy_callback *buffer_destroy_cb, void *buffer_destroy_context, ob_error **error);
388
395 ob_frame *ob_create_frameset(ob_error **error);
396
405 void ob_frameset_push_frame(ob_frame *frameset, ob_frame_type type, ob_frame *frame, ob_error **error);
406
414 void ob_frame_set_system_time_stamp(ob_frame *frame, uint64_t system_timestamp, ob_error **error);
415
423 void ob_frame_set_device_time_stamp(ob_frame *frame, uint64_t device_timestamp, ob_error **error);
424
432 void ob_frame_set_device_time_stamp_us(ob_frame *frame, uint64_t device_timestamp_us, ob_error **error);
433
434#ifdef __cplusplus
435}
436#endif
ob_video_frame_width
uint32_t ob_video_frame_width(ob_frame *frame, ob_error **error)
Get video frame width.
ob_frameset_depth_frame
ob_frame * ob_frameset_depth_frame(ob_frame *frameset, ob_error **error)
Get the depth frame from the frameset.
ob_create_frame
ob_frame * ob_create_frame(ob_format frame_format, int width, int height, int stride_bytes, ob_frame_type frame_type, ob_error **error)
Create an empty frame object based on the specified parameters.
ob_frame_set_system_time_stamp
void ob_frame_set_system_time_stamp(ob_frame *frame, uint64_t system_timestamp, ob_error **error)
Set the system timestamp of a frame object.
ob_frameset_push_frame
void ob_frameset_push_frame(ob_frame *frameset, ob_frame_type type, ob_frame *frame, ob_error **error)
Add a frame of the specified type to the frameset.
ob_frame_global_time_stamp_us
uint64_t ob_frame_global_time_stamp_us(ob_frame *frame, ob_error **error)
Get the global timestamp of the frame in microseconds.
ob_frame_get_device
ob_device * ob_frame_get_device(ob_frame *frame, ob_error **error)
Get the device of the frame.
ob_frameset_ir_frame
ob_frame * ob_frameset_ir_frame(ob_frame *frameset, ob_error **error)
Get the infrared frame from the frameset.
ob_points_frame_get_position_value_scale
float ob_points_frame_get_position_value_scale(ob_frame *frame, ob_error **error)
Get the point position value scale of the points frame. The point position value of the points frame ...
ob_gyro_frame_temperature
float ob_gyro_frame_temperature(ob_frame *frame, ob_error **error)
Get the temperature when acquiring the gyroscope frame.
ob_frame_has_metadata
bool ob_frame_has_metadata(ob_frame *frame, ob_frame_metadata_type type, ob_error **error)
check if the frame contains the specified metadata
ob_frameset_frame_count
uint32_t ob_frameset_frame_count(ob_frame *frameset, ob_error **error)
Get the number of frames contained in the frameset.
ob_gyro_frame_value
ob_gyro_value ob_gyro_frame_value(ob_frame *frame, ob_error **error)
Get gyroscope frame data.
ob_video_frame_pixel_available_bit_size
uint8_t ob_video_frame_pixel_available_bit_size(ob_frame *frame, ob_error **error)
Get the effective number of pixels (such as Y16 format frame, but only the lower 10 bits are effectiv...
ob_video_frame_height
uint32_t ob_video_frame_height(ob_frame *frame, ob_error **error)
Get video frame height.
ob_frame_data
void * ob_frame_data(ob_frame *frame, ob_error **error)
Get frame data.
ob_frame_index
uint64_t ob_frame_index(ob_frame *frame, ob_error **error)
Get the frame index.
ob_frame_metadata_size
uint32_t ob_frame_metadata_size(ob_frame *frame, ob_error **error)
Get the metadata size of the frame.
ob_delete_frame
void ob_delete_frame(ob_frame *frame, ob_error **error)
Delete a frame object.
ob_frame_set_device_time_stamp_us
void ob_frame_set_device_time_stamp_us(ob_frame *frame, uint64_t device_timestamp_us, ob_error **error)
Set the device timestamp of a frame object.
ob_frameset_color_frame
ob_frame * ob_frameset_color_frame(ob_frame *frameset, ob_error **error)
Get the color frame from the frameset.
ob_depth_frame_get_value_scale
float ob_depth_frame_get_value_scale(ob_frame *frame, ob_error **error)
Get the value scale of the depth frame. The pixel value of the depth frame is multiplied by the scale...
ob_frameset_get_frame_by_index
ob_frame * ob_frameset_get_frame_by_index(ob_frame *frameset, int index, ob_error **error)
Get a frame at a specific index from the FrameSet.
ob_frame_time_stamp
uint64_t ob_frame_time_stamp(ob_frame *frame, ob_error **error)
Get the hardware timestamp of the frame in milliseconds.
ob_frame_set_device_time_stamp
void ob_frame_set_device_time_stamp(ob_frame *frame, uint64_t device_timestamp, ob_error **error)
Set the device timestamp of a frame object.
ob_frame_get_sensor
ob_sensor * ob_frame_get_sensor(ob_frame *frame, ob_error **error)
Get the sensor of the frame.
ob_create_frameset
ob_frame * ob_create_frameset(ob_error **error)
Create an empty frameset object.
ob_frame_time_stamp_us
uint64_t ob_frame_time_stamp_us(ob_frame *frame, ob_error **error)
Get the hardware timestamp of the frame in microseconds.
ob_frameset_points_frame
ob_frame * ob_frameset_points_frame(ob_frame *frameset, ob_error **error)
Get point cloud data from the frameset.
ob_accel_frame_temperature
float ob_accel_frame_temperature(ob_frame *frame, ob_error **error)
Get the temperature when acquiring the accelerometer frame.
ob_frame_data_size
uint32_t ob_frame_data_size(ob_frame *frame, ob_error **error)
Get the frame data size.
ob_accel_frame_value
ob_accel_value ob_accel_frame_value(ob_frame *frame, ob_error **error)
Get accelerometer frame data.
ob_frame_format
ob_format ob_frame_format(ob_frame *frame, ob_error **error)
Get the frame format.
ob_ir_frame_get_source_sensor_type
ob_sensor_type ob_ir_frame_get_source_sensor_type(ob_frame *frame, ob_error **ob_error)
Get the source sensor type of the ir frame (left or right for dual camera)
ob_frame_system_time_stamp_us
uint64_t ob_frame_system_time_stamp_us(ob_frame *frame, ob_error **error)
Get the system timestamp of the frame in microseconds.
ob_frame_metadata
void * ob_frame_metadata(ob_frame *frame, ob_error **error)
Get the metadata of the frame.
ob_frame_system_time_stamp
uint64_t ob_frame_system_time_stamp(ob_frame *frame, ob_error **error)
Get the system timestamp of the frame in milliseconds.
ob_frame_get_metadata_value
int64_t ob_frame_get_metadata_value(ob_frame *frame, ob_frame_metadata_type type, ob_error **error)
Get the metadata value of the frame.
ob_frame_get_type
ob_frame_type ob_frame_get_type(ob_frame *frame, ob_error **error)
Get the frame type.
ob_create_frame_from_buffer
ob_frame * ob_create_frame_from_buffer(ob_format frame_format, uint32_t frame_width, uint32_t frame_height, uint8_t *buffer, uint32_t buffer_size, ob_frame_destroy_callback *buffer_destroy_cb, void *buffer_destroy_context, ob_error **error)
Create a frame object based on an externally created buffer.
ob_frameset_get_frame
ob_frame * ob_frameset_get_frame(ob_frame *frameset, ob_frame_type frame_type, ob_error **error)
Get a frame of a specific type from the frameset.
ob_frame_add_ref
void ob_frame_add_ref(ob_frame *frame, ob_error **error)
Increase the reference count of a frame object.
ob_frame_get_stream_profile
ob_stream_profile * ob_frame_get_stream_profile(ob_frame *frame, ob_error **error)
Get the stream profile of the frame.
ObTypes.h
Provide structs commonly used in the SDK, enumerating constant definitions.
ob_format
enum OBFormat ob_format
ob_frame
struct CFrameImpl ob_frame
Definition ObTypes.h:63
ob_device
struct DeviceImpl ob_device
Definition ObTypes.h:55
ob_frame_destroy_callback
void() ob_frame_destroy_callback(void *buffer, void *user_data)
Customize the delete callback.
Definition ObTypes.h:1776
ob_sensor
struct SensorImpl ob_sensor
Definition ObTypes.h:59
ob_stream_profile
struct StreamProfileImpl ob_stream_profile
Definition ObTypes.h:61
ob_frame_type
enum OBFrameType ob_frame_type
ob_sensor_type
enum OBSensorType ob_sensor_type
ob_frame_metadata_type
ob_frame_metadata_type
Frame metadata types.
Definition ObTypes.h:1494
OBAccelValue
Data structures for accelerometers and gyroscopes.
Definition ObTypes.h:635
ob_error
The error class exposed by the SDK, users can get detailed error information according to the error.
Definition ObTypes.h:151