Frame.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ObTypes.h"
 
uint64_t ob_frame_index(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_time_stamp_us(ob_frame *frame, ob_error **error);
 
uint64_t ob_frame_system_time_stamp(ob_frame *frame, ob_error **error);
 
uint64_t ob_frame_system_time_stamp_us(ob_frame *frame, ob_error **error);
 
uint64_t ob_frame_global_time_stamp_us(ob_frame *frame, ob_error **error);
 
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);
#define ob_video_frame_metadata ob_frame_metadata  // for compatibility
 
uint32_t ob_frame_metadata_size(ob_frame *frame, ob_error **error);
#define ob_video_frame_metadata_size ob_frame_metadata_size  // for compatibility
 
bool ob_frame_has_metadata(ob_frame *frame, ob_frame_metadata_type type, ob_error **error);
 
int64_t ob_frame_get_metadata_value(ob_frame *frame, ob_frame_metadata_type type, ob_error **error);
 
ob_stream_profile* ob_frame_get_stream_profile(ob_frame *frame, ob_error **error);
 
ob_sensor* ob_frame_get_sensor(ob_frame *frame, ob_error **error);
 
ob_device* ob_frame_get_device(ob_frame *frame, ob_error **error);
 
uint32_t ob_video_frame_width(ob_frame *frame, ob_error **error);
 
uint32_t ob_video_frame_height(ob_frame *frame, ob_error **error);
 
uint8_t ob_video_frame_pixel_available_bit_size(ob_frame *frame, ob_error **error);
 
ob_sensor_type ob_ir_frame_get_source_sensor_type(ob_frame *frame, ob_error **ob_error);
 
float ob_depth_frame_get_value_scale(ob_frame *frame, ob_error **error);
 
float ob_points_frame_get_position_value_scale(ob_frame *frame, ob_error **error);
 
void ob_delete_frame(ob_frame *frame, ob_error **error);
uint32_t ob_frameset_frame_count(ob_frame *frameset, ob_error **error);
ob_frame *ob_frameset_depth_frame(ob_frame *frameset, ob_error **error);
 
ob_frame *ob_frameset_color_frame(ob_frame *frameset, ob_error **error);
 
ob_frame *ob_frameset_ir_frame(ob_frame *frameset, ob_error **error);
 
ob_frame *ob_frameset_points_frame(ob_frame *frameset, ob_error **error);
 
ob_frame *ob_frameset_get_frame(ob_frame *frameset, ob_frame_type frame_type, ob_error **error);
 
ob_frame *ob_frameset_get_frame_by_index(ob_frame *frameset, int index, ob_error **error);
 
ob_accel_value ob_accel_frame_value(ob_frame *frame, ob_error **error);
 
float ob_accel_frame_temperature(ob_frame *frame, ob_error **error);
 
ob_gyro_value ob_gyro_frame_value(ob_frame *frame, ob_error **error);
 
float ob_gyro_frame_temperature(ob_frame *frame, ob_error **error);
 
void ob_frame_add_ref(ob_frame *frame, ob_error **error);
 
ob_frame *ob_create_frame(ob_format frame_format, int width, int height, int stride_bytes, ob_frame_type frame_type, ob_error **error);
 
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);
 
ob_frame *ob_create_frameset(ob_error **error);
 
void ob_frameset_push_frame(ob_frame *frameset, ob_frame_type type, ob_frame *frame, ob_error **error);
 
void ob_frame_set_system_time_stamp(ob_frame *frame, uint64_t system_timestamp, ob_error **error);
 
void ob_frame_set_device_time_stamp(ob_frame *frame, uint64_t device_timestamp, ob_error **error);
 
void ob_frame_set_device_time_stamp_us(ob_frame *frame, uint64_t device_timestamp_us, ob_error **error);
 
#ifdef __cplusplus
}
#endif