OrbbecSDK  1.0.0
Device.h
浏览该文件的文档.
1 
6 #pragma once
7 
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
12 #include "ObTypes.h"
13 
21 uint32_t ob_device_list_device_count( ob_device_list* list, ob_error** error );
22 
31 ob_device_info* ob_device_list_get_device_info( ob_device_list* list, uint32_t index, ob_error** error );
32 
41 const char* ob_device_list_get_device_name( ob_device_list* list, uint32_t index, ob_error** error );
42 
51 int ob_device_list_get_device_pid( ob_device_list* list, uint32_t index, ob_error** error );
52 
61 int ob_device_list_get_device_vid( ob_device_list* list, uint32_t index, ob_error** error );
62 
71 const char* ob_device_list_get_device_uid( ob_device_list* list, uint32_t index, ob_error** error );
72 
82 ob_device* ob_get_device( ob_device_list* list, uint32_t index, ob_error** error );
83 
90 void ob_delete_device( ob_device* device, ob_error** error );
91 
98 void ob_delete_device_info( ob_device_info* info, ob_error** error );
99 
106 void ob_delete_device_list( ob_device_list* list, ob_error** error );
107 
115 ob_device_info* ob_device_get_device_info( ob_device* device, ob_error** error );
116 
124 ob_sensor_list* ob_device_get_sensor_list( ob_device* device, ob_error** error );
125 
134 ob_sensor* ob_device_get_sensor( ob_device* device, ob_sensor_type type, ob_error** error );
143 void ob_device_set_int_property( ob_device* device, ob_global_unified_property property_id, int32_t property, ob_error** error );
144 
153 int32_t ob_device_get_int_property( ob_device* device, ob_global_unified_property property_id, ob_error** error );
154 
163 void ob_device_set_float_property( ob_device* device, ob_global_unified_property property_id, float property, ob_error** error );
164 
173 float ob_device_get_float_property( ob_device* device, ob_global_unified_property property_id, ob_error** error );
174 
183 void ob_device_set_bool_property( ob_device* device, ob_global_unified_property property_id, bool property, ob_error** error );
184 
193 bool ob_device_get_bool_property( ob_device* device, ob_global_unified_property property_id, ob_error** error );
194 
204 void ob_device_set_structured_data( ob_device* device, ob_global_unified_property property_id, const void* data, uint32_t data_size, ob_error** error );
205 
215 void ob_device_get_structured_data( ob_device* device, ob_global_unified_property property_id, void* data, uint32_t* data_size, ob_error** error );
216 
229 bool ob_device_set_raw_data( ob_device* device, ob_global_unified_property property_id, void* data, uint32_t data_size, ob_set_data_callback cb, bool async, void* user_data, ob_error** error );
230 
241 bool ob_device_get_raw_data( ob_device* device, ob_global_unified_property property_id, ob_get_data_callback cb, bool async, void* user_data, ob_error** error );
242 
251 bool ob_device_is_property_supported( ob_device* device, ob_global_unified_property property_id, ob_error** error );
252 
261 ob_int_property_range ob_device_get_int_property_range( ob_device* device, ob_global_unified_property property_id, ob_error** error );
262 
271 ob_float_property_range ob_device_get_float_property_range( ob_device* device, ob_global_unified_property property_id, ob_error** error );
272 
281 ob_bool_property_range ob_device_get_bool_property_range( ob_device* device, ob_global_unified_property property_id, ob_error** error );
282 
292 void ob_device_write_ahb( ob_device* device, uint32_t reg, uint32_t mask, uint32_t value, ob_error** error );
293 
303 void ob_device_read_ahb( ob_device* device, uint32_t reg, uint32_t mask, uint32_t* value, ob_error** error );
304 
315 void ob_device_write_i2c( ob_device* device, uint32_t module_id, uint32_t reg, uint32_t mask, uint32_t value, ob_error** error );
316 
327 void ob_device_read_i2c( ob_device* device, uint32_t module_id, uint32_t reg, uint32_t mask, uint32_t* value, ob_error** error );
328 
341 bool ob_device_write_flash( ob_device* device, uint32_t offset, const void* data, uint32_t data_size, ob_set_data_callback cb, bool async, void* user_data, ob_error** error );
342 
354 bool ob_device_read_flash( ob_device* device, uint32_t offset, uint32_t data_size, ob_get_data_callback cb, bool async, void* user_data, ob_error** error );
355 
363 uint64_t ob_device_sync_device_time( ob_device* device, ob_error** error );
364 
376 bool ob_device_upgrade( ob_device* device, const char* path, ob_device_upgrade_callback callback, bool async, void* user_data, ob_error** error );
377 
383 ob_device_state ob_device_get_device_state( ob_device* device, ob_error** error );
384 
393 void ob_device_state_changed( ob_device* device, ob_device_state_callback callback, void* user_data, ob_error** error );
394 
407 bool ob_device_send_file_to_destination( ob_device* device, const char* file_path, const char* dst_path, ob_file_send_callback callback, bool async, void* user_data, ob_error** error );
408 
417 bool ob_device_activate_authorization( ob_device* device, const char* auth_code, ob_error** error );
418 
426 void ob_device_write_authorization_code( ob_device* device, const char* auth_code, ob_error** error );
427 
437 ob_camera_intrinsic ob_device_get_camera_intrinsic( ob_device* device, ob_sensor_type sensor_type, ob_error** error );
438 
448 ob_camera_distortion ob_device_get_camera_distortion( ob_device* device, ob_sensor_type sensor_type, ob_error** error );
449 
458 ob_d2c_transform ob_device_get_d2c_transform( ob_device* device, ob_error** error );
459 
467 const char* ob_device_info_name( ob_device_info* info, ob_error** error );
468 
476 int ob_device_info_pid( ob_device_info* info, ob_error** error );
477 
485 int ob_device_info_vid( ob_device_info* info, ob_error** error );
486 
494 const char* ob_device_info_uid( ob_device_info* info, ob_error** error );
495 
503 const char* ob_device_info_serial_number( ob_device_info* info, ob_error** error );
504 
512 const char* ob_device_info_firmware_version( ob_device_info* info, ob_error** error );
513 
521 const char* ob_device_info_usb_type( ob_device_info* info, ob_error** error );
522 
523 #ifdef __cplusplus
524 }
525 #endif
const char * ob_device_info_name(ob_device_info *info, ob_error **error)
获取设备名
bool ob_device_write_flash(ob_device *device, uint32_t offset, const void *data, uint32_t data_size, ob_set_data_callback cb, bool async, void *user_data, ob_error **error)
设置写入Flash的属性[异步回调]
提供SDK常用的的结构体、枚举常量定义。
ob_camera_intrinsic ob_device_get_camera_intrinsic(ob_device *device, ob_sensor_type sensor_type, ob_error **error)
获取相机内参(会根据当前镜像状态返回)
ob_camera_distortion ob_device_get_camera_distortion(ob_device *device, ob_sensor_type sensor_type, ob_error **error)
获取相机畸变参数(会根据当前镜像状态返回)
void ob_delete_device_info(ob_device_info *info, ob_error **error)
删除设备信息
void ob_device_write_authorization_code(ob_device *device, const char *auth_code, ob_error **error)
写入设备授权码
bool ob_device_set_raw_data(ob_device *device, ob_global_unified_property property_id, void *data, uint32_t data_size, ob_set_data_callback cb, bool async, void *user_data, ob_error **error)
设置raw data类型d 设备属性
void ob_delete_device(ob_device *device, ob_error **error)
删除设备
const char * ob_device_info_firmware_version(ob_device_info *info, ob_error **error)
获取固件版本号
void ob_device_set_structured_data(ob_device *device, ob_global_unified_property property_id, const void *data, uint32_t data_size, ob_error **error)
设置结构体类型的设备属性
int32_t ob_device_get_int_property(ob_device *device, ob_global_unified_property property_id, ob_error **error)
获取int类型的设备属性
bool ob_device_send_file_to_destination(ob_device *device, const char *file_path, const char *dst_path, ob_file_send_callback callback, bool async, void *user_data, ob_error **error)
发送文件到设备指定路径
ob_device_state ob_device_get_device_state(ob_device *device, ob_error **error)
获取当前设备状态
int ob_device_info_vid(ob_device_info *info, ob_error **error)
获取设备vid
void ob_device_read_ahb(ob_device *device, uint32_t reg, uint32_t mask, uint32_t *value, ob_error **error)
ahb读寄存器
ob_float_property_range ob_device_get_float_property_range(ob_device *device, ob_global_unified_property property_id, ob_error **error)
获取float类型的设备属性范围
void ob_device_read_i2c(ob_device *device, uint32_t module_id, uint32_t reg, uint32_t mask, uint32_t *value, ob_error **error)
i2c读寄存器
uint64_t ob_device_sync_device_time(ob_device *device, ob_error **error)
同步设备时间(向设备授时,同步本地系统时间到设备)
ob_device_info * ob_device_list_get_device_info(ob_device_list *list, uint32_t index, ob_error **error)
获取设备信息
bool ob_device_activate_authorization(ob_device *device, const char *auth_code, ob_error **error)
验证设备授权码
void ob_device_write_i2c(ob_device *device, uint32_t module_id, uint32_t reg, uint32_t mask, uint32_t value, ob_error **error)
i2c写寄存器
int ob_device_info_pid(ob_device_info *info, ob_error **error)
获取设备pid
ob_int_property_range ob_device_get_int_property_range(ob_device *device, ob_global_unified_property property_id, ob_error **error)
获取int类型的设备属性范围
ob_device_info * ob_device_get_device_info(ob_device *device, ob_error **error)
获取设备信息
bool ob_device_get_raw_data(ob_device *device, ob_global_unified_property property_id, ob_get_data_callback cb, bool async, void *user_data, ob_error **error)
获取raw data类型的设备属性
ob_bool_property_range ob_device_get_bool_property_range(ob_device *device, ob_global_unified_property property_id, ob_error **error)
获取bool类型的设备属性范围
int ob_device_list_get_device_pid(ob_device_list *list, uint32_t index, ob_error **error)
获取指定设备pid
bool ob_device_is_property_supported(ob_device *device, ob_global_unified_property property_id, ob_error **error)
判断设备属性是否支持
uint32_t ob_device_list_device_count(ob_device_list *list, ob_error **error)
获取设备数量
ob_sensor_type
描述传感器类型的枚举值
Definition: ObTypes.h:341
const char * ob_device_info_serial_number(ob_device_info *info, ob_error **error)
获取设备序列号
void ob_device_write_ahb(ob_device *device, uint32_t reg, uint32_t mask, uint32_t value, ob_error **error)
ahb写寄存器
void ob_delete_device_list(ob_device_list *list, ob_error **error)
删除设备列表
const char * ob_device_list_get_device_uid(ob_device_list *list, uint32_t index, ob_error **error)
获取指定设备uid
ob_sensor * ob_device_get_sensor(ob_device *device, ob_sensor_type type, ob_error **error)
获取设备的传感器
ob_device * ob_get_device(ob_device_list *list, uint32_t index, ob_error **error)
创建设备
const char * ob_device_info_uid(ob_device_info *info, ob_error **error)
获取设备uid
float ob_device_get_float_property(ob_device *device, ob_global_unified_property property_id, ob_error **error)
获取float类型的设备属性
const char * ob_device_info_usb_type(ob_device_info *info, ob_error **error)
获取usb连接类型
void ob_device_set_int_property(ob_device *device, ob_global_unified_property property_id, int32_t property, ob_error **error)
设置int类型的设备属性
bool ob_device_get_bool_property(ob_device *device, ob_global_unified_property property_id, ob_error **error)
获取bool类型的设备属性
void ob_device_get_structured_data(ob_device *device, ob_global_unified_property property_id, void *data, uint32_t *data_size, ob_error **error)
获取结构体类型的设备属性
int ob_device_list_get_device_vid(ob_device_list *list, uint32_t index, ob_error **error)
获取指定设备vid
const char * ob_device_list_get_device_name(ob_device_list *list, uint32_t index, ob_error **error)
获取指定设备名称
void ob_device_set_float_property(ob_device *device, ob_global_unified_property property_id, float property, ob_error **error)
设置float类型的设备属性
bool ob_device_upgrade(ob_device *device, const char *path, ob_device_upgrade_callback callback, bool async, void *user_data, ob_error **error)
设备固件升级
bool ob_device_read_flash(ob_device *device, uint32_t offset, uint32_t data_size, ob_get_data_callback cb, bool async, void *user_data, ob_error **error)
读取Flash的属性[异步回调]
ob_sensor_list * ob_device_get_sensor_list(ob_device *device, ob_error **error)
获取设备的所有传感器
void ob_device_set_bool_property(ob_device *device, ob_global_unified_property property_id, bool property, ob_error **error)
设置bool类型的设备属性
void ob_device_state_changed(ob_device *device, ob_device_state_callback callback, void *user_data, ob_error **error)
设置设备状态监听
SDK的对外暴露的错误类,用户可以根据该错误类,获取详细的错误信息 ob_status: 描述错误的状态码,作为兼容...
Definition: ObTypes.h:329
ob_d2c_transform ob_device_get_d2c_transform(ob_device *device, ob_error **error)
获取d2c旋转矩阵(会根据当前镜像状态返回)