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

Loading...
Searching...
No Matches
Device.h
Go to the documentation of this file.
1
5#pragma once
6
7#ifdef __cplusplus
8 extern "C" {
9#endif
10
11#include "ObTypes.h"
12#include "Property.h"
13#include "MultipleDevices.h"
14
22uint32_t ob_device_list_device_count(ob_device_list *list, ob_error **error);
23
32 const char *ob_device_list_get_device_name(ob_device_list *list, uint32_t index, ob_error **error);
33
42 int ob_device_list_get_device_pid(ob_device_list *list, uint32_t index, ob_error **error);
43
52 int ob_device_list_get_device_vid(ob_device_list *list, uint32_t index, ob_error **error);
53
62 const char *ob_device_list_get_device_uid(ob_device_list *list, uint32_t index, ob_error **error);
63
72 const char *ob_device_list_get_device_serial_number(ob_device_list *list, uint32_t index, ob_error **error);
73
83 const char *ob_device_list_get_device_connection_type(ob_device_list *list, uint32_t index, ob_error **error);
84
95 const char *ob_device_list_get_device_ip_address(ob_device_list *list, uint32_t index, ob_error **error);
96
105 const char *ob_device_list_get_extension_info(ob_device_list *list, uint32_t index, ob_error **error);
106
118 ob_device *ob_device_list_get_device(ob_device_list *list, uint32_t index, ob_error **error);
119
130 ob_device *ob_device_list_get_device_by_serial_number(ob_device_list *list, const char *serial_number, ob_error **error);
131
145 ob_device *ob_device_list_get_device_by_uid(ob_device_list *list, const char *uid, ob_error **error);
146
153 void ob_delete_device(ob_device *device, ob_error **error);
154
161 void ob_delete_device_info(ob_device_info *info, ob_error **error);
162
169 void ob_delete_device_list(ob_device_list *list, ob_error **error);
170
178 ob_device_info *ob_device_get_device_info(ob_device *device, ob_error **error);
179
187 ob_sensor_list *ob_device_get_sensor_list(ob_device *device, ob_error **error);
188
197 ob_sensor *ob_device_get_sensor(ob_device *device, ob_sensor_type type, ob_error **error);
198
207 void ob_device_set_int_property(ob_device *device, ob_property_id property_id, int32_t property, ob_error **error);
208
217int32_t ob_device_get_int_property(ob_device *device, ob_property_id property_id, ob_error **error);
218
227 void ob_device_set_float_property(ob_device *device, ob_property_id property_id, float property, ob_error **error);
228
237 float ob_device_get_float_property(ob_device *device, ob_property_id property_id, ob_error **error);
238
247 void ob_device_set_bool_property(ob_device *device, ob_property_id property_id, bool property, ob_error **error);
248
257 bool ob_device_get_bool_property(ob_device *device, ob_property_id property_id, ob_error **error);
258
268 void ob_device_set_structured_data(ob_device *device, ob_property_id property_id, const void *data, uint32_t data_size, ob_error **error);
269
279 void ob_device_get_structured_data(ob_device *device, ob_property_id property_id, void *data, uint32_t *data_size, ob_error **error);
280
291 void ob_device_set_structured_data_ext(ob_device *device, ob_property_id property_id, ob_data_bundle *data_bundle, ob_set_data_callback cb, void *user_data,
292 ob_error **error);
293
302 ob_data_bundle *ob_device_get_structured_data_ext(ob_device *device, ob_property_id property_id, ob_error **error);
303
316 void ob_device_set_raw_data(ob_device *device, ob_property_id property_id, void *data, uint32_t data_size, ob_set_data_callback cb, bool async, void *user_data,
317 ob_error **error);
318
329 void ob_device_get_raw_data(ob_device *device, ob_property_id property_id, ob_get_data_callback cb, bool async, void *user_data, ob_error **error);
330
338 ob_protocol_version ob_device_get_protocol_version(ob_device *device, ob_error **error);
339
348 ob_cmd_version ob_device_get_cmd_version(ob_device *device, ob_property_id property_id, ob_error **error);
349
357uint32_t ob_device_get_supported_property_count(ob_device *device, ob_error **error);
358
367 ob_property_item ob_device_get_supported_property(ob_device *device, uint32_t index, ob_error **error);
368
378 bool ob_device_is_property_supported(ob_device *device, ob_property_id property_id, ob_permission_type permission, ob_error **error);
379
388 ob_int_property_range ob_device_get_int_property_range(ob_device *device, ob_property_id property_id, ob_error **error);
389
398 ob_float_property_range ob_device_get_float_property_range(ob_device *device, ob_property_id property_id, ob_error **error);
399
408 ob_bool_property_range ob_device_get_bool_property_range(ob_device *device, ob_property_id property_id, ob_error **error);
409
419 void ob_device_write_ahb(ob_device *device, uint32_t reg, uint32_t mask, uint32_t value, ob_error **error);
420
430 void ob_device_read_ahb(ob_device *device, uint32_t reg, uint32_t mask, uint32_t *value, ob_error **error);
431
442 void ob_device_write_i2c(ob_device *device, uint32_t module_id, uint32_t reg, uint32_t mask, uint32_t value, ob_error **error);
443
454 void ob_device_read_i2c(ob_device *device, uint32_t module_id, uint32_t reg, uint32_t mask, uint32_t *value, ob_error **error);
455
468 void 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,
469 ob_error **error);
470
482 void 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);
483
492 void ob_device_write_customer_data(ob_device *device, const void *data, uint32_t data_size, ob_error **error);
493
502 void ob_device_read_customer_data(ob_device *device, void *data, uint32_t *data_size, ob_error **error);
503
514 void ob_device_upgrade(ob_device *device, const char *path, ob_device_upgrade_callback callback, bool async, void *user_data, ob_error **error);
515
527 void ob_device_upgrade_from_data(ob_device *device, const char *file_data, uint32_t file_size, ob_device_upgrade_callback callback, bool async, void *user_data,
528 ob_error **error);
529
538 ob_device_state ob_device_get_device_state(ob_device *device, ob_error **error);
539
548 void ob_device_state_changed(ob_device *device, ob_device_state_callback callback, void *user_data, ob_error **error);
549
561 void ob_device_send_file_to_destination(ob_device *device, const char *file_path, const char *dst_path, ob_file_send_callback callback, bool async,
562 void *user_data, ob_error **error);
563
573 bool ob_device_activate_authorization(ob_device *device, const char *auth_code, ob_error **error);
574
582 void ob_device_write_authorization_code(ob_device *device, const char *auth_code, ob_error **error);
583
596 ob_camera_param_list *ob_device_get_calibration_camera_param_list(ob_device *device, ob_error **error);
597
606 ob_depth_work_mode ob_device_get_current_depth_work_mode(ob_device *device, ob_error **error);
607
618 ob_status ob_device_switch_depth_work_mode(ob_device *device, const ob_depth_work_mode *work_mode, ob_error **error);
619
629 ob_status ob_device_switch_depth_work_mode_by_name(ob_device *device, const char *mode_name, ob_error **error);
630
639 ob_depth_work_mode_list *ob_device_get_depth_work_mode_list(ob_device *device, ob_error **error);
640
649 void ob_device_reboot(ob_device *device, ob_error **error);
650
660 ob_device_sync_config ob_device_get_sync_config(ob_device *device, ob_error **error);
661
673 void ob_device_set_sync_config(ob_device *device, ob_device_sync_config device_sync_config, ob_error **error);
674
682 const char *ob_device_info_name(ob_device_info *info, ob_error **error);
683
691 int ob_device_info_pid(ob_device_info *info, ob_error **error);
692
700 int ob_device_info_vid(ob_device_info *info, ob_error **error);
701
709 const char *ob_device_info_uid(ob_device_info *info, ob_error **error);
710
718 const char *ob_device_info_serial_number(ob_device_info *info, ob_error **error);
719
727 const char *ob_device_info_firmware_version(ob_device_info *info, ob_error **error);
728
736 const char *ob_device_info_usb_type(ob_device_info *info, ob_error **error);
737
745 const char *ob_device_info_connection_type(ob_device_info *info, ob_error **error);
746
756 const char *ob_device_info_ip_address(ob_device_info *info, ob_error **error);
757
765 const char *ob_device_info_hardware_version(ob_device_info *info, ob_error **error);
766
774 const char *ob_device_info_get_extension_info(ob_device_info *info, ob_error **error);
775
783 const char *ob_device_info_supported_min_sdk_version(ob_device_info *info, ob_error **error);
784
792 const char *ob_device_info_asicName(ob_device_info *info, ob_error **error);
793
801 ob_device_type ob_device_info_device_type(ob_device_info *info, ob_error **error);
802
810uint32_t ob_camera_param_list_count(ob_camera_param_list *param_list, ob_error **error);
811
820 ob_camera_param ob_camera_param_list_get_param(ob_camera_param_list *param_list, uint32_t index, ob_error **error);
821
828 void ob_delete_camera_param_list(ob_camera_param_list *param_list, ob_error **error);
829
838uint32_t ob_depth_work_mode_list_count(ob_depth_work_mode_list *work_mode_list, ob_error **error);
839
849 ob_depth_work_mode ob_depth_work_mode_list_get_item(ob_depth_work_mode_list *work_mode_list, uint32_t index, ob_error **error);
850
858 void ob_delete_depth_work_mode_list(ob_depth_work_mode_list *work_mode_list, ob_error **error);
859
866 void ob_delete_data_bundle(ob_data_bundle *data_bundle, ob_error **error);
867
875 bool ob_device_is_global_timestamp_supported(ob_device *device, ob_error **error);
876
883 void ob_device_load_depth_filter_config(ob_device *device, const char *file_path, ob_error **error);
884
890 void ob_device_reset_default_depth_filter_config(ob_device *device, ob_error **error);
891
900 const char *ob_device_get_current_preset_name(ob_device *device, ob_error **error);
901
911 void ob_device_load_preset(ob_device *device, const char *preset_name, ob_error **error);
912
922 void ob_device_load_preset_from_json_file(ob_device *device, const char *json_file_path, ob_error **error);
923
932 void ob_device_export_current_settings_as_preset_json_file(ob_device *device, const char *json_file_path, ob_error **error);
933
941 ob_device_preset_list *ob_device_get_available_preset_list(ob_device *device, ob_error **error);
942
949 void ob_delete_preset_list(ob_device_preset_list *preset_list, ob_error **error);
950
958uint32_t ob_device_preset_list_count(ob_device_preset_list *preset_list, ob_error **error);
959
968 const char *ob_device_preset_list_get_name(ob_device_preset_list *preset_list, uint32_t index, ob_error **error);
969
978 bool ob_device_preset_list_has_preset(ob_device_preset_list *preset_list, const char *preset_name, ob_error **error);
979
980#ifdef __cplusplus
981}
982#endif
ob_device_write_authorization_code
void ob_device_write_authorization_code(ob_device *device, const char *auth_code, ob_error **error)
Write the device authorization code.
ob_camera_param_list_count
uint32_t ob_camera_param_list_count(ob_camera_param_list *param_list, ob_error **error)
Get the number of camera parameter lists.
ob_device_set_structured_data_ext
void ob_device_set_structured_data_ext(ob_device *device, ob_property_id property_id, ob_data_bundle *data_bundle, ob_set_data_callback cb, void *user_data, ob_error **error)
Set structured data of a device property.
ob_device_get_bool_property_range
ob_bool_property_range ob_device_get_bool_property_range(ob_device *device, ob_property_id property_id, ob_error **error)
Get the boolean type of device property range.
ob_device_is_property_supported
bool ob_device_is_property_supported(ob_device *device, ob_property_id property_id, ob_permission_type permission, ob_error **error)
Check if a device property permission is supported.
ob_device_get_int_property_range
ob_int_property_range ob_device_get_int_property_range(ob_device *device, ob_property_id property_id, ob_error **error)
Get the integer type of device property range.
ob_device_list_device_count
uint32_t ob_device_list_device_count(ob_device_list *list, ob_error **error)
Get the number of devices.
ob_device_state_changed
void ob_device_state_changed(ob_device *device, ob_device_state_callback callback, void *user_data, ob_error **error)
Monitor device state changes.
ob_device_info_name
const char * ob_device_info_name(ob_device_info *info, ob_error **error)
Get device name.
ob_device_list_get_device_name
const char * ob_device_list_get_device_name(ob_device_list *list, uint32_t index, ob_error **error)
Get device name (DEPRECATED)
ob_depth_work_mode_list_count
uint32_t ob_depth_work_mode_list_count(ob_depth_work_mode_list *work_mode_list, ob_error **error)
ob_device_set_sync_config
void ob_device_set_sync_config(ob_device *device, ob_device_sync_config device_sync_config, ob_error **error)
Set the device synchronization configuration.
ob_device_get_float_property_range
ob_float_property_range ob_device_get_float_property_range(ob_device *device, ob_property_id property_id, ob_error **error)
Get the float type of device property range.
ob_camera_param_list_get_param
ob_camera_param ob_camera_param_list_get_param(ob_camera_param_list *param_list, uint32_t index, ob_error **error)
Get camera parameters from the camera parameter list.
ob_device_read_ahb
void ob_device_read_ahb(ob_device *device, uint32_t reg, uint32_t mask, uint32_t *value, ob_error **error)
Read an AHB register.
ob_device_switch_depth_work_mode_by_name
ob_status ob_device_switch_depth_work_mode_by_name(ob_device *device, const char *mode_name, ob_error **error)
Switch the depth work mode by work mode name.
ob_device_info_uid
const char * ob_device_info_uid(ob_device_info *info, ob_error **error)
Get device uid.
ob_device_list_get_device_by_uid
ob_device * ob_device_list_get_device_by_uid(ob_device_list *list, const char *uid, ob_error **error)
Create device by uid.
ob_device_export_current_settings_as_preset_json_file
void ob_device_export_current_settings_as_preset_json_file(ob_device *device, const char *json_file_path, ob_error **error)
Export current settings as a preset json file.
ob_device_list_get_device_ip_address
const char * ob_device_list_get_device_ip_address(ob_device_list *list, uint32_t index, ob_error **error)
Get device ip address.
ob_device_write_ahb
void ob_device_write_ahb(ob_device *device, uint32_t reg, uint32_t mask, uint32_t value, ob_error **error)
Write to an AHB register.
ob_device_get_int_property
int32_t ob_device_get_int_property(ob_device *device, ob_property_id property_id, ob_error **error)
Get an integer type of device property.
ob_device_is_global_timestamp_supported
bool ob_device_is_global_timestamp_supported(ob_device *device, ob_error **error)
Check if the device supports global timestamp.
ob_delete_device_info
void ob_delete_device_info(ob_device_info *info, ob_error **error)
Delete device information.
ob_device_list_get_device_connection_type
const char * ob_device_list_get_device_connection_type(ob_device_list *list, uint32_t index, ob_error **error)
Get device connection type.
ob_device_read_flash
void 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)
Read Flash properties [asynchronous callback].
ob_device_upgrade_from_data
void ob_device_upgrade_from_data(ob_device *device, const char *file_data, uint32_t file_size, ob_device_upgrade_callback callback, bool async, void *user_data, ob_error **error)
Upgrade the device firmware.
ob_delete_camera_param_list
void ob_delete_camera_param_list(ob_camera_param_list *param_list, ob_error **error)
Delete the camera parameter list.
ob_device_get_raw_data
void ob_device_get_raw_data(ob_device *device, ob_property_id property_id, ob_get_data_callback cb, bool async, void *user_data, ob_error **error)
Get raw data of a device property.
ob_device_get_protocol_version
ob_protocol_version ob_device_get_protocol_version(ob_device *device, ob_error **error)
Get the protocol version of the device.
ob_device_info_serial_number
const char * ob_device_info_serial_number(ob_device_info *info, ob_error **error)
Get device serial number.
ob_device_get_device_state
ob_device_state ob_device_get_device_state(ob_device *device, ob_error **error)
Get the current device status.
ob_device_get_current_preset_name
const char * ob_device_get_current_preset_name(ob_device *device, ob_error **error)
The preset mean a set of parameters or configurations that can be applied to the device to achieve a ...
ob_device_get_bool_property
bool ob_device_get_bool_property(ob_device *device, ob_property_id property_id, ob_error **error)
Get a boolean type of device property.
ob_device_activate_authorization
bool ob_device_activate_authorization(ob_device *device, const char *auth_code, ob_error **error)
Verify the device authorization code.
ob_device_info_vid
int ob_device_info_vid(ob_device_info *info, ob_error **error)
Get device vid.
ob_device_load_preset_from_json_file
void ob_device_load_preset_from_json_file(ob_device *device, const char *json_file_path, ob_error **error)
Load preset from json string.
ob_device_get_available_preset_list
ob_device_preset_list * ob_device_get_available_preset_list(ob_device *device, ob_error **error)
Get the available preset list.
ob_device_get_structured_data
void ob_device_get_structured_data(ob_device *device, ob_property_id property_id, void *data, uint32_t *data_size, ob_error **error)
Get structured data of a device property.
ob_device_get_device_info
ob_device_info * ob_device_get_device_info(ob_device *device, ob_error **error)
Get device information.
ob_device_set_bool_property
void ob_device_set_bool_property(ob_device *device, ob_property_id property_id, bool property, ob_error **error)
Set a boolean type of device property.
ob_device_info_pid
int ob_device_info_pid(ob_device_info *info, ob_error **error)
Get device pid.
ob_delete_data_bundle
void ob_delete_data_bundle(ob_data_bundle *data_bundle, ob_error **error)
Free the resources of data_bundle which come from OrbbecSDK's API.
ob_device_list_get_extension_info
const char * ob_device_list_get_extension_info(ob_device_list *list, uint32_t index, ob_error **error)
Get the device extension information.
ob_device_set_structured_data
void ob_device_set_structured_data(ob_device *device, ob_property_id property_id, const void *data, uint32_t data_size, ob_error **error)
Set structured data.
ob_device_set_int_property
void ob_device_set_int_property(ob_device *device, ob_property_id property_id, int32_t property, ob_error **error)
Set an integer type of device property.
ob_device_upgrade
void ob_device_upgrade(ob_device *device, const char *path, ob_device_upgrade_callback callback, bool async, void *user_data, ob_error **error)
Upgrade the device firmware.
ob_device_preset_list_count
uint32_t ob_device_preset_list_count(ob_device_preset_list *preset_list, ob_error **error)
Get the number of preset in the preset list.
ob_device_info_connection_type
const char * ob_device_info_connection_type(ob_device_info *info, ob_error **error)
Get the device connection type.
ob_device_info_get_extension_info
const char * ob_device_info_get_extension_info(ob_device_info *info, ob_error **error)
Get the device extension information.
ob_device_get_sensor
ob_sensor * ob_device_get_sensor(ob_device *device, ob_sensor_type type, ob_error **error)
Get a device's sensor.
ob_delete_device
void ob_delete_device(ob_device *device, ob_error **error)
Delete a device.
ob_delete_preset_list
void ob_delete_preset_list(ob_device_preset_list *preset_list, ob_error **error)
Delete the available preset list.
ob_device_load_preset
void ob_device_load_preset(ob_device *device, const char *preset_name, ob_error **error)
Get the available preset list.
ob_device_get_float_property
float ob_device_get_float_property(ob_device *device, ob_property_id property_id, ob_error **error)
Get a float type of device property.
ob_device_set_raw_data
void ob_device_set_raw_data(ob_device *device, ob_property_id property_id, void *data, uint32_t data_size, ob_set_data_callback cb, bool async, void *user_data, ob_error **error)
Set raw data of a device property.
ob_device_read_customer_data
void ob_device_read_customer_data(ob_device *device, void *data, uint32_t *data_size, ob_error **error)
Get customer data of a device property.
ob_device_get_depth_work_mode_list
ob_depth_work_mode_list * ob_device_get_depth_work_mode_list(ob_device *device, ob_error **error)
Request the list of supported depth work modes.
ob_device_switch_depth_work_mode
ob_status ob_device_switch_depth_work_mode(ob_device *device, const ob_depth_work_mode *work_mode, ob_error **error)
Switch the depth work mode by ob_depth_work_mode. Prefer to use ob_device_switch_depth_work_mode_by_n...
ob_device_reboot
void ob_device_reboot(ob_device *device, ob_error **error)
Device reboot.
ob_device_list_get_device_serial_number
const char * ob_device_list_get_device_serial_number(ob_device_list *list, uint32_t index, ob_error **error)
Get the serial number of the specified device.
ob_device_list_get_device
ob_device * ob_device_list_get_device(ob_device_list *list, uint32_t index, ob_error **error)
Create a device.
ob_device_reset_default_depth_filter_config
void ob_device_reset_default_depth_filter_config(ob_device *device, ob_error **error)
Reset depth filter config to device default define.
ob_device_list_get_device_by_serial_number
ob_device * ob_device_list_get_device_by_serial_number(ob_device_list *list, const char *serial_number, ob_error **error)
Create a device.
ob_device_get_calibration_camera_param_list
ob_camera_param_list * ob_device_get_calibration_camera_param_list(ob_device *device, ob_error **error)
Get the original parameter list of camera calibration saved on the device.
ob_device_info_hardware_version
const char * ob_device_info_hardware_version(ob_device_info *info, ob_error **error)
Get the hardware version number.
ob_device_write_i2c
void ob_device_write_i2c(ob_device *device, uint32_t module_id, uint32_t reg, uint32_t mask, uint32_t value, ob_error **error)
Write to an I2C register.
ob_device_preset_list_has_preset
bool ob_device_preset_list_has_preset(ob_device_preset_list *preset_list, const char *preset_name, ob_error **error)
Check if the preset list has the preset.
ob_device_get_structured_data_ext
ob_data_bundle * ob_device_get_structured_data_ext(ob_device *device, ob_property_id property_id, ob_error **error)
Get structured data of a device property.
ob_device_write_customer_data
void ob_device_write_customer_data(ob_device *device, const void *data, uint32_t data_size, ob_error **error)
Set customer data.
ob_device_preset_list_get_name
const char * ob_device_preset_list_get_name(ob_device_preset_list *preset_list, uint32_t index, ob_error **error)
Get the name of the preset in the preset list.
ob_device_get_sensor_list
ob_sensor_list * ob_device_get_sensor_list(ob_device *device, ob_error **error)
List all sensors.
ob_device_list_get_device_uid
const char * ob_device_list_get_device_uid(ob_device_list *list, uint32_t index, ob_error **error)
Get the uid of the specified device.
ob_device_list_get_device_pid
int ob_device_list_get_device_pid(ob_device_list *list, uint32_t index, ob_error **error)
Get the pid of the specified device.
ob_device_get_supported_property_count
uint32_t ob_device_get_supported_property_count(ob_device *device, ob_error **error)
Get the number of properties supported by the device.
ob_device_get_supported_property
ob_property_item ob_device_get_supported_property(ob_device *device, uint32_t index, ob_error **error)
Get the type of property supported by the device.
ob_device_read_i2c
void ob_device_read_i2c(ob_device *device, uint32_t module_id, uint32_t reg, uint32_t mask, uint32_t *value, ob_error **error)
Read an I2C register.
ob_device_info_device_type
ob_device_type ob_device_info_device_type(ob_device_info *info, ob_error **error)
Get the device type.
ob_device_get_current_depth_work_mode
ob_depth_work_mode ob_device_get_current_depth_work_mode(ob_device *device, ob_error **error)
Get the current depth work mode.
ob_device_get_cmd_version
ob_cmd_version ob_device_get_cmd_version(ob_device *device, ob_property_id property_id, ob_error **error)
Get the cmdVersion of a property.
ob_device_send_file_to_destination
void 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)
Send files to the specified path on the device.
ob_delete_device_list
void ob_delete_device_list(ob_device_list *list, ob_error **error)
Delete a device list.
ob_device_get_sync_config
ob_device_sync_config ob_device_get_sync_config(ob_device *device, ob_error **error)
Get the current device synchronization configuration.
ob_device_load_depth_filter_config
void ob_device_load_depth_filter_config(ob_device *device, const char *file_path, ob_error **error)
Load depth filter config from file.
ob_device_info_ip_address
const char * ob_device_info_ip_address(ob_device_info *info, ob_error **error)
Get the device IP address.
ob_device_info_firmware_version
const char * ob_device_info_firmware_version(ob_device_info *info, ob_error **error)
Get the firmware version number.
ob_device_write_flash
void 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)
Set the properties of writing to Flash [Asynchronous Callback].
ob_device_list_get_device_vid
int ob_device_list_get_device_vid(ob_device_list *list, uint32_t index, ob_error **error)
Get the vid of the specified device.
ob_device_info_usb_type
const char * ob_device_info_usb_type(ob_device_info *info, ob_error **error)
Get the USB connection type (DEPRECATED)
ob_delete_depth_work_mode_list
void ob_delete_depth_work_mode_list(ob_depth_work_mode_list *work_mode_list, ob_error **error)
Free the resources of ob_depth_work_mode_list.
ob_device_info_asicName
const char * ob_device_info_asicName(ob_device_info *info, ob_error **error)
Get the chip name.
ob_device_info_supported_min_sdk_version
const char * ob_device_info_supported_min_sdk_version(ob_device_info *info, ob_error **error)
Get the minimum SDK version number supported by the device.
ob_depth_work_mode_list_get_item
ob_depth_work_mode ob_depth_work_mode_list_get_item(ob_depth_work_mode_list *work_mode_list, uint32_t index, ob_error **error)
Get the index target of ob_depth_work_mode from work_mode_list.
ob_device_set_float_property
void ob_device_set_float_property(ob_device *device, ob_property_id property_id, float property, ob_error **error)
Set a float type of device property.
MultipleDevices.h
This file contains the multiple devices related API witch is used to control the synchronization betw...
ObTypes.h
Provide structs commonly used in the SDK, enumerating constant definitions.
ob_get_data_callback
void(* ob_get_data_callback)(ob_data_tran_state state, ob_data_chunk *dataChunk, void *user_data)
Callback for reading data.
Definition ObTypes.h:1730
ob_device
struct DeviceImpl ob_device
Definition ObTypes.h:55
ob_device_info
struct DeviceInfoImpl ob_device_info
Definition ObTypes.h:56
ob_device_type
enum OBDeviceType ob_device_type
ob_file_send_callback
void(* ob_file_send_callback)(ob_file_tran_state state, const char *message, uint8_t percent, void *user_data)
Callback for file transfer.
Definition ObTypes.h:1693
ob_cmd_version
enum OB_CMD_VERSION ob_cmd_version
ob_sensor_list
struct SensorListImpl ob_sensor_list
Definition ObTypes.h:60
ob_device_upgrade_callback
void(* ob_device_upgrade_callback)(ob_upgrade_state state, const char *message, uint8_t percent, void *user_data)
Callback for firmware upgrade.
Definition ObTypes.h:1703
ob_device_preset_list
struct DevicePresetListImpl ob_device_preset_list
Definition ObTypes.h:72
ob_device_list
struct DeviceListImpl ob_device_list
Definition ObTypes.h:57
ob_sensor
struct SensorImpl ob_sensor
Definition ObTypes.h:59
ob_device_state
uint64_t ob_device_state
Definition ObTypes.h:644
ob_sensor_type
enum OBSensorType ob_sensor_type
ob_camera_param_list
struct CameraParamListImpl ob_camera_param_list
Definition ObTypes.h:58
ob_set_data_callback
void(* ob_set_data_callback)(ob_data_tran_state state, uint8_t percent, void *user_data)
Callback for writing data.
Definition ObTypes.h:1721
ob_status
enum OBStatus ob_status
ob_depth_work_mode_list
struct OBDepthWorkModeListImpl ob_depth_work_mode_list
Definition ObTypes.h:69
ob_device_state_callback
void(* ob_device_state_callback)(ob_device_state state, const char *message, void *user_data)
Callback for device status.
Definition ObTypes.h:1712
ob_permission_type
enum OBPermissionType ob_permission_type
Property.h
Control command property list maintenance.
ob_property_id
enum OBPropertyID ob_property_id
OBBoolPropertyRange
Structure for boolean range.
Definition ObTypes.h:369
OBCameraParam
Structure for camera parameters.
Definition ObTypes.h:462
OBDataBundle
Internal API for future publication.
Definition ObTypes.h:1083
OBDepthWorkMode
Depth work mode.
Definition ObTypes.h:954
OBDeviceSyncConfig
Device synchronization configuration.
Definition ObTypes.h:898
OBFloatPropertyRange
Structure for float range.
Definition ObTypes.h:336
OBIntPropertyRange
Structure for integer range.
Definition ObTypes.h:325
OBPropertyItem
Used to describe the characteristics of each property.
Definition Property.h:764
OBProtocolVersion
Control command protocol version number.
Definition ObTypes.h:1037
ob_error
The error class exposed by the SDK, users can get detailed error information according to the error.
Definition ObTypes.h:151