diff --git a/doc/api/English/Context_8h.html b/doc/api/English/Context_8h.html new file mode 100644 index 0000000..4f566c6 --- /dev/null +++ b/doc/api/English/Context_8h.html @@ -0,0 +1,861 @@ + + +
+ + + + ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Context is a management class that describes the runtime of the SDK and is responsible for resource allocation and release of the SDK. Context has the ability to manage multiple devices. It is responsible for enumerating devices, monitoring device callbacks, and enabling multi-device synchronization. +More...
+#include "ObTypes.h"
Go to the source code of this file.
++Macros | |
#define | ob_enable_multi_device_sync ob_enable_device_clock_sync |
+Functions | |
ob_context * | ob_create_context (ob_error **error) |
Create a context object. | |
ob_context * | ob_create_context_with_config (const char *config_path, ob_error **error) |
Create a context object with a specified configuration file. | |
void | ob_delete_context (ob_context *context, ob_error **error) |
Delete a context object. | |
ob_device_list * | ob_query_device_list (ob_context *context, ob_error **error) |
Get a list of enumerated devices. | |
void | ob_enable_net_device_enumeration (ob_context *context, bool enable, ob_error **error) |
Enable or disable network device enumeration. | |
ob_device * | ob_create_net_device (ob_context *context, const char *address, uint16_t port, ob_error **error) |
Create a network device object. | |
void | ob_set_device_changed_callback (ob_context *context, ob_device_changed_callback callback, void *user_data, ob_error **error) |
Set a device plug-in callback function. | |
void | ob_enable_device_clock_sync (ob_context *context, uint64_t repeatInterval, ob_error **error) |
Activates device clock synchronization to synchronize the clock of the host and all created devices (if supported). | |
void | ob_free_idle_memory (ob_context *context, ob_error **error) |
Free idle memory from the internal frame memory pool. | |
void | ob_set_logger_severity (ob_log_severity severity, ob_error **error) |
Set the global log level. | |
void | ob_set_logger_to_file (ob_log_severity severity, const char *directory, ob_error **error) |
Set the log output to a file. | |
void | ob_set_logger_callback (ob_log_severity severity, ob_log_callback callback, void *user_data, ob_error **error) |
Set the log callback function. | |
void | ob_set_logger_to_console (ob_log_severity severity, ob_error **error) |
Set the log output to the console. | |
void | ob_load_license (const char *filePath, const char *key, ob_error **error) |
Load a license file. | |
void | ob_load_license_from_data (const char *data, uint32_t dataLen, const char *key, ob_error **error) |
Load a license from data. | |
void | ob_set_uvc_backend (ob_context *context, ob_uvc_backend uvc_backend, ob_error **error) |
Set the UVC backend for the specified context This function configures the Universal Video Class (UVC) backend for the given context, allowing the selection of a specific backend for video capture operations. | |
Context is a management class that describes the runtime of the SDK and is responsible for resource allocation and release of the SDK. Context has the ability to manage multiple devices. It is responsible for enumerating devices, monitoring device callbacks, and enabling multi-device synchronization.
+ +Definition in file Context.h.
+#define ob_enable_multi_device_sync ob_enable_device_clock_sync | +
ob_context * ob_create_context | +( | +ob_error ** | +error | ) | ++ |
Create a context object.
+[out] | error | Pointer to an error object that will be populated if an error occurs during context creation |
ob_context * ob_create_context_with_config | +( | +const char * | +config_path, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Create a context object with a specified configuration file.
+[in] | config_path | Path to the configuration file. If NULL, the default configuration file will be used. |
[out] | error | Pointer to an error object that will be populated if an error occurs during context creation |
void ob_delete_context | +( | +ob_context * | +context, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete a context object.
+[in] | context | Pointer to the context object to be deleted |
[out] | error | Pointer to an error object that will be populated if an error occurs during context deletion |
ob_device_list * ob_query_device_list | +( | +ob_context * | +context, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get a list of enumerated devices.
+[in] | context | Pointer to the context object |
[out] | error | Pointer to an error object that will be populated if an error occurs during device enumeration |
void ob_enable_net_device_enumeration | +( | +ob_context * | +context, | +
+ | + | bool | +enable, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Enable or disable network device enumeration.
+After enabling, the network device will be automatically discovered and can be retrieved through ob_query_device_list. The default state can be set in the configuration file.
+[in] | context | Pointer to the context object |
[in] | enable | true to enable, false to disable |
[out] | error | Pointer to an error object that will be populated if an error occurs. |
ob_device * ob_create_net_device | +( | +ob_context * | +context, | +
+ | + | const char * | +address, | +
+ | + | uint16_t | +port, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Create a network device object.
+[in] | context | Pointer to the context object |
[in] | address | IP address of the device |
[in] | port | Port number of the device |
[out] | error | Pointer to an error object that will be populated if an error occurs during device creation |
void ob_set_device_changed_callback | +( | +ob_context * | +context, | +
+ | + | ob_device_changed_callback | +callback, | +
+ | + | void * | +user_data, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set a device plug-in callback function.
+[in] | context | Pointer to the context object |
[in] | callback | Pointer to the callback function triggered when a device is plugged or unplugged |
[in] | user_data | Pointer to user data that can be passed to and retrieved from the callback function |
[out] | error | Pointer to an error object that will be populated if an error occurs during callback function setting |
void ob_enable_device_clock_sync | +( | +ob_context * | +context, | +
+ | + | uint64_t | +repeatInterval, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Activates device clock synchronization to synchronize the clock of the host and all created devices (if supported).
+[in] | context | Pointer to the context object |
[in] | repeatInterval | The interval for auto-repeated synchronization, in milliseconds. If the value is 0, synchronization is performed only once. |
[out] | error | Pointer to an error object that will be populated if an error occurs during execution |
void ob_free_idle_memory | +( | +ob_context * | +context, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Free idle memory from the internal frame memory pool.
+[in] | context | Pointer to the context object |
[out] | error | Pointer to an error object that will be populated if an error occurs during memory freeing |
void ob_set_logger_severity | +( | +ob_log_severity | +severity, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the global log level.
+[in] | severity | Log level to set |
[out] | error | Pointer to an error object that will be populated if an error occurs during log level setting |
void ob_set_logger_to_file | +( | +ob_log_severity | +severity, | +
+ | + | const char * | +directory, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the log output to a file.
+[in] | severity | Log level to output to file |
[in] | directory | Path to the log file output directory. If the path is empty, the existing settings will continue to be used (if the existing configuration is also empty, the log will not be output to the file) |
[out] | error | Pointer to an error object that will be populated if an error occurs during log output setting |
void ob_set_logger_callback | +( | +ob_log_severity | +severity, | +
+ | + | ob_log_callback | +callback, | +
+ | + | void * | +user_data, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the log callback function.
+[in] | severity | Log level to set for the callback function |
[in] | callback | Pointer to the callback function |
[in] | user_data | Pointer to user data that can be passed to and retrieved from the callback function |
[out] | error | Pointer to an error object that will be populated if an error occurs during log callback function setting |
void ob_set_logger_to_console | +( | +ob_log_severity | +severity, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the log output to the console.
+[in] | severity | Log level to output to the console |
[out] | error | Pointer to an error object that will be populated if an error occurs during log output setting |
void ob_load_license | +( | +const char * | +filePath, | +
+ | + | const char * | +key, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Load a license file.
+[in] | filePath | Path to the license file |
[in] | key | Decryption key. "OB_DEFAULT_DECRYPT_KEY" can be used to represent the default key. |
[out] | error | Pointer to an error object that will be populated if an error occurs during license loading |
void ob_load_license_from_data | +( | +const char * | +data, | +
+ | + | uint32_t | +dataLen, | +
+ | + | const char * | +key, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Load a license from data.
+[in] | data | Pointer to the license data |
[in] | dataLen | Length of the license data |
[in] | key | Decryption key. "OB_DEFAULT_DECRYPT_KEY" can be used to represent the default key. |
[out] | error | Pointer to an error object that will be populated if an error occurs during license loading |
void ob_set_uvc_backend | +( | +ob_context * | +context, | +
+ | + | ob_uvc_backend | +uvc_backend, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the UVC backend for the specified context This function configures the Universal Video Class (UVC) backend for the given context, allowing the selection of a specific backend for video capture operations.
+[in] | context | Pointer to the context object |
[in] | uvc_backend | Specifies the UVC backend to use:
|
[out] | error | Pointer to an error object that will be populated if an error occurs. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The SDK context class, which serves as the entry point to the underlying SDK. It is used to query device lists, handle device callbacks, and set the log level. +More...
+ +Go to the source code of this file.
++Classes | |
class | ob::Context |
+Namespaces | |
namespace | ob |
+Macros | |
#define | enableMultiDeviceSync enableDeviceClockSync |
The SDK context class, which serves as the entry point to the underlying SDK. It is used to query device lists, handle device callbacks, and set the log level.
+ +Definition in file Context.hpp.
+#define enableMultiDeviceSync enableDeviceClockSync | +
Definition at line 84 of file Context.hpp.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Device-related functions, including operations such as obtaining and creating a device, setting and obtaining device property, and obtaining sensors. +More...
+ +Go to the source code of this file.
++Functions | |
uint32_t | ob_device_list_device_count (ob_device_list *list, ob_error **error) |
Get the number of devices. | |
const char * | ob_device_list_get_device_name (ob_device_list *list, uint32_t index, ob_error **error) |
Get device name (DEPRECATED) | |
int | ob_device_list_get_device_pid (ob_device_list *list, uint32_t index, ob_error **error) |
Get the pid of the specified device. | |
int | ob_device_list_get_device_vid (ob_device_list *list, uint32_t index, ob_error **error) |
Get the vid of the specified device. | |
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. | |
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. | |
const char * | ob_device_list_get_device_connection_type (ob_device_list *list, uint32_t index, ob_error **error) |
Get device connection type. | |
const char * | ob_device_list_get_device_ip_address (ob_device_list *list, uint32_t index, ob_error **error) |
Get device ip address. | |
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 * | ob_device_list_get_device (ob_device_list *list, uint32_t index, ob_error **error) |
Create a device. | |
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 * | ob_device_list_get_device_by_uid (ob_device_list *list, const char *uid, ob_error **error) |
Create device by uid. | |
void | ob_delete_device (ob_device *device, ob_error **error) |
Delete a device. | |
void | ob_delete_device_info (ob_device_info *info, ob_error **error) |
Delete device information. | |
void | ob_delete_device_list (ob_device_list *list, ob_error **error) |
Delete a device list. | |
ob_device_info * | ob_device_get_device_info (ob_device *device, ob_error **error) |
Get device information. | |
ob_sensor_list * | ob_device_get_sensor_list (ob_device *device, ob_error **error) |
List all sensors. | |
ob_sensor * | ob_device_get_sensor (ob_device *device, ob_sensor_type type, ob_error **error) |
Get a device's sensor. | |
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. | |
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. | |
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. | |
float | ob_device_get_float_property (ob_device *device, ob_property_id property_id, ob_error **error) |
Get a float type of device 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. | |
bool | ob_device_get_bool_property (ob_device *device, ob_property_id property_id, ob_error **error) |
Get a boolean type of device property. | |
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. | |
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. | |
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_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. | |
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. | |
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_protocol_version | ob_device_get_protocol_version (ob_device *device, ob_error **error) |
Get the protocol version of the device. | |
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. | |
uint32_t | ob_device_get_supported_property_count (ob_device *device, ob_error **error) |
Get the number of properties supported by the device. | |
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. | |
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_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_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_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. | |
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. | |
void | ob_device_read_ahb (ob_device *device, uint32_t reg, uint32_t mask, uint32_t *value, ob_error **error) |
Read an AHB register. | |
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. | |
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. | |
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]. | |
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]. | |
void | ob_device_write_customer_data (ob_device *device, const void *data, uint32_t data_size, ob_error **error) |
Set 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. | |
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. | |
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_device_state | ob_device_get_device_state (ob_device *device, ob_error **error) |
Get the current device status. | |
void | ob_device_state_changed (ob_device *device, ob_device_state_callback callback, void *user_data, ob_error **error) |
Monitor device state changes. | |
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. | |
bool | ob_device_activate_authorization (ob_device *device, const char *auth_code, ob_error **error) |
Verify the device 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 * | 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_depth_work_mode | ob_device_get_current_depth_work_mode (ob_device *device, ob_error **error) |
Get the current 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_name to switch depth mode when the complete name of the depth work mode is known. | |
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_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. | |
void | ob_device_reboot (ob_device *device, ob_error **error) |
Device reboot. | |
ob_device_sync_config | ob_device_get_sync_config (ob_device *device, ob_error **error) |
Get the current device synchronization configuration. | |
void | ob_device_set_sync_config (ob_device *device, ob_device_sync_config device_sync_config, ob_error **error) |
Set the device synchronization configuration. | |
const char * | ob_device_info_name (ob_device_info *info, ob_error **error) |
Get device name. | |
int | ob_device_info_pid (ob_device_info *info, ob_error **error) |
Get device pid. | |
int | ob_device_info_vid (ob_device_info *info, ob_error **error) |
Get device vid. | |
const char * | ob_device_info_uid (ob_device_info *info, ob_error **error) |
Get device uid. | |
const char * | ob_device_info_serial_number (ob_device_info *info, ob_error **error) |
Get device serial number. | |
const char * | ob_device_info_firmware_version (ob_device_info *info, ob_error **error) |
Get the firmware version number. | |
const char * | ob_device_info_usb_type (ob_device_info *info, ob_error **error) |
Get the USB connection type (DEPRECATED) | |
const char * | ob_device_info_connection_type (ob_device_info *info, ob_error **error) |
Get the device connection type. | |
const char * | ob_device_info_ip_address (ob_device_info *info, ob_error **error) |
Get the device IP address. | |
const char * | ob_device_info_hardware_version (ob_device_info *info, ob_error **error) |
Get the hardware version number. | |
const char * | ob_device_info_get_extension_info (ob_device_info *info, ob_error **error) |
Get the device extension information. | |
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. | |
const char * | ob_device_info_asicName (ob_device_info *info, ob_error **error) |
Get the chip name. | |
ob_device_type | ob_device_info_device_type (ob_device_info *info, ob_error **error) |
Get the device type. | |
uint32_t | ob_camera_param_list_count (ob_camera_param_list *param_list, ob_error **error) |
Get the number of camera parameter lists. | |
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. | |
void | ob_delete_camera_param_list (ob_camera_param_list *param_list, ob_error **error) |
Delete the camera parameter list. | |
uint32_t | ob_depth_work_mode_list_count (ob_depth_work_mode_list *work_mode_list, ob_error **error) |
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. | |
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. | |
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. | |
bool | ob_device_is_global_timestamp_supported (ob_device *device, ob_error **error) |
Check if the device supports global timestamp. | |
void | ob_device_load_depth_filter_config (ob_device *device, const char *file_path, ob_error **error) |
Load depth filter config from file. | |
void | ob_device_reset_default_depth_filter_config (ob_device *device, ob_error **error) |
Reset depth filter config to device default define. | |
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 specific effect or function. | |
void | ob_device_load_preset (ob_device *device, const char *preset_name, ob_error **error) |
Get the available preset list. | |
void | ob_device_load_preset_from_json_file (ob_device *device, const char *json_file_path, ob_error **error) |
Load preset from json string. | |
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_preset_list * | ob_device_get_available_preset_list (ob_device *device, ob_error **error) |
Get the available preset list. | |
void | ob_delete_preset_list (ob_device_preset_list *preset_list, ob_error **error) |
Delete the available preset list. | |
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. | |
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. | |
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. | |
Device-related functions, including operations such as obtaining and creating a device, setting and obtaining device property, and obtaining sensors.
+ +Definition in file Device.h.
+uint32_t ob_device_list_device_count | +( | +ob_device_list * | +list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the number of devices.
+[in] | list | Device list object |
[out] | error | Log error messages |
const char * ob_device_list_get_device_name | +( | +ob_device_list * | +list, | +
+ | + | uint32_t | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get device name (DEPRECATED)
+[in] | list | Device list object |
[in] | index | Device index |
[out] | error | Log error messages |
int ob_device_list_get_device_pid | +( | +ob_device_list * | +list, | +
+ | + | uint32_t | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the pid of the specified device.
+[in] | list | Device list object |
[in] | index | Device index |
[out] | error | Log error messages |
int ob_device_list_get_device_vid | +( | +ob_device_list * | +list, | +
+ | + | uint32_t | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the vid of the specified device.
+[in] | list | Device list object |
[in] | index | Device index |
[out] | error | Log error messages |
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.
+[in] | list | Device list object |
[in] | index | Device index |
[out] | error | Log error messages |
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.
+[in] | list | Device list object. |
[in] | index | Device index. |
[out] | error | Log error messages. |
const char * ob_device_list_get_device_connection_type | +( | +ob_device_list * | +list, | +
+ | + | uint32_t | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get device connection type.
+[in] | list | Device list object |
[in] | index | Device index |
[out] | error | Log error messages |
const char * ob_device_list_get_device_ip_address | +( | +ob_device_list * | +list, | +
+ | + | uint32_t | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get device ip address.
+list | Device list object |
index | Device index |
error | Log error messages |
const char * ob_device_list_get_extension_info | +( | +ob_device_list * | +list, | +
+ | + | uint32_t | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the device extension information.
+[in] | list | Device list object |
[in] | index | Device index |
[out] | error | Log error messages |
ob_device * ob_device_list_get_device | +( | +ob_device_list * | +list, | +
+ | + | uint32_t | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Create a device.
+[in] | list | Device list object. |
[in] | index | The index of the device to create. |
[out] | error | Log error messages. |
ob_device * ob_device_list_get_device_by_serial_number | +( | +ob_device_list * | +list, | +
+ | + | const char * | +serial_number, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Create a device.
+[in] | list | Device list object. |
[in] | serial_number | The serial number of the device to create. |
[out] | error | Log error messages. |
ob_device * ob_device_list_get_device_by_uid | +( | +ob_device_list * | +list, | +
+ | + | const char * | +uid, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Create device by uid.
+On Linux platform, the uid of the device is composed of bus-port-dev, for example 1-1.2-1. But the SDK will remove the dev number and only keep the bus-port as the uid to create the device, for example 1-1.2, so that we can create a device connected to the specified USB port. Similarly, users can also directly pass in bus-port as uid to create device.
+[in] | list | Device list object. |
[in] | uid | The UID of the device to create. |
[out] | error | Log error messages. |
void ob_delete_device | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete a device.
+[in] | device | The device to be deleted. |
[out] | error | Log error messages. |
void ob_delete_device_info | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete device information.
+[in] | info | The device information to be deleted. |
[out] | error | Log error messages. |
void ob_delete_device_list | +( | +ob_device_list * | +list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete a device list.
+[in] | list | The device list object to be deleted. |
[out] | error | Log error messages. |
ob_device_info * ob_device_get_device_info | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get device information.
+[in] | device | The device to obtain information from. |
[out] | error | Log error messages. |
ob_sensor_list * ob_device_get_sensor_list | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
List all sensors.
+[in] | device | The device object. |
[out] | error | Log error messages. |
ob_sensor * ob_device_get_sensor | +( | +ob_device * | +device, | +
+ | + | ob_sensor_type | +type, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get a device's sensor.
+[in] | device | The device object. |
[in] | type | The type of sensor to get. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The ID of the property to be set. |
[in] | property | The property value to be set. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The property ID. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The ID of the property to be set. |
[in] | property | The property value to be set. |
[out] | error | Log error messages. |
float ob_device_get_float_property | +( | +ob_device * | +device, | +
+ | + | ob_property_id | +property_id, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get a float type of device property.
+[in] | device | The device object. |
[in] | property_id | The property ID. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The ID of the property to be set. |
[in] | property | The property value to be set. |
[out] | error | Log error messages. |
bool ob_device_get_bool_property | +( | +ob_device * | +device, | +
+ | + | ob_property_id | +property_id, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get a boolean type of device property.
+[in] | device | The device object. |
[in] | property_id | The property ID. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The ID of the property to be set. |
[in] | data | The property data to be set. |
[in] | data_size | The size of the property to be set. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The ID of the property. |
[out] | data | The obtained property data. |
[out] | data_size | The size of the obtained property data. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The ID of the property. |
[in] | data_bundle | The target data to set. |
[in] | cb | The data callback. |
[in] | user_data | User-defined data that will be returned in the callback. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The ID of the property. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The ID of the property to be set. |
[in] | data | The property data to be set. |
[in] | data_size | The size of the property data to be set. |
[in] | cb | The set data callback. |
[in] | async | Whether to execute asynchronously. |
[in] | user_data | User-defined data that will be returned in the callback. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The ID of the property. |
[in] | cb | The get data callback. |
[in] | async | Whether to execute asynchronously. |
[in] | user_data | User-defined data that will be returned in the callback. |
[out] | error | Log error messages. |
ob_protocol_version ob_device_get_protocol_version | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the protocol version of the device.
+[in] | device | The device object. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The property id. |
[out] | error | Log error messages. |
uint32_t ob_device_get_supported_property_count | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the number of properties supported by the device.
+[in] | device | The device object. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | index | The property index. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The property id. |
[in] | permission | The type of permission that needs to be interpreted. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The property id. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The property id. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | property_id | The property id. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
reg | The register to be written. | |
mask | The mask. | |
value | The value to be written. | |
[out] | error | Log error messages. |
void ob_device_read_ahb | +( | +ob_device * | +device, | +
+ | + | uint32_t | +reg, | +
+ | + | uint32_t | +mask, | +
+ | + | uint32_t * | +value, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Read an AHB register.
+[in] | device | The device object. |
reg | The register to be read. | |
mask | The mask. | |
value | The value to be read. | |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
module_id | The I2C module id to be written. | |
reg | The register to be written. | |
mask | The mask. | |
value | The value to be written. | |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
module_id | The id of the I2C module to be read. | |
reg | The register to be read. | |
mask | The mask. | |
value | The value to be read. | |
[out] | error | Log error messages. |
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].
+[in] | device | The device object. |
offset | The flash offset address. | |
data | The property data to be written. | |
data_size | The size of the property to be written. | |
cb | The set data callback. | |
[in] | async | Whether to execute asynchronously. |
[in] | user_data | User-defined data that will be returned in the callback. |
[out] | error | Log error messages. |
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].
+[in] | device | The device object. |
offset | The flash offset address. | |
data_size | The size of the data to be read. | |
cb | The read flash data and progress callback. | |
[in] | async | Whether to execute asynchronously. |
[in] | user_data | User-defined data that will be returned in the callback. |
[out] | error | Log error messages. |
void ob_device_write_customer_data | +( | +ob_device * | +device, | +
+ | + | const void * | +data, | +
+ | + | uint32_t | +data_size, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set customer data.
+[in] | device | The device object. |
[in] | data | The property data to be set. |
[in] | data_size | The size of the property to be set,the maximum length cannot exceed 65532 bytes. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[out] | data | The obtained property data. |
[out] | data_size | The size of the obtained property data. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | path | The firmware path. |
[in] | callback | The firmware upgrade progress callback. |
[in] | async | Whether to execute asynchronously. |
[in] | user_data | User-defined data that will be returned in the callback. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | file_data | The firmware file data. |
[in] | file_size | The firmware file size. |
[in] | callback | The firmware upgrade progress callback. |
[in] | async | Whether to execute asynchronously. |
[in] | user_data | User-defined data that will be returned in the callback. |
[out] | error | Log error messages. |
ob_device_state ob_device_get_device_state | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the current device status.
+[in] | device | The device object. |
[out] | error | Log error messages. |
void ob_device_state_changed | +( | +ob_device * | +device, | +
+ | + | ob_device_state_callback | +callback, | +
+ | + | void * | +user_data, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Monitor device state changes.
+[in] | device | The device object. |
[in] | callback | The callback function to be called when the device status changes. |
[in] | user_data | User-defined data that will be returned in the callback. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | file_path | The source file path. |
[in] | dst_path | The destination path on the device. |
[in] | callback | The file sending progress callback. |
[in] | async | Whether to execute asynchronously. |
[in] | user_data | User-defined data that will be returned in the callback. |
[out] | error | Log error messages. |
bool ob_device_activate_authorization | +( | +ob_device * | +device, | +
+ | + | const char * | +auth_code, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Verify the device authorization code.
+[in] | device | The device object. |
[in] | auth_code | The authorization code. |
[out] | error | Log error messages. |
void ob_device_write_authorization_code | +( | +ob_device * | +device, | +
+ | + | const char * | +auth_code, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Write the device authorization code.
+[in] | device | The device object. |
[in] | auth_code | The authorization code. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[out] | error | Log error messages. |
ob_depth_work_mode ob_device_get_current_depth_work_mode | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the current depth work mode.
+[in] | device | The device object. |
[out] | error | Log error messages. |
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_name to switch depth mode when the complete name of the depth work mode is known.
+[in] | device | The device object. |
[in] | work_mode | The depth work mode from ob_depth_work_mode_list which is returned by ob_device_get_depth_work_mode_list. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[in] | mode_name | The depth work mode name which is equal to ob_depth_work_mode.name. |
[out] | error | Log error messages. |
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.
+[in] | device | The device object. |
[out] | error | Log error messages. |
void ob_device_reboot | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Device reboot.
+[in] | device | Device object |
[out] | error | Log error messages |
ob_device_sync_config ob_device_get_sync_config | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the current device synchronization configuration.
+Device synchronization: including exposure synchronization function and multi-camera synchronization function of different sensors within a single machine
+[in] | device | Device object |
[out] | error | Log error messages |
void ob_device_set_sync_config | +( | +ob_device * | +device, | +
+ | + | ob_device_sync_config | +device_sync_config, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the device synchronization configuration.
+Used to configure the exposure synchronization function and multi-camera synchronization function of different sensors in a single machine
+[in] | device | Device object |
[out] | device_sync_config | Device synchronization configuration |
[out] | error | Log error messages |
const char * ob_device_info_name | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get device name.
+[in] | info | Device Information |
[out] | error | Log error messages |
int ob_device_info_pid | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get device pid.
+[in] | info | Device Information |
[out] | error | Log error messages |
int ob_device_info_vid | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get device vid.
+[in] | info | Device Information |
[out] | error | Log error messages |
const char * ob_device_info_uid | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get device uid.
+[in] | info | Device Information |
[out] | error | Log error messages |
const char * ob_device_info_serial_number | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get device serial number.
+[in] | info | Device Information |
[out] | error | Log error messages |
const char * ob_device_info_firmware_version | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the firmware version number.
+[in] | info | Device Information |
[out] | error | Log error messages |
const char * ob_device_info_usb_type | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the USB connection type (DEPRECATED)
+[in] | info | Device Information |
[out] | error | Log error messages |
const char * ob_device_info_connection_type | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the device connection type.
+[in] | info | Device Information |
[out] | error | Log error messages |
const char * ob_device_info_ip_address | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the device IP address.
+info | Device Information |
error | Log error messages |
const char * ob_device_info_hardware_version | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the hardware version number.
+[in] | info | Device Information |
[out] | error | Log error messages |
const char * ob_device_info_get_extension_info | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the device extension information.
+[in] | info | Device Information |
[out] | error | Log error messages |
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.
+[in] | info | Device Information |
[out] | error | Log error messages |
const char * ob_device_info_asicName | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the chip name.
+[in] | info | Device Information |
[out] | error | Log error messages |
ob_device_type ob_device_info_device_type | +( | +ob_device_info * | +info, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the device type.
+[in] | info | Device Information |
[out] | error | Log error messages |
uint32_t ob_camera_param_list_count | +( | +ob_camera_param_list * | +param_list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the number of camera parameter lists.
+param_list | Camera parameter list |
error | Log error messages |
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.
+param_list | Camera parameter list |
index | Parameter index |
error | Log error messages |
void ob_delete_camera_param_list | +( | +ob_camera_param_list * | +param_list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete the camera parameter list.
+param_list | Camera parameter list |
error | Log error messages |
uint32_t ob_depth_work_mode_list_count | +( | +ob_depth_work_mode_list * | +work_mode_list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
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.
+[in] | work_mode_list | Data structure containing a list of ob_depth_work_mode |
[in] | index | Index of the target ob_depth_work_mode |
[out] | error | Log error messages |
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.
+[in] | work_mode_list | Data structure containing a list of ob_depth_work_mode |
[out] | error | Log error messages |
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.
+data_bundle | Data bundle | |
[out] | error | Log error messages |
bool ob_device_is_global_timestamp_supported | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Check if the device supports global timestamp.
+[in] | device | The device object. |
[out] | error | Log error messages. |
void ob_device_load_depth_filter_config | +( | +ob_device * | +device, | +
+ | + | const char * | +file_path, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Load depth filter config from file.
+[in] | device | The device object. |
[in] | file_path | Path of the config file. |
[out] | error | Log error messages. |
void ob_device_reset_default_depth_filter_config | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Reset depth filter config to device default define.
+[in] | device | The device object. |
[out] | error | Log error messages. |
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 specific effect or function.
+@breif Get the current preset name.
+device | The device object. |
error | Log error messages. |
void ob_device_load_preset | +( | +ob_device * | +device, | +
+ | + | const char * | +preset_name, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the available preset list.
+device | The device object. |
preset_name | Log error messages. The name should be one of the preset names returned by ob_device_get_available_preset_list. |
error | Log error messages. |
void ob_device_load_preset_from_json_file | +( | +ob_device * | +device, | +
+ | + | const char * | +json_file_path, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Load preset from json string.
+After loading the custom preset, the settings in the custom preset will set to the device immediately.
+After loading the custom preset, the available preset list will be appended with the custom preset and named as the file name.
+device | The device object. |
json_file_path | The json file path. |
error | Log error messages. |
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.
+After exporting the custom preset, the available preset list will be appended with the custom preset and named as the file name.
+device | The device object. |
json_file_path | The json file path. |
error | Log error messages. |
ob_device_preset_list * ob_device_get_available_preset_list | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the available preset list.
+device | The device object. |
error | Log error messages. |
void ob_delete_preset_list | +( | +ob_device_preset_list * | +preset_list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete the available preset list.
+preset_list | The available preset list. |
error | Log error messages. |
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.
+preset_list | The available preset list. |
error | Log error messages. |
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.
+preset_list | The available preset list. |
index | The index of the preset in the preset list. |
error | Log error messages. |
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.
+preset_list | The available preset list. |
preset_name | The name of the preset. |
error | Log error messages. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Device related types, including operations such as getting and creating a device, setting and obtaining device attributes, and obtaining sensors. +More...
+#include "Types.hpp"
#include "libobsensor/h/Property.h"
#include "libobsensor/hpp/Filter.hpp"
#include <memory>
#include <string>
#include <vector>
Go to the source code of this file.
++Classes | |
class | ob::Device |
class | ob::DeviceInfo |
A class describing device information, representing the name, id, serial number and other basic information of an RGBD camera. More... | |
class | ob::DeviceList |
Class representing a list of devices. More... | |
class | ob::CameraParamList |
Class representing a list of camera parameters. More... | |
class | ob::OBDepthWorkModeList |
Class representing a list of OBDepthWorkMode. More... | |
class | ob::DevicePresetList |
Class representing a list of device presets @breif A device preset is a set of parameters or configurations that can be applied to the device to achieve a specific effect or function. More... | |
+Namespaces | |
namespace | ob |
+Macros | |
#define | timerReset timestampReset |
Alias for timestampReset since it is more accurate. | |
Device related types, including operations such as getting and creating a device, setting and obtaining device attributes, and obtaining sensors.
+ +Definition in file Device.hpp.
+#define timerReset timestampReset | +
Alias for timestampReset since it is more accurate.
+ +Definition at line 528 of file Device.hpp.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Functions for handling errors, mainly used for obtaining error messages. +More...
+#include "ObTypes.h"
Go to the source code of this file.
++Functions | |
ob_status | ob_error_status (ob_error *error) |
Get the error status. | |
const char * | ob_error_message (const ob_error *error) |
Get the error message. | |
const char * | ob_error_function (ob_error *error) |
Get the name of the API function that caused the error. | |
const char * | ob_error_args (ob_error *error) |
Get the error parameters. | |
ob_exception_type | ob_error_exception_type (ob_error *error) |
Get the type of exception that caused the error. | |
void | ob_delete_error (ob_error *error) |
Delete the error object. | |
Functions for handling errors, mainly used for obtaining error messages.
+ +Definition in file Error.h.
+Get the error status.
+[in] | error | The error object. |
const char * ob_error_message | +( | +const ob_error * | +error | ) | ++ |
Get the error message.
+[in] | error | The error object. |
const char * ob_error_function | +( | +ob_error * | +error | ) | ++ |
Get the name of the API function that caused the error.
+[in] | error | The error object. |
const char * ob_error_args | +( | +ob_error * | +error | ) | ++ |
Get the error parameters.
+[in] | error | The error object. |
ob_exception_type ob_error_exception_type | +( | +ob_error * | +error | ) | ++ |
Get the type of exception that caused the error.
+[in] | error | The error object. |
void ob_delete_error | +( | +ob_error * | +error | ) | ++ |
Delete the error object.
+[in] | error | The error object to delete. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This file defines the Error class, which describes abnormal errors within the SDK. Detailed information about the exception can be obtained through this class. +More...
+ +Go to the source code of this file.
++Classes | |
class | ob::Error |
+Namespaces | |
namespace | ob |
This file defines the Error class, which describes abnormal errors within the SDK. Detailed information about the exception can be obtained through this class.
+ +Definition in file Error.hpp.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The processing unit of the SDK can perform point cloud generation, format conversion and other functions. +More...
+#include "ObTypes.h"
Go to the source code of this file.
++Functions | |
ob_filter * | ob_create_pointcloud_filter (ob_error **error) |
Create a PointCloud Filter. | |
void | ob_pointcloud_filter_set_camera_param (ob_filter *filter, ob_camera_param param, ob_error **error) |
Set the camera parameters for the PointCloud Filter. | |
void | ob_pointcloud_filter_set_point_format (ob_filter *filter, ob_format type, ob_error **error) |
Set the point cloud type parameters for the PointCloud Filter. | |
void | ob_pointcloud_filter_set_frame_align_state (ob_filter *filter, bool state, ob_error **error) |
Set the alignment state of the frames that will be input to produce the point cloud. | |
void | ob_pointcloud_filter_set_position_data_scale (ob_filter *filter, float scale, ob_error **error) |
Set the point cloud data scaling factor. | |
void | ob_pointcloud_filter_set_color_data_normalization (ob_filter *filter, bool state, ob_error **error) |
Set the point cloud color data normalization. | |
void | ob_pointcloud_filter_set_coordinate_system (ob_filter *filter, ob_coordinate_system_type type, ob_error **error) |
Set the point cloud coordinate system. | |
ob_filter * | ob_create_format_convert_filter (ob_error **error) |
Create a format convert Filter. | |
void | ob_format_convert_filter_set_format (ob_filter *filter, ob_convert_format type, ob_error **error) |
Set the type of format conversion for the format convert Filter. | |
ob_filter * | ob_create_compression_filter (ob_error **error) |
Create a compression Filter. | |
void | ob_compression_filter_set_compression_params (ob_filter *filter, ob_compression_mode mode, void *params, ob_error **error) |
Set the compression parameters for the compression Filter. | |
ob_filter * | ob_create_decompression_filter (ob_error **error) |
Create a decompression Filter. | |
ob_filter * | ob_create_holefilling_filter (ob_error **error) |
Create a HoleFilling Filter. | |
void | ob_holefilling_filter_set_mode (ob_filter *filter, ob_hole_filling_mode mode, ob_error **error) |
Set the HoleFillingFilter mode. | |
ob_hole_filling_mode | ob_holefilling_filter_get_mode (ob_filter *filter, ob_error **error) |
Get the HoleFillingFilter mode. | |
ob_filter * | ob_create_temporal_filter (ob_error **error) |
Create a Temporal Filter. | |
ob_float_property_range | ob_temporal_filter_get_diffscale_range (ob_filter *filter, ob_error **error) |
Get the TemporalFilter diffscale range. | |
void | ob_temporal_filter_set_diffscale_value (ob_filter *filter, float value, ob_error **error) |
Set the TemporalFilter diffscale value. | |
ob_float_property_range | ob_temporal_filter_get_weight_range (ob_filter *filter, ob_error **error) |
Get the TemporalFilter weight range. | |
void | ob_temporal_filter_set_weight_value (ob_filter *filter, float value, ob_error **error) |
Set the TemporalFilter weight range. | |
ob_filter * | ob_create_spatial_advanced_filter (ob_error **error) |
Create a spatial advanced filter. | |
ob_float_property_range | ob_spatial_advanced_filter_get_alpha_range (ob_filter *filter, ob_error **error) |
Get the spatial advanced filter alpha range. | |
ob_uint16_property_range | ob_spatial_advanced_filter_get_disp_diff_range (ob_filter *filter, ob_error **error) |
Get the spatial advanced filter disp diff range. | |
ob_uint16_property_range | ob_spatial_advanced_filter_get_radius_range (ob_filter *filter, ob_error **error) |
Get the spatial advanced filter radius range. | |
ob_int_property_range | ob_spatial_advanced_filter_get_magnitude_range (ob_filter *filter, ob_error **error) |
Get the spatial advanced filter magnitude range. | |
ob_spatial_advanced_filter_params | ob_spatial_advanced_filter_get_filter_params (ob_filter *filter, ob_error **error) |
Get the spatial advanced filter params. | |
void | ob_spatial_advanced_filter_set_filter_params (ob_filter *filter, ob_spatial_advanced_filter_params params, ob_error **error) |
Set the spatial advanced filter params. | |
ob_filter * | ob_create_spatial_fast_filter (ob_error **error) |
Create a spatial fast filter. | |
ob_uint8_property_range | ob_spatial_fast_filter_get_size_range (ob_filter *filter, ob_error **error) |
Get the spatial fast filter window size range. | |
void | ob_spatial_fast_filter_set_filter_params (ob_filter *filter, ob_spatial_fast_filter_params params, ob_error **error) |
Set the spatial fast filter params. | |
ob_spatial_fast_filter_params | ob_spatial_fast_filter_get_filter_params (ob_filter *filter, ob_error **error) |
Get the spatial fast filter params. | |
ob_filter * | ob_create_spatial_moderate_filter (ob_error **error) |
Create a spatial moderate filter. | |
ob_uint16_property_range | ob_spatial_moderate_filter_get_disp_diff_range (ob_filter *filter, ob_error **error) |
Get the spatial moderate filter disp diff range. | |
ob_uint8_property_range | ob_spatial_moderate_filter_get_magnitude_range (ob_filter *filter, ob_error **error) |
Get the spatial moderate filter magnitude range. | |
ob_uint8_property_range | ob_spatial_moderate_filter_get_size_range (ob_filter *filter, ob_error **error) |
Get the spatial moderate filter window size range. | |
ob_spatial_moderate_filter_params | ob_spatial_moderate_filter_get_filter_params (ob_filter *filter, ob_error **error) |
Get the spatial moderate filter params. | |
void | ob_spatial_moderate_filter_set_filter_params (ob_filter *filter, ob_spatial_moderate_filter_params params, ob_error **error) |
Set the spatial moderate filter params. | |
ob_filter * | ob_create_noise_removal_filter (ob_error **error) |
Create a noise removal filter. | |
ob_uint16_property_range | ob_noise_removal_filter_get_disp_diff_range (ob_filter *filter, ob_error **error) |
Get the noise removal filter disp diff range. | |
ob_int_property_range | ob_noise_removal_filter_get_max_size_range (ob_filter *filter, ob_error **error) |
Get the noise removal filter max size range. | |
void | ob_noise_removal_filter_set_filter_params (ob_filter *filter, ob_noise_removal_filter_params params, ob_error **error) |
Set the noise removal filter params. | |
ob_noise_removal_filter_params | ob_noise_removal_filter_get_filter_params (ob_filter *filter, ob_error **error) |
Get the noise removal filter params. | |
ob_filter * | ob_create_edge_noise_removal_filter (ob_error **error) |
Create a edge noise removal filter. | |
void | ob_edge_noise_removal_filter_set_filter_params (ob_filter *filter, ob_edge_noise_removal_filter_params params, ob_error **error) |
Set the edge noise removal filter params. | |
ob_edge_noise_removal_filter_params | ob_edge_noise_removal_filter_get_filter_params (ob_filter *filter, ob_error **error) |
Get the edge noise removal filter params. | |
ob_uint16_property_range | ob_edge_noise_removal_filter_get_margin_left_th_range (ob_filter *filter, ob_error **error) |
Get the noise removal filter margin left th range. | |
ob_uint16_property_range | ob_edge_noise_removal_filter_get_margin_right_th_range (ob_filter *filter, ob_error **error) |
Get the noise removal filter margin right th range. | |
ob_uint16_property_range | ob_edge_noise_removal_filter_get_margin_top_th_range (ob_filter *filter, ob_error **error) |
Get the noise removal filter margin top th range. | |
ob_uint16_property_range | ob_edge_noise_removal_filter_get_margin_bottom_th_range (ob_filter *filter, ob_error **error) |
Get the noise removal filter margin bottom th range. | |
ob_filter * | ob_create_decimation_filter (ob_error **error) |
Create a decimation filter. | |
ob_uint8_property_range | ob_decimation_filter_get_scale_range (ob_filter *filter, ob_error **error) |
Get the decimation filter scale range. | |
void | ob_decimation_filter_set_scale_value (ob_filter *filter, uint8_t value, ob_error **error) |
Set the decimation filter scale value. | |
uint8_t | ob_decimation_filter_get_scale_value (ob_filter *filter, ob_error **error) |
Get the decimation filter scale value. | |
ob_filter * | ob_create_threshold_filter (ob_error **error) |
Create a threshold filter. | |
ob_int_property_range | ob_threshold_filter_get_min_range (ob_filter *filter, ob_error **error) |
Get the threshold filter min range. | |
ob_int_property_range | ob_threshold_filter_get_max_range (ob_filter *filter, ob_error **error) |
Get the threshold filter max range. | |
bool | ob_threshold_filter_set_scale_value (ob_filter *filter, uint16_t min, uint16_t max, ob_error **error) |
Set the threshold filter scale range. | |
ob_filter * | ob_create_sequenceId_filter (ob_error **error) |
Create a SequenceId filter. | |
void | ob_sequence_id_filter_select_sequence_id (ob_filter *filter, int sequence_id, ob_error **error) |
Set the sequence id filter select sequence id. | |
int | ob_sequence_id_filter_get_sequence_id (ob_filter *filter, ob_error **error) |
Get the current sequence id. | |
ob_sequence_id_item * | ob_sequence_id_filter_get_sequence_id_list (ob_filter *filter, ob_error **error) |
Get the current sequence id list. | |
int | ob_sequence_id_filter_get_sequence_id_list_size (ob_filter *filter, ob_error **error) |
Get the current sequence id list size. | |
ob_filter * | ob_create_hdr_merge (ob_error **error) |
Create a hdr merge. | |
ob_filter * | ob_create_align (ob_error **error, ob_stream_type align_to_stream) |
Create a align. | |
ob_stream_type | ob_align_get_to_stream_type (ob_filter *filter, ob_error **error) |
Get the algin stream type. | |
ob_filter * | ob_create_disparity_transform (ob_error **error, bool depth_to_disparity) |
Create a disparity transform. | |
void | ob_filter_reset (ob_filter *filter, ob_error **error) |
Reset the filter, clears the cache, and resets the state. If the asynchronous interface is used, the processing thread will also be stopped and the pending cache frames will be cleared. | |
ob_frame * | ob_filter_process (ob_filter *filter, ob_frame *frame, ob_error **error) |
Process the frame (synchronous interface). | |
void | ob_filter_enable (ob_filter *filter, bool enable, ob_error **error) |
Enable the frame post processing. | |
bool | ob_filter_is_enable (ob_filter *filter, ob_error **error) |
Get the enable status of the frame post processing. | |
void | ob_filter_set_callback (ob_filter *filter, ob_filter_callback callback, void *user_data, ob_error **error) |
Set the processing result callback function for the filter (asynchronous callback interface). | |
void | ob_filter_push_frame (ob_filter *filter, ob_frame *frame, ob_error **error) |
Push the frame into the pending cache for the filter (asynchronous callback interface). | |
void | ob_delete_filter (ob_filter *filter, ob_error **error) |
Delete the filter. | |
The processing unit of the SDK can perform point cloud generation, format conversion and other functions.
+ +Definition in file Filter.h.
+Create a PointCloud Filter.
+[out] | error | Log error messages. |
void ob_pointcloud_filter_set_camera_param | +( | +ob_filter * | +filter, | +
+ | + | ob_camera_param | +param, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the camera parameters for the PointCloud Filter.
+[in] | filter | A pointcloud_filter object. |
[in] | param | Camera parameters. |
[out] | error | Log error messages. |
void ob_pointcloud_filter_set_point_format | +( | +ob_filter * | +filter, | +
+ | + | ob_format | +type, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the point cloud type parameters for the PointCloud Filter.
+[in] | filter | A pointcloud_filter object. |
[in] | type | Point cloud type: depth point cloud or RGBD point cloud. |
[out] | error | Log error messages. |
void ob_pointcloud_filter_set_frame_align_state | +( | +ob_filter * | +filter, | +
+ | + | bool | +state, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the alignment state of the frames that will be input to produce the point cloud.
+[in] | filter | A pointcloud_filter object. |
[in] | state | Alignment status, True: aligned; False: unaligned. |
[out] | error | Log error messages. |
void ob_pointcloud_filter_set_position_data_scale | +( | +ob_filter * | +filter, | +
+ | + | float | +scale, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the point cloud data scaling factor.
+[in] | filter | A pointcloud_filter object. |
[in] | scale | Set the point cloud coordinate data zoom factor. |
[out] | error | Log error messages. |
void ob_pointcloud_filter_set_color_data_normalization | +( | +ob_filter * | +filter, | +
+ | + | bool | +state, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the point cloud color data normalization.
+[in] | filter | A pointcloud_filter object. |
[in] | state | Sets whether the point cloud color data is normalized. |
[out] | error | Log error messages. |
void ob_pointcloud_filter_set_coordinate_system | +( | +ob_filter * | +filter, | +
+ | + | ob_coordinate_system_type | +type, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the point cloud coordinate system.
+[in] | filter | A pointcloud_filter object. |
[in] | type | Coordinate system type. |
[out] | error | Log error messages. |
Create a format convert Filter.
+[out] | error | Log error messages. |
void ob_format_convert_filter_set_format | +( | +ob_filter * | +filter, | +
+ | + | ob_convert_format | +type, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the type of format conversion for the format convert Filter.
+[in] | filter | A format convert filter object. |
[in] | type | Format conversion type. |
[out] | error | Log error messages. |
Create a compression Filter.
+[out] | error | Log error messages. |
void ob_compression_filter_set_compression_params | +( | +ob_filter * | +filter, | +
+ | + | ob_compression_mode | +mode, | +
+ | + | void * | +params, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the compression parameters for the compression Filter.
+[in] | filter | A compression_filter object. |
[in] | mode | Compression mode OB_COMPRESSION_LOSSLESS or OB_COMPRESSION_LOSSY. |
[in] | params | Compression params, struct ob_compression_params, when mode is OB_COMPRESSION_LOSSLESS, params is NULL. |
[out] | error | Log error messages. |
Create a decompression Filter.
+[out] | error | Log error messages. |
Create a HoleFilling Filter.
+[out] | error | Log error messages. |
void ob_holefilling_filter_set_mode | +( | +ob_filter * | +filter, | +
+ | + | ob_hole_filling_mode | +mode, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the HoleFillingFilter mode.
+[in] | filter | A holefilling_filter object. |
[in] | mode | holefilling mode OB_HOLE_FILL_TOP,OB_HOLE_FILL_NEAREST or OB_HOLE_FILL_FAREST. |
[out] | error | Log error messages. |
ob_hole_filling_mode ob_holefilling_filter_get_mode | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the HoleFillingFilter mode.
+[in] | filter | A holefilling_filter object. |
[out] | error | Log error messages. |
Create a Temporal Filter.
+[out] | error | Log error messages. |
ob_float_property_range ob_temporal_filter_get_diffscale_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the TemporalFilter diffscale range.
+[in] | filter | A temporal_filter object. |
[out] | error | Log error messages. |
void ob_temporal_filter_set_diffscale_value | +( | +ob_filter * | +filter, | +
+ | + | float | +value, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the TemporalFilter diffscale value.
+[in] | filter | A temporal_filter object. |
[in] | value | diffscale value. |
[out] | error | Log error messages. |
ob_float_property_range ob_temporal_filter_get_weight_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the TemporalFilter weight range.
+[in] | filter | A temporal filter object. |
[out] | error | Log error messages. |
void ob_temporal_filter_set_weight_value | +( | +ob_filter * | +filter, | +
+ | + | float | +value, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the TemporalFilter weight range.
+[in] | filter | A temporal_filter object. |
[in] | value | weight value. |
[out] | error | Log error messages. |
Create a spatial advanced filter.
+[out] | error | Log error messages. |
ob_float_property_range ob_spatial_advanced_filter_get_alpha_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial advanced filter alpha range.
+[in] | filter | A spatial advanced filter object. |
[out] | error | Log error messages. |
ob_uint16_property_range ob_spatial_advanced_filter_get_disp_diff_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial advanced filter disp diff range.
+[in] | filter | A spatial advanced filter object. |
[out] | error | Log error messages. |
ob_uint16_property_range ob_spatial_advanced_filter_get_radius_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial advanced filter radius range.
+[in] | filter | A spatial advanced filter object. |
[out] | error | Log error messages. |
ob_int_property_range ob_spatial_advanced_filter_get_magnitude_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial advanced filter magnitude range.
+[in] | filter | A spatial advanced filter object. |
[out] | error | Log error messages. |
ob_spatial_advanced_filter_params ob_spatial_advanced_filter_get_filter_params | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial advanced filter params.
+[in] | filter | A spatial advanced filter object. |
[out] | error | Log error messages. |
void ob_spatial_advanced_filter_set_filter_params | +( | +ob_filter * | +filter, | +
+ | + | ob_spatial_advanced_filter_params | +params, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the spatial advanced filter params.
+[in] | filter | A spatial advanced filter object. |
[in] | params | ob_spatial_advanced_filter_params. |
[out] | error | Log error messages. |
Create a spatial fast filter.
+[out] | error | Log error messages. |
ob_uint8_property_range ob_spatial_fast_filter_get_size_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial fast filter window size range.
+[in] | filter | A spatial fast filter object. |
[out] | error | Log error messages. |
void ob_spatial_fast_filter_set_filter_params | +( | +ob_filter * | +filter, | +
+ | + | ob_spatial_fast_filter_params | +params, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the spatial fast filter params.
+[in] | filter | A spatial fast filter object. |
[in] | params | ob_spatial_fast_filter_params. |
[out] | error | Log error messages. |
ob_spatial_fast_filter_params ob_spatial_fast_filter_get_filter_params | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial fast filter params.
+[in] | filter | A spatial fast filter object. |
[out] | error | Log error messages. |
Create a spatial moderate filter.
+[out] | error | Log error messages. |
ob_uint16_property_range ob_spatial_moderate_filter_get_disp_diff_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial moderate filter disp diff range.
+[in] | filter | A spatial moderate filter object. |
[out] | error | Log error messages. |
ob_uint8_property_range ob_spatial_moderate_filter_get_magnitude_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial moderate filter magnitude range.
+[in] | filter | A spatial moderate filter object. |
[out] | error | Log error messages. |
ob_uint8_property_range ob_spatial_moderate_filter_get_size_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial moderate filter window size range.
+[in] | filter | A spatial moderate filter object. |
[out] | error | Log error messages. |
ob_spatial_moderate_filter_params ob_spatial_moderate_filter_get_filter_params | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the spatial moderate filter params.
+[in] | filter | A spatial moderate filter object. |
[out] | error | Log error messages. |
void ob_spatial_moderate_filter_set_filter_params | +( | +ob_filter * | +filter, | +
+ | + | ob_spatial_moderate_filter_params | +params, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the spatial moderate filter params.
+[in] | filter | A spatial moderate filter object. |
[in] | params | ob_spatial_moderate_filter_params. |
[out] | error | Log error messages. |
Create a noise removal filter.
+[out] | error | Log error messages. |
ob_uint16_property_range ob_noise_removal_filter_get_disp_diff_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the noise removal filter disp diff range.
+[in] | filter | A noise removal filter object. |
[out] | error | Log error messages. |
ob_int_property_range ob_noise_removal_filter_get_max_size_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the noise removal filter max size range.
+[in] | filter | noise removal filter object. |
[out] | error | Log error messages. |
void ob_noise_removal_filter_set_filter_params | +( | +ob_filter * | +filter, | +
+ | + | ob_noise_removal_filter_params | +params, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the noise removal filter params.
+[in] | filter | noise removal filter object. |
[in] | params | ob_noise_removal_filter_params. |
[out] | error | Log error messages. |
ob_noise_removal_filter_params ob_noise_removal_filter_get_filter_params | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the noise removal filter params.
+[in] | filter | noise removal filter object. |
[out] | error | Log error messages. |
Create a edge noise removal filter.
+[out] | error | Log error messages. |
void ob_edge_noise_removal_filter_set_filter_params | +( | +ob_filter * | +filter, | +
+ | + | ob_edge_noise_removal_filter_params | +params, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the edge noise removal filter params.
+[in] | filter | edge noise removal filter object. |
[in] | params | ob_edge_noise_removal_filter_params. |
[out] | error | Log error messages. |
ob_edge_noise_removal_filter_params ob_edge_noise_removal_filter_get_filter_params | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the edge noise removal filter params.
+[in] | filter | edge noise removal filter object. |
[out] | error | Log error messages. |
ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_left_th_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the noise removal filter margin left th range.
+[in] | filter | A edge noise removal filter object. |
[out] | error | Log error messages. |
ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_right_th_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the noise removal filter margin right th range.
+[in] | filter | A edge noise removal filter object. |
[out] | error | Log error messages. |
ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_top_th_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the noise removal filter margin top th range.
+[in] | filter | A edge noise removal filter object. |
[out] | error | Log error messages. |
ob_uint16_property_range ob_edge_noise_removal_filter_get_margin_bottom_th_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the noise removal filter margin bottom th range.
+[in] | filter | A edge noise removal filter object. |
[out] | error | Log error messages. |
Create a decimation filter.
+[out] | error | Log error messages. |
ob_uint8_property_range ob_decimation_filter_get_scale_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the decimation filter scale range.
+[in] | filter | A decimation filter object. |
[out] | error | Log error messages. |
void ob_decimation_filter_set_scale_value | +( | +ob_filter * | +filter, | +
+ | + | uint8_t | +value, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the decimation filter scale value.
+[in] | filter | A decimation object. |
[in] | value | decimation filter scale value. |
[out] | error | Log error messages. |
uint8_t ob_decimation_filter_get_scale_value | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the decimation filter scale value.
+[in] | filter | A decimation object. |
[out] | error | Log error messages. |
Create a threshold filter.
+[out] | error | Log error messages. |
ob_int_property_range ob_threshold_filter_get_min_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the threshold filter min range.
+[in] | filter | A threshold filter object. |
[out] | error | Log error messages. |
ob_int_property_range ob_threshold_filter_get_max_range | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the threshold filter max range.
+[in] | filter | A threshold filter object. |
[out] | error | Log error messages. |
bool ob_threshold_filter_set_scale_value | +( | +ob_filter * | +filter, | +
+ | + | uint16_t | +min, | +
+ | + | uint16_t | +max, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the threshold filter scale range.
+[in] | filter | A threshold object. |
[in] | min | threshold filter scale min value. |
[in] | max | threshold filter scale max value. |
[out] | error | Log error messages. |
Create a SequenceId filter.
+[out] | error | Log error messages. |
void ob_sequence_id_filter_select_sequence_id | +( | +ob_filter * | +filter, | +
+ | + | int | +sequence_id, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the sequence id filter select sequence id.
+[in] | filter | A sequence id object. |
[in] | sequence_id | sequence id to pass the filter. |
[out] | error | Log error messages. |
int ob_sequence_id_filter_get_sequence_id | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the current sequence id.
+[in] | filter | A sequence id object. |
[out] | error | Log error messages. |
ob_sequence_id_item * ob_sequence_id_filter_get_sequence_id_list | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the current sequence id list.
+[in] | filter | A sequence id object. |
[out] | error | Log error messages. |
int ob_sequence_id_filter_get_sequence_id_list_size | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the current sequence id list size.
+[in] | filter | A sequence id object. |
[out] | error | Log error messages. |
Create a hdr merge.
+[out] | error | Log error messages. |
ob_filter * ob_create_align | +( | +ob_error ** | +error, | +
+ | + | ob_stream_type | +align_to_stream | +
+ | ) | ++ |
Create a align.
+[in] | align_to_stream | ob_stream_type. |
[out] | error | Log error messages. |
ob_stream_type ob_align_get_to_stream_type | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the algin stream type.
+[in] | filter | A align object. |
[out] | error | Log error messages. |
ob_filter * ob_create_disparity_transform | +( | +ob_error ** | +error, | +
+ | + | bool | +depth_to_disparity | +
+ | ) | ++ |
Create a disparity transform.
+[in] | depth_to_disparity | disparity to depth, depth to disparity Conversion. |
[out] | error | Log error messages. |
void ob_filter_reset | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Reset the filter, clears the cache, and resets the state. If the asynchronous interface is used, the processing thread will also be stopped and the pending cache frames will be cleared.
+[in] | filter | A filter object. |
[out] | error | Log error messages. |
ob_frame * ob_filter_process | +( | +ob_filter * | +filter, | +
+ | + | ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Process the frame (synchronous interface).
+[in] | filter | A filter object. |
[in] | frame | Pointer to the frame object to be processed. |
[out] | error | Log error messages. |
void ob_filter_enable | +( | +ob_filter * | +filter, | +
+ | + | bool | +enable, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Enable the frame post processing.
+[in] | filter | A filter object. |
[in] | enable | enable status |
[out] | error | Log error messages. |
bool ob_filter_is_enable | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the enable status of the frame post processing.
+[in] | filter | A filter object. |
[out] | error | Log error messages. |
void ob_filter_set_callback | +( | +ob_filter * | +filter, | +
+ | + | ob_filter_callback | +callback, | +
+ | + | void * | +user_data, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the processing result callback function for the filter (asynchronous callback interface).
+[in] | filter | A filter object. |
[in] | callback | Callback function. |
[in] | user_data | Arbitrary user data pointer can be passed in and returned from the callback. |
[out] | error | Log error messages. |
void ob_filter_push_frame | +( | +ob_filter * | +filter, | +
+ | + | ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Push the frame into the pending cache for the filter (asynchronous callback interface).
+[in] | filter | A filter object. |
[in] | frame | Pointer to the frame object to be processed. |
[out] | error | Log error messages. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This file contains the Filter class, which is the processing unit of the SDK that can perform point cloud generation, format conversion, and other functions. +More...
+#include "Types.hpp"
#include <functional>
#include <memory>
#include <map>
#include <string>
#include <iostream>
Go to the source code of this file.
++Classes | |
class | ob::Filter |
The Filter class is the base class for all filters in the SDK. More... | |
class | ob::PointCloudFilter |
The PointCloudFilter class is a subclass of Filter that generates point clouds. More... | |
class | ob::FormatConvertFilter |
The FormatConvertFilter class is a subclass of Filter that performs format conversion. More... | |
class | ob::CompressionFilter |
The CompressionFilter class is a subclass of Filter that performs compression. More... | |
class | ob::DecompressionFilter |
The DecompressionFilter class is a subclass of Filter that performs decompression. More... | |
class | ob::HoleFillingFilter |
Hole filling filter,the processing performed depends on the selected hole filling mode. More... | |
class | ob::TemporalFilter |
Temporal filter. More... | |
class | ob::SpatialAdvancedFilter |
Spatial advanced filter smooths the image by calculating frame with alpha and delta settings alpha defines the weight of the current pixel for smoothing, delta defines the depth gradient below which the smoothing will occur as number of depth levels. More... | |
class | ob::SpatialFastFilter |
Spatial fast filter smooths the image by calculating frame with filter window size settings. More... | |
class | ob::SpatialModerateFilter |
Spatial moderate filter smooths the image by calculating frame with filter window size,magnitude and disp diff settings. More... | |
class | ob::DisparityTransform |
Depth to disparity or disparity to depth. More... | |
class | ob::HdrMerge |
HdrMerge processing block, the processing merges between depth frames with different sub-preset sequence ids. More... | |
class | ob::Align |
Align for depth to other or other to depth. More... | |
class | ob::ThresholdFilter |
Creates depth Thresholding filter By controlling min and max options on the block. More... | |
class | ob::SequenceIdFilter |
Create SequenceIdFilter processing block. More... | |
class | ob::NoiseRemovalFilter |
The noise removal filter,removing scattering depth pixels. More... | |
class | ob::DecimationFilter |
Decimation filter,reducing complexity by subsampling depth maps and losing depth details. More... | |
class | ob::EdgeNoiseRemovalFilter |
The edge noise removal filter,removing scattering depth pixels. More... | |
+Namespaces | |
namespace | ob |
+Typedefs | |
typedef std::function< void(std::shared_ptr< Frame >)> | ob::FilterCallback |
A callback function that takes a shared pointer to a Frame object as its argument. | |
This file contains the Filter class, which is the processing unit of the SDK that can perform point cloud generation, format conversion, and other functions.
+ +Definition in file Filter.hpp.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Frame related function is mainly used to obtain frame data and frame information. +More...
+#include "ObTypes.h"
Go to the source code of this file.
++Macros | |
#define | ob_video_frame_metadata ob_frame_metadata |
#define | ob_video_frame_metadata_size ob_frame_metadata_size |
+Functions | |
uint64_t | ob_frame_index (ob_frame *frame, ob_error **error) |
Get the frame index. | |
ob_format | ob_frame_format (ob_frame *frame, ob_error **error) |
Get the frame format. | |
ob_frame_type | ob_frame_get_type (ob_frame *frame, ob_error **error) |
Get the frame type. | |
uint64_t | ob_frame_time_stamp (ob_frame *frame, ob_error **error) |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | ob_frame_time_stamp_us (ob_frame *frame, ob_error **error) |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | ob_frame_system_time_stamp (ob_frame *frame, ob_error **error) |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | ob_frame_system_time_stamp_us (ob_frame *frame, ob_error **error) |
Get the system timestamp of the frame in microseconds. | |
uint64_t | ob_frame_global_time_stamp_us (ob_frame *frame, ob_error **error) |
Get the global timestamp of the frame in microseconds. | |
void * | ob_frame_data (ob_frame *frame, ob_error **error) |
Get frame data. | |
uint32_t | ob_frame_data_size (ob_frame *frame, ob_error **error) |
Get the frame data size. | |
void * | ob_frame_metadata (ob_frame *frame, ob_error **error) |
Get the metadata of the frame. | |
uint32_t | ob_frame_metadata_size (ob_frame *frame, ob_error **error) |
Get the metadata size of the frame. | |
bool | ob_frame_has_metadata (ob_frame *frame, ob_frame_metadata_type type, ob_error **error) |
check if the frame contains the specified metadata | |
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_stream_profile * | ob_frame_get_stream_profile (ob_frame *frame, ob_error **error) |
Get the stream profile of the frame. | |
ob_sensor * | ob_frame_get_sensor (ob_frame *frame, ob_error **error) |
Get the sensor of the frame. | |
ob_device * | ob_frame_get_device (ob_frame *frame, ob_error **error) |
Get the device of the frame. | |
uint32_t | ob_video_frame_width (ob_frame *frame, ob_error **error) |
Get video frame width. | |
uint32_t | ob_video_frame_height (ob_frame *frame, ob_error **error) |
Get video frame height. | |
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 effective bits, and the upper 6 bits are filled with 0) | |
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) | |
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 to give a depth value in millimeters. For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValue*valueScale = 10000*0.1=1000mm. | |
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 is multiplied by the scale to give a position value in millimeters. For example, if scale=0.1, the x-coordinate value of a point is x = 10000, which means that the actual x-coordinate value = x*scale = 10000*0.1 = 1000mm. | |
void | ob_delete_frame (ob_frame *frame, ob_error **error) |
Delete a frame object. | |
uint32_t | ob_frameset_frame_count (ob_frame *frameset, ob_error **error) |
Get the number of frames contained in the frameset. | |
ob_frame * | ob_frameset_depth_frame (ob_frame *frameset, ob_error **error) |
Get the depth frame from the frameset. | |
ob_frame * | ob_frameset_color_frame (ob_frame *frameset, ob_error **error) |
Get the color frame from the frameset. | |
ob_frame * | ob_frameset_ir_frame (ob_frame *frameset, ob_error **error) |
Get the infrared frame from the frameset. | |
ob_frame * | ob_frameset_points_frame (ob_frame *frameset, ob_error **error) |
Get point cloud data from the frameset. | |
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 * | 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_accel_value | ob_accel_frame_value (ob_frame *frame, ob_error **error) |
Get accelerometer frame data. | |
float | ob_accel_frame_temperature (ob_frame *frame, ob_error **error) |
Get the temperature when acquiring the accelerometer frame. | |
ob_gyro_value | ob_gyro_frame_value (ob_frame *frame, ob_error **error) |
Get gyroscope frame data. | |
float | ob_gyro_frame_temperature (ob_frame *frame, ob_error **error) |
Get the temperature when acquiring the gyroscope frame. | |
void | ob_frame_add_ref (ob_frame *frame, ob_error **error) |
Increase the reference count of a frame object. | |
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 * | 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_frame * | ob_create_frameset (ob_error **error) |
Create an empty frameset object. | |
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. | |
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. | |
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. | |
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. | |
Frame related function is mainly used to obtain frame data and frame information.
+ +Definition in file Frame.h.
+#define ob_video_frame_metadata ob_frame_metadata | +
#define ob_video_frame_metadata_size ob_frame_metadata_size | +
uint64_t ob_frame_index | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the frame index.
+[in] | frame | Frame object |
[out] | error | Log wrong message |
ob_format ob_frame_format | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the frame format.
+[in] | frame | Frame object |
[out] | error | Log error messages |
ob_frame_type ob_frame_get_type | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the frame type.
+[in] | frame | Frame object |
[out] | error | Log error messages |
uint64_t ob_frame_time_stamp | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the hardware timestamp of the frame in milliseconds.
+The hardware timestamp is the time point when the frame was captured by the device, on device clock domain.
+[in] | frame | Frame object |
[out] | error | Log error messages |
uint64_t ob_frame_time_stamp_us | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the hardware timestamp of the frame in microseconds.
+The hardware timestamp is the time point when the frame was captured by the device, on device clock domain.
+[in] | frame | Frame object |
[out] | error | Log error messages |
uint64_t ob_frame_system_time_stamp | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the system timestamp of the frame in milliseconds.
+The system timestamp is the time point when the frame was received by the host, on host clock domain.
+[in] | frame | Frame object |
[out] | error | Log error messages |
uint64_t ob_frame_system_time_stamp_us | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the system timestamp of the frame in microseconds.
+The system timestamp is the time point when the frame was received by the host, on host clock domain.
+[in] | frame | Frame object |
[out] | error | Log error messages |
uint64_t ob_frame_global_time_stamp_us | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the global timestamp of the frame in microseconds.
+The global timestamp is the time point when the frame was was captured by the device, and has been converted to the host clock domain. The conversion process base on the device timestamp and can eliminate the timer drift of the device
+[in] | frame | Frame object |
[out] | error | Log error messages |
void * ob_frame_data | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get frame data.
+[in] | frame | Frame object |
[out] | error | Log error messages |
uint32_t ob_frame_data_size | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the frame data size.
+[in] | frame | Frame object |
[out] | error | Log error messages |
void * ob_frame_metadata | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the metadata of the frame.
+[in] | frame | frame object |
[out] | error | Log error messages |
uint32_t ob_frame_metadata_size | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the metadata size of the frame.
+[in] | frame | frame object |
[out] | error | Log error messages |
bool ob_frame_has_metadata | +( | +ob_frame * | +frame, | +
+ | + | ob_frame_metadata_type | +type, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
check if the frame contains the specified metadata
+[in] | frame | frame object |
[in] | type | metadata type, refer to ob_frame_metadata_type |
[out] | error | Log error messages |
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.
+[in] | frame | frame object |
[in] | type | metadata type, refer to ob_frame_metadata_type |
[out] | error | Log error messages |
ob_stream_profile * ob_frame_get_stream_profile | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the stream profile of the frame.
+frame | frame object |
error | Log error messages |
ob_sensor * ob_frame_get_sensor | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the sensor of the frame.
+[in] | frame | frame object |
[out] | error | Log error messages |
ob_device * ob_frame_get_device | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the device of the frame.
+frame | frame object | |
[out] | error | Log error messages |
uint32_t ob_video_frame_width | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get video frame width.
+[in] | frame | Frame object |
[out] | error | Log error messages |
uint32_t ob_video_frame_height | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get video frame height.
+[in] | frame | Frame object |
[out] | error | Log error messages |
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 effective bits, and the upper 6 bits are filled with 0)
+[in] | frame | video frame object |
[out] | error | log error messages |
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)
+frame | Frame object |
ob_error | Log error messages |
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 to give a depth value in millimeters. For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValue*valueScale = 10000*0.1=1000mm.
+[in] | frame | Frame object |
[out] | error | Log error messages |
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 is multiplied by the scale to give a position value in millimeters. For example, if scale=0.1, the x-coordinate value of a point is x = 10000, which means that the actual x-coordinate value = x*scale = 10000*0.1 = 1000mm.
+[in] | frame | Frame object |
[out] | error | Log error messages |
void ob_delete_frame | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete a frame object.
+[in] | frame | The frame object to delete |
[out] | error | Log error messages |
uint32_t ob_frameset_frame_count | +( | +ob_frame * | +frameset, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the number of frames contained in the frameset.
+[in] | frameset | frameset object |
[out] | error | Log error messages |
ob_frame * ob_frameset_depth_frame | +( | +ob_frame * | +frameset, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the depth frame from the frameset.
+[in] | frameset | Frameset object. |
[out] | error | Log error messages. |
ob_frame * ob_frameset_color_frame | +( | +ob_frame * | +frameset, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the color frame from the frameset.
+[in] | frameset | Frameset object. |
[out] | error | Log error messages. |
ob_frame * ob_frameset_ir_frame | +( | +ob_frame * | +frameset, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the infrared frame from the frameset.
+[in] | frameset | Frameset object. |
[out] | error | Log error messages. |
ob_frame * ob_frameset_points_frame | +( | +ob_frame * | +frameset, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get point cloud data from the frameset.
+[in] | frameset | Frameset object. |
[out] | error | Log error messages. |
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.
+[in] | frameset | Frameset object. |
[in] | frame_type | Frame type. |
[out] | error | Log error messages. |
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.
+[in] | frameset | Frameset object. |
[in] | index | The index of the frame. |
[out] | error | Log error messages. |
ob_accel_value ob_accel_frame_value | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get accelerometer frame data.
+[in] | frame | Accelerometer frame. |
[out] | error | Log error messages. |
float ob_accel_frame_temperature | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the temperature when acquiring the accelerometer frame.
+[in] | frame | Accelerometer frame. |
[out] | error | Log error messages. |
ob_gyro_value ob_gyro_frame_value | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get gyroscope frame data.
+[in] | frame | Gyroscope frame. |
[out] | error | Log error messages. |
float ob_gyro_frame_temperature | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the temperature when acquiring the gyroscope frame.
+[in] | frame | Gyroscope frame. |
[out] | error | Log error messages. |
void ob_frame_add_ref | +( | +ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Increase the reference count of a frame object.
+[in] | frame | Frame object to increase the reference count. |
[out] | error | Log error messages. |
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.
+[in] | frame_format | Frame object format. |
[in] | width | Frame object width. |
[in] | height | Frame object height. |
[in] | stride_bytes | Buffer row span. |
[in] | frame_type | Frame object type. |
[out] | error | Log error messages. |
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.
+[in] | frame_format | Frame object format. |
[in] | frame_width | Frame object width. |
[in] | frame_height | Frame object height. |
[in] | buffer | Frame object buffer. |
[in] | buffer_size | Frame object buffer size. |
[in] | buffer_destroy_cb | Destroy callback. |
[in] | buffer_destroy_context | Destroy context. |
[out] | error | Log error messages. |
Create an empty frameset object.
+[out] | error | Log error messages. |
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.
+[in] | frameset | Frameset object. |
[in] | type | Type of frame to add. |
[in] | frame | Frame object to add. |
[out] | error | Log error messages. |
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.
+[in] | frame | Frame object to set the system timestamp for. |
[in] | system_timestamp | System timestamp to set in milliseconds. |
[out] | error | Log error messages. |
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.
+[in] | frame | Frame object to set the device timestamp. |
[in] | device_timestamp | Device timestamp to set in milliseconds. |
[out] | error | Log error messages. |
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.
+[in] | frame | Frame object to set the device timestamp for. |
[in] | device_timestamp_us | Device timestamp to set in microseconds. |
[out] | error | Log error messages. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Frame related type, which is mainly used to obtain frame data and frame information. +More...
+ +Go to the source code of this file.
++Classes | |
class | ob::Frame |
class | ob::VideoFrame |
class | ob::ColorFrame |
class | ob::DepthFrame |
class | ob::IRFrame |
class | ob::PointsFrame |
class | ob::FrameSet |
Define the FrameSet class, which inherits from the Frame class. More... | |
class | ob::AccelFrame |
Define the AccelFrame class, which inherits from the Frame class. More... | |
class | ob::GyroFrame |
Define the GyroFrame class, which inherits from the Frame class. More... | |
class | ob::RawPhaseFrame |
Define the RawPhaseFrame class, which inherits from the VideoFrame class. More... | |
class | ob::FrameHelper |
Define the FrameHelper class. More... | |
+Namespaces | |
namespace | ob |
+Typedefs | |
typedef std::function< void(void *buffer, void *context)> | ob::BufferDestroyCallback |
Frame related type, which is mainly used to obtain frame data and frame information.
+ +Definition in file Frame.hpp.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This file contains the multiple devices related API witch is used to control the synchronization between multiple devices and the synchronization between different sensor within single device. +More...
+ +Go to the source code of this file.
++Macros | |
#define | ob_device_timer_reset ob_device_timestamp_reset |
Alias for ob_device_timestamp_reset since it is more accurate. | |
+Functions | |
uint16_t | ob_device_get_supported_multi_device_sync_mode_bitmap (ob_device *device, ob_error **error) |
Get the supported multi device sync mode bitmap of the device. | |
void | ob_device_set_multi_device_sync_config (ob_device *device, const ob_multi_device_sync_config *config, ob_error **error) |
set the multi device sync configuration of the device. | |
ob_multi_device_sync_config | ob_device_get_multi_device_sync_config (ob_device *device, ob_error **error) |
get the multi device sync configuration of the device. | |
void | ob_device_trigger_capture (ob_device *device, ob_error **error) |
send the capture command to the device. | |
void | ob_device_set_timestamp_reset_config (ob_device *device, const ob_device_timestamp_reset_config *config, ob_error **error) |
set the timestamp reset configuration of the device. | |
ob_device_timestamp_reset_config | ob_device_get_timestamp_reset_config (ob_device *device, ob_error **error) |
get the timestamp reset configuration of the device. | |
void | ob_device_timestamp_reset (ob_device *device, ob_error **error) |
send the timestamp reset command to the device. | |
void | ob_device_timer_sync_with_host (ob_device *device, ob_error **error) |
synchronize the timer of the device with the host. | |
This file contains the multiple devices related API witch is used to control the synchronization between multiple devices and the synchronization between different sensor within single device.
+The synchronization between multiple devices is complex, and different models have different synchronization modes and limitations. please refer to the product manual for details.
+As the Depth and Infrared are the same sensor physically, the behavior of the Infrared is same as the Depth in the synchronization mode.
+ +Definition in file MultipleDevices.h.
+#define ob_device_timer_reset ob_device_timestamp_reset | +
Alias for ob_device_timestamp_reset since it is more accurate.
+ +Definition at line 106 of file MultipleDevices.h.
+ +uint16_t ob_device_get_supported_multi_device_sync_mode_bitmap | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the supported multi device sync mode bitmap of the device.
+For example, if the return value is 0b00001100, it means the device supports OB_MULTI_DEVICE_SYNC_MODE_PRIMARY and OB_MULTI_DEVICE_SYNC_MODE_SECONDARY. User can check the supported mode by the code:
[in] | device | The device handle. |
[out] | error | The error information. |
void ob_device_set_multi_device_sync_config | +( | +ob_device * | +device, | +
+ | + | const ob_multi_device_sync_config * | +config, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
set the multi device sync configuration of the device.
+[in] | device | The device handle. |
[in] | config | The multi device sync configuration. |
[out] | error | The error information. |
ob_multi_device_sync_config ob_device_get_multi_device_sync_config | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
get the multi device sync configuration of the device.
+[in] | device | The device handle. |
[out] | error | The error information. |
void ob_device_trigger_capture | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
send the capture command to the device.
+The device will start one time image capture after receiving the capture command when it is in the OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING
+[in] | device | The device handle. |
[out] | error | The error information. |
void ob_device_set_timestamp_reset_config | +( | +ob_device * | +device, | +
+ | + | const ob_device_timestamp_reset_config * | +config, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
set the timestamp reset configuration of the device.
+[in] | device | The device handle. |
[in] | config | The timestamp reset configuration. |
[out] | error | The error information. |
ob_device_timestamp_reset_config ob_device_get_timestamp_reset_config | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
get the timestamp reset configuration of the device.
+[in] | device | The device handle. |
[out] | error | The error information. |
void ob_device_timestamp_reset | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
send the timestamp reset command to the device.
+The device will reset the timer for calculating the timestamp for output frames to 0 after receiving the timestamp reset command when the timestamp reset function is enabled. The timestamp reset function can be enabled by call ob_device_set_timestamp_reset_config.
+[in] | device | The device handle. |
[out] | error | The error information. |
void ob_device_timer_sync_with_host | +( | +ob_device * | +device, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
synchronize the timer of the device with the host.
+After calling this function, the timer of the device will be synchronized with the host. User can call this function to multiple devices to synchronize all timers of the devices.
+[in] | device | The device handle. |
[out] | error | The error information. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This file serves as the C entrance for the OrbbecSDK library. It includes all necessary header files for OrbbecSDK usage. +More...
+#include <libobsensor/h/Context.h>
#include <libobsensor/h/Device.h>
#include <libobsensor/h/Error.h>
#include <libobsensor/h/Filter.h>
#include <libobsensor/h/Frame.h>
#include <libobsensor/h/ObTypes.h>
#include <libobsensor/h/Pipeline.h>
#include <libobsensor/h/Property.h>
#include <libobsensor/h/RecordPlayback.h>
#include <libobsensor/h/Sensor.h>
#include <libobsensor/h/StreamProfile.h>
#include <libobsensor/h/Version.h>
Go to the source code of this file.
+This file serves as the C entrance for the OrbbecSDK library. It includes all necessary header files for OrbbecSDK usage.
+ +Definition in file ObSensor.h.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the main entry point for the OrbbecSDK C++ library. It includes all necessary header files for using the library. +More...
+#include <libobsensor/hpp/Context.hpp>
#include <libobsensor/hpp/Device.hpp>
#include <libobsensor/hpp/Error.hpp>
#include <libobsensor/hpp/Filter.hpp>
#include <libobsensor/hpp/Frame.hpp>
#include <libobsensor/hpp/Pipeline.hpp>
#include <libobsensor/hpp/RecordPlayback.hpp>
#include <libobsensor/hpp/Sensor.hpp>
#include <libobsensor/hpp/StreamProfile.hpp>
#include <libobsensor/hpp/Types.hpp>
#include <libobsensor/hpp/Version.hpp>
Go to the source code of this file.
+This is the main entry point for the OrbbecSDK C++ library. It includes all necessary header files for using the library.
+ +Definition in file ObSensor.hpp.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Provide structs commonly used in the SDK, enumerating constant definitions. +More...
+#include <stdbool.h>
#include <stdint.h>
Go to the source code of this file.
++Classes | |
struct | ob_error |
The error class exposed by the SDK, users can get detailed error information according to the error. More... | |
struct | OBDataChunk |
Structure for transmitting data blocks. More... | |
struct | OBIntPropertyRange |
Structure for integer range. More... | |
struct | OBFloatPropertyRange |
Structure for float range. More... | |
struct | OBUint16PropertyRange |
Structure for float range. More... | |
struct | OBUint8PropertyRange |
Structure for float range. More... | |
struct | OBBoolPropertyRange |
Structure for boolean range. More... | |
struct | OBCameraIntrinsic |
Structure for camera intrinsic parameters. More... | |
struct | OBAccelIntrinsic |
Structure for accelerometer intrinsic parameters. More... | |
struct | OBGyroIntrinsic |
Structure for gyroscope intrinsic parameters. More... | |
struct | OBCameraDistortion |
Structure for distortion parameters. More... | |
struct | OBCameraAlignIntrinsic |
Video stream intrinsics. More... | |
struct | OBD2CTransform |
Structure for rotation/transformation. More... | |
struct | OBCameraParam |
Structure for camera parameters. More... | |
struct | OBCameraParam_V0 |
Camera parameters. More... | |
struct | OBCalibrationParam |
calibration parameters More... | |
struct | ob_margin_filter_config |
Configuration for depth margin filter. More... | |
struct | OBMGCFilterConfig |
Configuration for mgc filter. More... | |
struct | OBRect |
Rectangle. More... | |
struct | OBAccelValue |
Data structures for accelerometers and gyroscopes. More... | |
struct | OBDeviceTemperature |
Temperature parameters of the device (unit: Celsius) More... | |
struct | OBPoint |
3D point structure in the SDK More... | |
struct | OBPoint2f |
2D point structure in the SDK More... | |
struct | OBXYTables |
struct | OBColorPoint |
3D point structure with color information More... | |
struct | OBCompressionParams |
struct | OBTofExposureThresholdControl |
TOF Exposure Threshold. More... | |
struct | OBDeviceSyncConfig |
Device synchronization configuration. More... | |
struct | OBDepthWorkMode |
Depth work mode. More... | |
struct | OBSequenceIdItem |
SequenceId fliter list item. More... | |
struct | OBSpatialAdvancedFilterParams |
struct | OBSpatialFastFilterParams |
struct | OBSpatialModerateFilterParams |
struct | OBEdgeNoiseRemovalFilterParams |
struct | OBNoiseRemovalFilterParams |
struct | OBProtocolVersion |
Control command protocol version number. More... | |
struct | OBDataBundle |
Internal API for future publication. More... | |
struct | OBNetIpConfig |
IP address configuration for network devices (IPv4) More... | |
struct | ob_multi_device_sync_config |
The synchronization configuration of the device. More... | |
struct | ob_device_timestamp_reset_config |
The timestamp reset configuration of the device. More... | |
struct | BASELINE_CALIBRATION_PARAM |
Baseline calibration parameters. More... | |
struct | HDR_CONFIG |
HDR Configuration. More... | |
struct | AE_ROI |
The rect of the region of interest. More... | |
struct | DISP_OFFSET_CONFIG |
Provide structs commonly used in the SDK, enumerating constant definitions.
+ +Definition in file ObTypes.h.
+#define OB_EXTENSION_API __attribute__((visibility("default"))) | +
#define OB_EXTENSION_INTERNAL_API __attribute__((visibility("default"))) | +
#define OB_FORMAT_ANY OB_FORMAT_UNKNOWN | +
#define OB_ACCEL_FULL_SCALE_RANGE_ANY OB_ACCEL_FS_UNKNOWN | +
#define OB_ACCEL_SAMPLE_RATE_ANY OB_SAMPLE_RATE_UNKNOWN | +
#define OB_GYRO_FULL_SCALE_RANGE_ANY OB_GYRO_FS_UNKNOWN | +
#define OB_GYRO_SAMPLE_RATE_ANY OB_SAMPLE_RATE_UNKNOWN | +
#define OB_LOG_SEVERITY_NONE OB_LOG_SEVERITY_OFF | +
#define OB_FORMAT_RGB888 OB_FORMAT_RGB | +
#define OB_FORMAT_MJPEG OB_FORMAT_MJPG | +
#define FORMAT_MJPEG_TO_I420 FORMAT_MJPG_TO_I420 | +
#define FORMAT_MJPEG_TO_NV21 FORMAT_MJPG_TO_NV21 | +
#define FORMAT_MJPEG_TO_BGRA FORMAT_MJPG_TO_BGRA | +
#define FORMAT_YUYV_TO_RGB888 FORMAT_YUYV_TO_RGB | +
#define FORMAT_I420_TO_RGB888 FORMAT_I420_TO_RGB | +
#define FORMAT_NV21_TO_RGB888 FORMAT_NV21_TO_RGB | +
#define FORMAT_NV12_TO_RGB888 FORMAT_NV12_TO_RGB | +
#define FORMAT_UYVY_TO_RGB888 FORMAT_UYVY_TO_RGB | +
#define FORMAT_MJPG_TO_RGB888 FORMAT_MJPG_TO_RGB | +
#define FORMAT_MJPG_TO_BGR888 FORMAT_MJPG_TO_BGR | +
#define FORMAT_MJPEG_TO_RGB888 FORMAT_MJPG_TO_RGB | +
#define FORMAT_MJPEG_TO_BGR888 FORMAT_MJPG_TO_BGR | +
#define FORMAT_RGB888_TO_BGR FORMAT_RGB_TO_BGR | +
#define OBDeviceIpAddrConfig OBNetIpConfig | +
#define ob_device_ip_addr_config OBNetIpConfig | +
#define OB_FRAME_METADATA_TYPE_LASER_POWER_MODE OB_FRAME_METADATA_TYPE_LASER_POWER_LEVEL | +
#define OB_FRAME_METADATA_TYPE_EMITTER_MODE OB_FRAME_METADATA_TYPE_LASER_STATUS | +
#define ob_filter_callback ob_frame_callback | +
#define ob_playback_callback ob_frame_callback | +
#define is_ir_sensor | +( | ++ | sensor_type | ) | +(sensor_type == OB_SENSOR_IR || sensor_type == OB_SENSOR_IR_LEFT || sensor_type == OB_SENSOR_IR_RIGHT) | +
#define isIRSensor is_ir_sensor | +
#define is_ir_stream | +( | ++ | stream_type | ) | +(stream_type == OB_STREAM_IR || stream_type == OB_STREAM_IR_LEFT || stream_type == OB_STREAM_IR_RIGHT) | +
#define isIRStream is_ir_stream | +
#define is_ir_frame | +( | ++ | frame_type | ) | +(frame_type == OB_FRAME_IR || frame_type == OB_FRAME_IR_LEFT || frame_type == OB_FRAME_IR_RIGHT) | +
#define isIRFrame is_ir_frame | +
#define OB_DEFAULT_DECRYPT_KEY (nullptr) | +
typedef struct ContextImpl ob_context | +
typedef struct DeviceInfoImpl ob_device_info | +
typedef struct DeviceListImpl ob_device_list | +
typedef struct CameraParamListImpl ob_camera_param_list | +
typedef struct SensorListImpl ob_sensor_list | +
typedef struct StreamProfileImpl ob_stream_profile | +
typedef struct StreamProfileListImpl ob_stream_profile_list | +
typedef struct PipelineImpl ob_pipeline | +
typedef struct RecorderImpl ob_recorder | +
typedef struct PlaybackImpl ob_playback | +
typedef struct OBDepthWorkModeListImpl ob_depth_work_mode_list | +
typedef struct FilterListImpl ob_filter_list | +
typedef struct OBFilterListImpl ob_filters | +
typedef struct DevicePresetListImpl ob_device_preset_list | +
typedef enum OBHPStatusCode ob_hp_status_code | +
typedef enum OBPermissionType ob_permission_type | +
typedef enum OBLogSeverity ob_log_severity | +
typedef enum OBLogSeverity DEVICE_LOG_SEVERITY_LEVEL | +
typedef enum OBLogSeverity OBDeviceLogSeverityLevel | +
typedef enum OBLogSeverity ob_device_log_severity_level | +
typedef enum OBExceptionType ob_exception_type | +
The error class exposed by the SDK, users can get detailed error information according to the error.
+ +typedef enum OBSensorType ob_sensor_type | +
typedef enum OBStreamType ob_stream_type | +
typedef enum OBFrameType ob_frame_type | +
typedef enum OBUpgradeState ob_upgrade_state | +
typedef enum OBFileTranState ob_file_tran_state | +
typedef enum OBDataTranState ob_data_tran_state | +
typedef struct OBDataChunk ob_data_chunk | +
typedef struct OBIntPropertyRange ob_int_property_range | +
typedef struct OBFloatPropertyRange ob_float_property_range | +
typedef struct OBUint16PropertyRange ob_uint16_property_range | +
typedef struct OBUint8PropertyRange ob_uint8_property_range | +
typedef struct OBBoolPropertyRange ob_bool_property_range | +
typedef struct OBCameraIntrinsic ob_camera_intrinsic | +
typedef struct OBAccelIntrinsic ob_accel_intrinsic | +
typedef struct OBGyroIntrinsic ob_gyro_intrinsic | +
typedef struct OBCameraDistortion ob_camera_distortion | +
typedef enum OBCameraDistortionModel ob_camera_distortion_model | +
typedef struct OBCameraAlignIntrinsic ob_camera_align_intrinsic | +
typedef struct OBD2CTransform ob_d2c_transform | +
typedef struct OBD2CTransform OBTransform | +
typedef struct OBD2CTransform ob_transform | +
typedef struct OBD2CTransform OBExtrinsic | +
typedef struct OBD2CTransform ob_extrinsic | +
typedef struct OBCameraParam ob_camera_param | +
typedef struct OBCameraParam_V0 ob_camera_param_v0 | +
typedef struct OBCalibrationParam ob_calibration_param | +
typedef struct ob_margin_filter_config OBMarginFilterConfig | +
typedef struct OBMGCFilterConfig ob_mgc_filter_config | +
typedef enum OBAlignMode ob_align_mode | +
typedef enum OBConvertFormat ob_convert_format | +
typedef enum OBGyroSampleRate ob_gyro_sample_rate | +
typedef enum OBGyroSampleRate OBAccelSampleRate | +
typedef enum OBGyroSampleRate ob_accel_sample_rate | +
typedef enum OBGyroSampleRate OB_SAMPLE_RATE | +
typedef enum OBGyroFullScaleRange ob_gyro_full_scale_range | +
typedef enum OBGyroFullScaleRange OB_GYRO_FULL_SCALE_RANGE | +
typedef enum OBAccelFullScaleRange ob_accel_full_scale_range | +
typedef enum OBAccelFullScaleRange OB_ACCEL_FULL_SCALE_RANGE | +
typedef struct OBAccelValue OBGyroValue | +
typedef struct OBAccelValue ob_accel_value | +
typedef struct OBAccelValue ob_gyro_value | +
typedef uint64_t OBDeviceState | +
typedef uint64_t ob_device_state | +
typedef struct OBDeviceTemperature ob_device_temperature | +
typedef struct OBDeviceTemperature DEVICE_TEMPERATURE | +
typedef enum OBDepthCroppingMode ob_depth_cropping_mode | +
typedef enum OBDepthCroppingMode OB_DEPTH_CROPPING_MODE | +
typedef enum OBDeviceType ob_device_type | +
typedef enum OBDeviceType OB_DEVICE_TYPE | +
typedef enum OBMediaType ob_media_type | +
typedef enum OBMediaType OB_MEDIA_TYPE | +
typedef enum OBMediaState ob_media_state | +
typedef enum OBMediaState OB_MEDIA_STATE_EM | +
typedef enum OBDepthPrecisionLevel ob_depth_precision_level | +
typedef enum OBDepthPrecisionLevel OB_DEPTH_PRECISION_LEVEL | +
typedef enum OBTofFilterRange ob_tof_filter_range | +
typedef enum OBTofFilterRange TOF_FILTER_RANGE | +
typedef struct OBPoint ob_point3f | +
typedef struct OBPoint2f ob_point2f | +
typedef struct OBXYTables ob_xy_tables | +
typedef struct OBColorPoint ob_color_point | +
typedef enum OBCompressionMode ob_compression_mode | +
typedef enum OBCompressionMode OB_COMPRESSION_MODE | +
typedef struct OBCompressionParams ob_compression_params | +
typedef struct OBCompressionParams OB_COMPRESSION_PARAMS | +
typedef struct OBTofExposureThresholdControl ob_tof_exposure_threshold_control | +
typedef struct OBTofExposureThresholdControl TOF_EXPOSURE_THRESHOLD_CONTROL | +
typedef enum OBSyncMode ob_sync_mode | +
typedef enum OBSyncMode OB_SYNC_MODE | +
typedef struct OBDeviceSyncConfig ob_device_sync_config | +
typedef struct OBDeviceSyncConfig OB_DEVICE_SYNC_CONFIG | +
typedef struct OBDepthWorkMode ob_depth_work_mode | +
typedef struct OBSequenceIdItem ob_sequence_id_item | +
typedef enum OBHoleFillingMode ob_hole_filling_mode | +
typedef struct OBSpatialAdvancedFilterParams ob_spatial_advanced_filter_params | +
typedef struct OBSpatialFastFilterParams ob_spatial_fast_filter_params | +
typedef struct OBSpatialModerateFilterParams ob_spatial_moderate_filter_params | +
typedef enum OB_EDGE_NOISE_REMOVAL_TYPE OBEdgeNoiseRemovalType | +
typedef enum OB_EDGE_NOISE_REMOVAL_TYPE ob_edge_noise_removal_type | +
typedef struct OBEdgeNoiseRemovalFilterParams ob_edge_noise_removal_filter_params | +
typedef enum OB_DDO_NOISE_REMOVAL_TYPE OBDDONoiseRemovalType | +
去噪方式
+ +typedef enum OB_DDO_NOISE_REMOVAL_TYPE ob_ddo_noise_removal_type | +
typedef struct OBNoiseRemovalFilterParams ob_noise_removal_filter_params | +
typedef struct OBProtocolVersion ob_protocol_version | +
typedef enum OB_CMD_VERSION OBCmdVersion | +
typedef enum OB_CMD_VERSION ob_cmd_version | +
typedef struct OBDataBundle OBDataBundle | +
Internal API for future publication.
+C language: data's type is a uint8_t pointer, and the user parses data to the destination type. itemTypeSize == 1, dataSize == itemCount;
+C++: data's type is the propertyId and OBCmdVersion's data type. itemTypeSize = sizeof(T), itemCount = dataSize / itemTypeSize;
+ +typedef struct OBDataBundle ob_data_bundle | +
typedef struct OBNetIpConfig ob_net_ip_config | +
typedef struct OBNetIpConfig DEVICE_IP_ADDR_CONFIG | +
typedef enum OBCommunicationType ob_communication_type | +
typedef enum OBCommunicationType OB_COMMUNICATION_TYPE | +
typedef enum OBUSBPowerState ob_usb_power_state | +
typedef enum OBDCPowerState ob_dc_power_state | +
typedef enum ob_rotate_degree_type OBRotateDegreeType | +
typedef enum ob_power_line_freq_mode OBPowerLineFreqMode | +
typedef enum OB_FRAME_AGGREGATE_OUTPUT_MODE OBFrameAggregateOutputMode | +
typedef enum OB_FRAME_AGGREGATE_OUTPUT_MODE ob_frame_aggregate_output_mode | +
typedef enum OB_COORDINATE_SYSTEM_TYPE OBCoordinateSystemType | +
typedef enum OB_COORDINATE_SYSTEM_TYPE ob_coordinate_system_type | +
typedef enum OB_DEVICE_DEVELOPMENT_MODE OBDeviceDevelopmentMode | +
typedef enum OB_DEVICE_DEVELOPMENT_MODE ob_device_development_mode | +
typedef enum ob_multi_device_sync_mode OBMultiDeviceSyncMode | +
typedef struct ob_multi_device_sync_config OBMultiDeviceSyncConfig | +
typedef struct ob_device_timestamp_reset_config OBDeviceTimestampResetConfig | +
typedef struct BASELINE_CALIBRATION_PARAM ob_baseline_calibration_param | +
typedef struct BASELINE_CALIBRATION_PARAM OBBaselineCalibrationParam | +
typedef struct HDR_CONFIG ob_hdr_config | +
typedef struct HDR_CONFIG OBHdrConfig | +
typedef struct AE_ROI ob_region_of_interest | +
typedef struct AE_ROI OBRegionOfInterest | +
typedef struct DISP_OFFSET_CONFIG ob_disp_offset_config | +
typedef struct DISP_OFFSET_CONFIG OBDispOffsetConfig | +
typedef enum UVC_BACKEND ob_uvc_backend | +
typedef enum UVC_BACKEND OBUvcBackend | +
typedef enum ob_frame_metadata_type OBFrameMetadataType | +
typedef void(* ob_file_send_callback) (ob_file_tran_state state, const char *message, uint8_t percent, void *user_data) | +
typedef void(* ob_device_upgrade_callback) (ob_upgrade_state state, const char *message, uint8_t percent, void *user_data) | +
typedef void(* ob_device_state_callback) (ob_device_state state, const char *message, void *user_data) | +
typedef void(* ob_set_data_callback) (ob_data_tran_state state, uint8_t percent, void *user_data) | +
typedef void(* ob_get_data_callback) (ob_data_tran_state state, ob_data_chunk *dataChunk, void *user_data) | +
typedef void(* ob_media_state_callback) (ob_media_state state, void *user_data) | +
typedef void(* ob_device_changed_callback) (ob_device_list *removed, ob_device_list *added, void *user_data) | +
typedef void(* ob_frame_callback) (ob_frame *frame, void *user_data) | +
typedef void(* ob_frameset_callback) (ob_frame *frameset, void *user_data) | +
typedef void() ob_frame_destroy_callback(void *buffer, void *user_data) | +
typedef void() ob_log_callback(ob_log_severity severity, const char *message, void *user_data) | +
enum OBHPStatusCode | +
enum OBPermissionType | +
enum OBStatus | +
enum OBLogSeverity | +
enum OBExceptionType | +
The exception types in the SDK, through the exception type, you can easily determine the specific type of error. For detailed error API interface functions and error logs, please refer to the information of ob_error.
+enum OBSensorType | +
Enumeration value describing the sensor type.
+enum OBStreamType | +
Enumeration value describing the type of data stream.
+enum OBFrameType | +
Enumeration value describing the type of frame.
+enum OBFormat | +
Enumeration value describing the pixel format.
+enum OBUpgradeState | +
Enumeration value describing the firmware upgrade status.
+enum OBFileTranState | +
Enumeration value describing the file transfer status.
+enum OBDataTranState | +
Enumeration value describing the data transfer status.
+enum OBCameraDistortionModel | +
Distortion model: defines how pixel coordinates should be mapped to sensor coordinates.
+enum OBAlignMode | +
enum OBConvertFormat | +
Enumeration of format conversion types.
+enum OBGyroSampleRate | +
Enumeration of IMU sample rate values (gyroscope or accelerometer)
+enum OBGyroFullScaleRange | +
Enumeration of gyroscope ranges.
+enum OBAccelFullScaleRange | +
enum OBDepthCroppingMode | +
enum OBDeviceType | +
enum OBMediaType | +
Enumeration for types of media to record or playback.
+enum OBMediaState | +
enum OBDepthPrecisionLevel | +
Enumeration for depth precision levels.
+enum OBTofFilterRange | +
enum OBCompressionMode | +
enum OBSyncMode | +
Sync mode.
+enum OBHoleFillingMode | +
enum OB_EDGE_NOISE_REMOVAL_TYPE | +
enum OB_DDO_NOISE_REMOVAL_TYPE | +
enum OB_CMD_VERSION | +
enum OBCommunicationType | +
enum OBUSBPowerState | +
enum OBDCPowerState | +
enum ob_rotate_degree_type | +
enum ob_power_line_freq_mode | +
enum OB_FRAME_AGGREGATE_OUTPUT_MODE | +
Frame aggregate output mode.
+enum OB_COORDINATE_SYSTEM_TYPE | +
enum OB_DEVICE_DEVELOPMENT_MODE | +
Enumeration of device development modes.
+enum ob_multi_device_sync_mode | +
The synchronization mode of the device.
+Enumerator | |
---|---|
OB_MULTI_DEVICE_SYNC_MODE_FREE_RUN | free run mode +The device does not synchronize with other devices, +The Color and Depth can be set to different frame rates. + |
OB_MULTI_DEVICE_SYNC_MODE_STANDALONE | standalone mode +The device does not synchronize with other devices. +The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized. + |
OB_MULTI_DEVICE_SYNC_MODE_PRIMARY | primary mode +The device is the primary device in the multi-device system, it will output the trigger signal via VSYNC_OUT pin on synchronization port by default. +The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by colorDelayUs, depthDelayUs or trigger2ImageDelayUs. + |
OB_MULTI_DEVICE_SYNC_MODE_SECONDARY | secondary mode +The device is the secondary device in the multi-device system, it will receive the trigger signal via VSYNC_IN pin on synchronization port. It will out the trigger signal via VSYNC_OUT pin on synchronization port by default. +The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by colorDelayUs, depthDelayUs or trigger2ImageDelayUs. +After starting the stream, the device will wait for the trigger signal to start capturing images, and will stop capturing images when the trigger signal is stopped. +
|
OB_MULTI_DEVICE_SYNC_MODE_SECONDARY_SYNCED | secondary synced mode +The device is the secondary device in the multi-device system, it will receive the trigger signal via VSYNC_IN pin on synchronization port. It will out the trigger signal via VSYNC_OUT pin on synchronization port by default. +The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by colorDelayUs, depthDelayUs or trigger2ImageDelayUs. +After starting the stream, the device will be immediately start capturing images, and will adjust the capture time when the trigger signal is received to synchronize with the primary device. If the trigger signal is stopped, the device will still capture images. +
|
OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING | software triggering mode +The device will start one time image capture after receiving the capture command and will output the trigger signal via VSYNC_OUT pin by default. The capture command can be sent form host by call ob_device_trigger_capture. The number of images captured each time can be set by framesPerTrigger. +The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by colorDelayUs, depthDelayUs or trigger2ImageDelayUs. +The frequency of the user call ob_device_trigger_capture to send the capture command multiplied by the number of frames per trigger should be less than the frame rate of the stream profile which is set when starting the stream. + |
OB_MULTI_DEVICE_SYNC_MODE_HARDWARE_TRIGGERING | hardware triggering mode +The device will start one time image capture after receiving the trigger signal via VSYNC_IN pin on synchronization port and will output the trigger signal via VSYNC_OUT pin by default. The number of images captured each time can be set by framesPerTrigger. +The Color and Depth should be set to same frame rates, the Color and Depth will be synchronized and can be adjusted by colorDelayUs, depthDelayUs or trigger2ImageDelayUs. +
|
enum UVC_BACKEND | +
enum ob_frame_metadata_type | +
Frame metadata types.
+The frame metadata is a set of meta info generated by the device for current individual frame.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The SDK's advanced API can quickly implement functions such as switching streaming, frame synchronization, software filtering, etc., suitable for applications, and the algorithm focuses on rgbd data stream scenarios. If you are on real-time or need to handle synchronization separately, align the scene. Please use the interface of Device's Lower API. +More...
+#include "ObTypes.h"
Go to the source code of this file.
++Functions | |
ob_pipeline * | ob_create_pipeline (ob_error **error) |
Create a pipeline object. | |
ob_pipeline * | ob_create_pipeline_with_device (ob_device *dev, ob_error **error) |
Using device objects to create pipeline objects. | |
ob_pipeline * | ob_create_pipeline_with_playback_file (const char *file_name, ob_error **error) |
Use the playback file to create a pipeline object. | |
void | ob_delete_pipeline (ob_pipeline *pipeline, ob_error **error) |
Delete pipeline objects. | |
void | ob_pipeline_start (ob_pipeline *pipeline, ob_error **error) |
Start the pipeline with default parameters. | |
void | ob_pipeline_start_with_config (ob_pipeline *pipeline, ob_config *config, ob_error **error) |
Start the pipeline with configuration parameters. | |
void | ob_pipeline_start_with_callback (ob_pipeline *pipeline, ob_config *config, ob_frameset_callback callback, void *user_data, ob_error **error) |
Start the pipeline and set the frame collection data callback. | |
void | ob_pipeline_stop (ob_pipeline *pipeline, ob_error **error) |
Stop pipeline. | |
ob_config * | ob_pipeline_get_config (ob_pipeline *pipeline, ob_error **error) |
Get the configuration object associated with the pipeline. | |
ob_frame * | ob_pipeline_wait_for_frameset (ob_pipeline *pipeline, uint32_t timeout_ms, ob_error **error) |
Wait for a set of frames to be returned synchronously. | |
ob_device * | ob_pipeline_get_device (ob_pipeline *pipeline, ob_error **error) |
Get the device object associated with the pipeline. | |
ob_playback * | ob_pipeline_get_playback (ob_pipeline *pipeline, ob_error **error) |
Get the playback object associated with the pipeline. | |
ob_stream_profile_list * | ob_pipeline_get_stream_profile_list (ob_pipeline *pipeline, ob_sensor_type sensorType, ob_error **error) |
Get the stream profile list associated with the pipeline. | |
void | ob_pipeline_enable_frame_sync (ob_pipeline *pipeline, ob_error **error) |
Enable frame synchronization. | |
void | ob_pipeline_disable_frame_sync (ob_pipeline *pipeline, ob_error **error) |
Disable frame synchronization. | |
void | ob_pipeline_switch_config (ob_pipeline *pipeline, ob_config *config, ob_error **error) |
Dynamically switch the corresponding configuration. | |
ob_camera_param | ob_pipeline_get_camera_param_with_profile (ob_pipeline *pipeline, uint32_t colorWidth, uint32_t colorHeight, uint32_t depthWidth, uint32_t depthHeight, ob_error **error) |
Get the current camera parameters. | |
ob_camera_param | ob_pipeline_get_camera_param (ob_pipeline *pipeline, ob_error **error) |
Get current camera parameters. | |
ob_calibration_param | ob_pipeline_get_calibration_param (ob_pipeline *pipeline, ob_config *config, ob_error **error) |
Get device calibration parameters with the specified configuration. | |
ob_stream_profile_list * | ob_get_d2c_depth_profile_list (ob_pipeline *pipeline, ob_stream_profile *color_profile, ob_align_mode align_mode, ob_error **error) |
Return a list of D2C-enabled depth sensor resolutions corresponding to the input color sensor resolution. | |
ob_rect | ob_get_d2c_valid_area (ob_pipeline *pipeline, uint32_t distance, ob_error **error) |
Get the valid area after D2C (DEPRECATED) | |
ob_rect | ob_get_d2c_range_valid_area (ob_pipeline *pipeline, uint32_t minimum_distance, uint32_t maximum_distance, ob_error **error) |
Get the valid area between the minimum distance and maximum distance after D2C. | |
void | ob_pipeline_start_record (ob_pipeline *pipeline, const char *file_name, ob_error **error) |
Start recording. | |
void | ob_pipeline_stop_record (ob_pipeline *pipeline, ob_error **error) |
Stop recording. | |
ob_config * | ob_create_config (ob_error **error) |
Create the pipeline configuration. | |
void | ob_delete_config (ob_config *config, ob_error **error) |
Delete the pipeline configuration. | |
void | ob_config_enable_stream (ob_config *config, ob_stream_profile *profile, ob_error **error) |
Enable the specified stream in the pipeline configuration. | |
void | ob_config_enable_video_stream (ob_config *config, ob_stream_type type, int width, int height, int fps, ob_format format, ob_error **error) |
Enable a video stream to be used in the configuration. | |
void | ob_config_enable_accel_stream (ob_config *config, ob_accel_full_scale_range full_scale_range, ob_accel_sample_rate sample_rate, ob_error **error) |
Enable an accelerometer stream to be used in the configuration. | |
void | ob_config_enable_gyro_stream (ob_config *config, ob_gyro_full_scale_range full_scale_range, ob_gyro_sample_rate sample_rate, ob_error **error) |
Enable a gyroscope stream to be used in the configuration. | |
void | ob_config_enable_all_stream (ob_config *config, ob_error **error) |
Enable all streams in the pipeline configuration. | |
ob_stream_profile_list * | ob_config_get_enabled_stream_profile_list (ob_config *config, ob_error **error) |
Get the enabled stream profile list in the pipeline configuration. | |
void | ob_config_disable_stream (ob_config *config, ob_stream_type type, ob_error **error) |
Disable a specific stream in the pipeline configuration. | |
void | ob_config_disable_all_stream (ob_config *config, ob_error **error) |
Disable all streams in the pipeline configuration. | |
void | ob_config_set_align_mode (ob_config *config, ob_align_mode mode, ob_error **error) |
Set the alignment mode for the pipeline configuration. | |
void | ob_config_set_depth_scale_require (ob_config *config, bool enable, ob_error **error) |
Set whether depth scaling is required after setting D2C. | |
void | ob_config_set_d2c_target_resolution (ob_config *config, uint32_t d2c_target_width, uint32_t d2c_target_height, ob_error **error) |
Set the target resolution for D2C, which is applicable when the color stream is not enabled using the OrbbecSDK and the depth needs to be D2C Note: When using the OrbbecSDK to enable the color stream, this interface should also be used to set the D2C target resolution. The configuration of the enabled color stream is preferred for D2C. | |
void | ob_config_set_frame_aggregate_output_mode (ob_config *config, ob_frame_aggregate_output_mode mode, ob_error **error) |
Set the frame aggregation output mode for the pipeline configuration. | |
The SDK's advanced API can quickly implement functions such as switching streaming, frame synchronization, software filtering, etc., suitable for applications, and the algorithm focuses on rgbd data stream scenarios. If you are on real-time or need to handle synchronization separately, align the scene. Please use the interface of Device's Lower API.
+ +Definition in file Pipeline.h.
+ob_pipeline * ob_create_pipeline | +( | +ob_error ** | +error | ) | ++ |
Create a pipeline object.
+[out] | error | Log error messages |
ob_pipeline * ob_create_pipeline_with_device | +( | +ob_device * | +dev, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Using device objects to create pipeline objects.
+[in] | dev | Device object used to create pipeline |
[out] | error | Log error messages |
ob_pipeline * ob_create_pipeline_with_playback_file | +( | +const char * | +file_name, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Use the playback file to create a pipeline object.
+[in] | file_name | The playback file path used to create the pipeline |
[out] | error | Log error messages |
void ob_delete_pipeline | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete pipeline objects.
+[in] | pipeline | The pipeline object to be deleted |
[out] | error | Log error messages |
void ob_pipeline_start | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Start the pipeline with default parameters.
+[in] | pipeline | pipeline object |
[out] | error | Log error messages |
void ob_pipeline_start_with_config | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_config * | +config, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Start the pipeline with configuration parameters.
+[in] | pipeline | pipeline object |
[in] | config | Parameters to be configured |
[out] | error | Log error messages |
void ob_pipeline_start_with_callback | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_config * | +config, | +
+ | + | ob_frameset_callback | +callback, | +
+ | + | void * | +user_data, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Start the pipeline and set the frame collection data callback.
+[in] | pipeline | pipeline object |
[in] | config | Parameters to be configured |
[in] | callback | Trigger a callback when all frame data in the frameset arrives |
[in] | user_data | Pass in any user data and get it from the callback |
[out] | error | Log error messages |
void ob_pipeline_stop | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Stop pipeline.
+[in] | pipeline | pipeline object |
[out] | error | Log error messages |
ob_config * ob_pipeline_get_config | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the configuration object associated with the pipeline.
+Returns default configuration if the user has not configured
+[in] | pipeline | The pipeline object |
[out] | error | Log error messages |
ob_frame * ob_pipeline_wait_for_frameset | +( | +ob_pipeline * | +pipeline, | +
+ | + | uint32_t | +timeout_ms, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Wait for a set of frames to be returned synchronously.
+[in] | pipeline | The pipeline object |
[in] | timeout_ms | The timeout for waiting (in milliseconds) |
[out] | error | Log error messages |
ob_device * ob_pipeline_get_device | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the device object associated with the pipeline.
+[in] | pipeline | The pipeline object |
[out] | error | Log error messages |
ob_playback * ob_pipeline_get_playback | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the playback object associated with the pipeline.
+[in] | pipeline | The pipeline object |
[out] | error | Log error messages |
ob_stream_profile_list * ob_pipeline_get_stream_profile_list | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_sensor_type | +sensorType, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the stream profile list associated with the pipeline.
+[in] | pipeline | The pipeline object |
[in] | sensorType | The sensor type. The supported sensor types can be obtained through the ob_device_get_sensor_list() interface. |
[out] | error | Log error messages |
void ob_pipeline_enable_frame_sync | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Enable frame synchronization.
+[in] | pipeline | The pipeline object |
[out] | error | Log error messages |
void ob_pipeline_disable_frame_sync | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Disable frame synchronization.
+[in] | pipeline | The pipeline object |
[out] | error | Log error messages |
void ob_pipeline_switch_config | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_config * | +config, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Dynamically switch the corresponding configuration.
+[in] | pipeline | The pipeline object |
[in] | config | The pipeline configuration |
[out] | error | Log error messages |
ob_camera_param ob_pipeline_get_camera_param_with_profile | +( | +ob_pipeline * | +pipeline, | +
+ | + | uint32_t | +colorWidth, | +
+ | + | uint32_t | +colorHeight, | +
+ | + | uint32_t | +depthWidth, | +
+ | + | uint32_t | +depthHeight, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the current camera parameters.
+[in] | pipeline | pipeline object |
[in] | colorWidth | color width |
[in] | colorHeight | color height |
[in] | depthWidth | depth width |
[in] | depthHeight | depth height |
[out] | error | Log error messages |
ob_camera_param ob_pipeline_get_camera_param | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get current camera parameters.
+[in] | pipeline | pipeline object |
[out] | error | Log error messages |
ob_calibration_param ob_pipeline_get_calibration_param | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_config * | +config, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get device calibration parameters with the specified configuration.
+[in] | pipeline | pipeline object |
[in] | config | The pipeline configuration |
[out] | error | Log error messages |
ob_stream_profile_list * ob_get_d2c_depth_profile_list | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_stream_profile * | +color_profile, | +
+ | + | ob_align_mode | +align_mode, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Return a list of D2C-enabled depth sensor resolutions corresponding to the input color sensor resolution.
+[in] | pipeline | The pipeline object |
[in] | color_profile | The input profile of the color sensor |
[in] | align_mode | The input align mode |
[out] | error | Log error messages |
ob_rect ob_get_d2c_valid_area | +( | +ob_pipeline * | +pipeline, | +
+ | + | uint32_t | +distance, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the valid area after D2C (DEPRECATED)
+[in] | pipeline | The pipeline object |
[in] | distance | The working distance |
[out] | error | Log error messages |
ob_rect ob_get_d2c_range_valid_area | +( | +ob_pipeline * | +pipeline, | +
+ | + | uint32_t | +minimum_distance, | +
+ | + | uint32_t | +maximum_distance, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the valid area between the minimum distance and maximum distance after D2C.
+[in] | pipeline | The pipeline object |
[in] | minimum_distance | The minimum working distance |
[in] | maximum_distance | The maximum working distance |
[out] | error | Log error messages |
void ob_pipeline_start_record | +( | +ob_pipeline * | +pipeline, | +
+ | + | const char * | +file_name, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Start recording.
+[in] | pipeline | The pipeline object |
[in] | file_name | The recorded file path |
[out] | error | Log error messages |
void ob_pipeline_stop_record | +( | +ob_pipeline * | +pipeline, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Stop recording.
+[in] | pipeline | The pipeline object |
[out] | error | Log error messages |
Create the pipeline configuration.
+[out] | error | Log error messages |
void ob_delete_config | +( | +ob_config * | +config, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete the pipeline configuration.
+[in] | config | The configuration to be deleted |
[out] | error | Log error messages |
void ob_config_enable_stream | +( | +ob_config * | +config, | +
+ | + | ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Enable the specified stream in the pipeline configuration.
+[in] | config | The pipeline configuration |
[in] | profile | The stream configuration to be enabled |
[out] | error | Log error messages |
void ob_config_enable_video_stream | +( | +ob_config * | +config, | +
+ | + | ob_stream_type | +type, | +
+ | + | int | +width, | +
+ | + | int | +height, | +
+ | + | int | +fps, | +
+ | + | ob_format | +format, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Enable a video stream to be used in the configuration.
+This function configures and enables a video stream with specific parameters. Users must specify all parameters explicitly as C does not support default arguments. Refer to the product manual for details on supported resolutions and formats for different camera models.
+config | Pointer to the configuration structure. |
type | The video stream type. |
width | The video stream width. |
height | The video stream height. |
fps | The video stream frame rate. |
format | The video stream format. |
error | Pointer to store the error if operation fails. |
void ob_config_enable_accel_stream | +( | +ob_config * | +config, | +
+ | + | ob_accel_full_scale_range | +full_scale_range, | +
+ | + | ob_accel_sample_rate | +sample_rate, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Enable an accelerometer stream to be used in the configuration.
+This function configures and enables an accelerometer stream with specific parameters. Users must specify all parameters explicitly. For details on available full-scale ranges and sample rates, please refer to the product manual.
+config | Pointer to the configuration structure. |
fullScaleRange | The full-scale range of the accelerometer. |
sampleRate | The sample rate of the accelerometer. |
error | Pointer to store the error if operation fails. |
void ob_config_enable_gyro_stream | +( | +ob_config * | +config, | +
+ | + | ob_gyro_full_scale_range | +full_scale_range, | +
+ | + | ob_gyro_sample_rate | +sample_rate, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Enable a gyroscope stream to be used in the configuration.
+This function configures and enables a gyroscope stream with specific parameters. Users must specify all parameters explicitly. For details on available full-scale ranges and sample rates, please refer to the product manual.
+config | Pointer to the configuration structure. |
fullScaleRange | The full-scale range of the gyroscope. |
sampleRate | The sample rate of the gyroscope. |
error | Pointer to store the error if operation fails. |
void ob_config_enable_all_stream | +( | +ob_config * | +config, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Enable all streams in the pipeline configuration.
+[in] | config | The pipeline configuration |
[out] | error | Log error messages |
ob_stream_profile_list * ob_config_get_enabled_stream_profile_list | +( | +ob_config * | +config, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the enabled stream profile list in the pipeline configuration.
+config | The pipeline configuration |
error | Log error messages |
void ob_config_disable_stream | +( | +ob_config * | +config, | +
+ | + | ob_stream_type | +type, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Disable a specific stream in the pipeline configuration.
+[in] | config | The pipeline configuration |
[in] | type | The type of stream to be disabled |
[out] | error | Log error messages |
void ob_config_disable_all_stream | +( | +ob_config * | +config, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Disable all streams in the pipeline configuration.
+[in] | config | The pipeline configuration |
[out] | error | Log error messages |
void ob_config_set_align_mode | +( | +ob_config * | +config, | +
+ | + | ob_align_mode | +mode, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the alignment mode for the pipeline configuration.
+[in] | config | The pipeline configuration |
[in] | mode | The alignment mode to be set |
[out] | error | Log error messages |
void ob_config_set_depth_scale_require | +( | +ob_config * | +config, | +
+ | + | bool | +enable, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set whether depth scaling is required after setting D2C.
+[in] | config | The pipeline configuration |
[in] | enable | Whether scaling is required |
[out] | error | Log error messages |
void ob_config_set_d2c_target_resolution | +( | +ob_config * | +config, | +
+ | + | uint32_t | +d2c_target_width, | +
+ | + | uint32_t | +d2c_target_height, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the target resolution for D2C, which is applicable when the color stream is not enabled using the OrbbecSDK and the depth needs to be D2C Note: When using the OrbbecSDK to enable the color stream, this interface should also be used to set the D2C target resolution. The configuration of the enabled color stream is preferred for D2C.
+[in] | config | The pipeline configuration |
[in] | d2c_target_width | The target width for D2C |
[in] | d2c_target_height | The target height for D2C |
[out] | error | Log error messages |
void ob_config_set_frame_aggregate_output_mode | +( | +ob_config * | +config, | +
+ | + | ob_frame_aggregate_output_mode | +mode, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the frame aggregation output mode for the pipeline configuration.
+The processing strategy when the FrameSet generated by the frame aggregation function does not contain the frames of all opened streams (which can be caused by different frame rates of each stream, or by the loss of frames of one stream): drop directly or output to the user.
+[in] | config | The pipeline configuration |
[in] | mode | The frame aggregation output mode to be set (default mode is OB_FRAME_AGGREGATE_OUTPUT_FULL_FRAME_REQUIRE) |
[out] | error | Log error messages |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The SDK's advanced API type can quickly implement switching streaming and frame synchronization operations. +More...
+ +Go to the source code of this file.
++Classes | |
class | ob::Pipeline |
class | ob::Config |
Config class for configuring pipeline parameters. More... | |
+Namespaces | |
namespace | ob |
+Typedefs | |
typedef std::function< void(std::shared_ptr< FrameSet > frame)> | ob::FrameSetCallback |
The SDK's advanced API type can quickly implement switching streaming and frame synchronization operations.
+ +Definition in file Pipeline.hpp.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Control command property list maintenance. +More...
+#include "ObTypes.h"
Go to the source code of this file.
++Classes | |
struct | OBPropertyItem |
Used to describe the characteristics of each property. More... | |
+Typedefs | |
typedef enum OBPropertyID | ob_property_id |
typedef enum OBPropertyType | OBPropertyType |
The data type used to describe all property settings. | |
typedef enum OBPropertyType | ob_property_type |
typedef struct OBPropertyItem | OBPropertyItem |
Used to describe the characteristics of each property. | |
typedef struct OBPropertyItem | ob_property_item |
Control command property list maintenance.
+ +Definition in file Property.h.
+#define _OB_PROPERTY_H_ | +
Definition at line 13 of file Property.h.
+ +#define OB_PROP_TIMER_RESET_TRIGGLE_OUT_ENABLE_BOOL OB_PROP_TIMER_RESET_TRIGGER_OUT_ENABLE_BOOL | +
Definition at line 737 of file Property.h.
+ +#define OB_PROP_LASER_ON_OFF_MODE_INT OB_PROP_LASER_ON_OFF_PATTERN_INT | +
Definition at line 738 of file Property.h.
+ +#define OB_PROP_LASER_ENERGY_LEVEL_INT OB_PROP_LASER_POWER_LEVEL_CONTROL_INT | +
Definition at line 739 of file Property.h.
+ +#define OB_PROP_LASER_HW_ENERGY_LEVEL_INT OB_PROP_LASER_POWER_ACTUAL_LEVEL_INT | +
Definition at line 740 of file Property.h.
+ +#define OB_PROP_DEVICE_USB3_REPEAT_IDENTIFY_BOOL OB_PROP_DEVICE_USB2_REPEAT_IDENTIFY_BOOL | +
Definition at line 741 of file Property.h.
+ +typedef enum OBPropertyID ob_property_id | +
typedef enum OBPropertyType OBPropertyType | +
The data type used to describe all property settings.
+ +typedef enum OBPropertyType ob_property_type | +
typedef struct OBPropertyItem OBPropertyItem | +
Used to describe the characteristics of each property.
+ +typedef struct OBPropertyItem ob_property_item | +
enum OBPropertyID | +
Enumeration value describing all attribute control commands of the device.
+Enumerator | |
---|---|
OB_PROP_LDP_BOOL | LDP switch. + |
OB_PROP_LASER_BOOL | Laser switch. + |
OB_PROP_LASER_PULSE_WIDTH_INT | laser pulse width + |
OB_PROP_LASER_CURRENT_FLOAT | Laser current (uint: mA) + |
OB_PROP_FLOOD_BOOL | IR flood switch. + |
OB_PROP_FLOOD_LEVEL_INT | IR flood level. + |
OB_PROP_DEPTH_MIRROR_BOOL | Depth mirror. + |
OB_PROP_DEPTH_FLIP_BOOL | Depth flip. + |
OB_PROP_DEPTH_POSTFILTER_BOOL | Depth Postfilter. + |
OB_PROP_DEPTH_HOLEFILTER_BOOL | Depth Holefilter. + |
OB_PROP_IR_MIRROR_BOOL | IR mirror. + |
OB_PROP_IR_FLIP_BOOL | IR flip. + |
OB_PROP_MIN_DEPTH_INT | Minimum depth threshold. + |
OB_PROP_MAX_DEPTH_INT | Maximum depth threshold. + |
OB_PROP_DEPTH_SOFT_FILTER_BOOL | Software filter switch. + |
OB_PROP_LDP_STATUS_BOOL | LDP status. + |
OB_PROP_DEPTH_MAX_DIFF_INT | soft filter maxdiff param + |
OB_PROP_DEPTH_MAX_SPECKLE_SIZE_INT | soft filter maxSpeckleSize + |
OB_PROP_DEPTH_ALIGN_HARDWARE_BOOL | Hardware d2c is on. + |
OB_PROP_TIMESTAMP_OFFSET_INT | Timestamp adjustment. + |
OB_PROP_HARDWARE_DISTORTION_SWITCH_BOOL | Hardware distortion switch Rectify. + |
OB_PROP_FAN_WORK_MODE_INT | Fan mode switch. + |
OB_PROP_DEPTH_ALIGN_HARDWARE_MODE_INT | Multi-resolution D2C mode. + |
OB_PROP_ANTI_COLLUSION_ACTIVATION_STATUS_BOOL | Anti_collusion activation status. + |
OB_PROP_DEPTH_PRECISION_LEVEL_INT | the depth precision level, which may change the depth frame data unit, needs to be confirmed through the ValueScale interface of DepthFrame + |
OB_PROP_TOF_FILTER_RANGE_INT | tof filter range configuration + |
OB_PROP_LASER_MODE_INT | laser mode, the firmware terminal currently only return 1: IR Drive, 2: Torch + |
OB_PROP_RECTIFY2_BOOL | brt2r-rectify function switch (brt2r is a special module on mx6600), 0: Disable, 1: Rectify Enable + |
OB_PROP_COLOR_MIRROR_BOOL | Color mirror. + |
OB_PROP_COLOR_FLIP_BOOL | Color flip. + |
OB_PROP_INDICATOR_LIGHT_BOOL | Indicator switch, 0: Disable, 1: Enable. + |
OB_PROP_DISPARITY_TO_DEPTH_BOOL | Disparity to depth switch, false: switch to software disparity convert to depth, true: switch to hardware disparity convert to depth. + |
OB_PROP_BRT_BOOL | BRT function switch (anti-background interference), 0: Disable, 1: Enable. + |
OB_PROP_WATCHDOG_BOOL | Watchdog function switch, 0: Disable, 1: Enable. + |
OB_PROP_EXTERNAL_SIGNAL_RESET_BOOL | External signal trigger restart function switch, 0: Disable, 1: Enable. + |
OB_PROP_HEARTBEAT_BOOL | Heartbeat monitoring function switch, 0: Disable, 1: Enable. + |
OB_PROP_DEPTH_CROPPING_MODE_INT | Depth cropping mode device: OB_DEPTH_CROPPING_MODE. + |
OB_PROP_D2C_PREPROCESS_BOOL | D2C preprocessing switch (such as RGB cropping), 0: off, 1: on. + |
OB_PROP_RGB_CUSTOM_CROP_BOOL | Custom RGB cropping switch, 0 is off, 1 is on custom cropping, and the ROI cropping area is issued. + |
OB_PROP_DEVICE_WORK_MODE_INT | Device operating mode (power consumption) + |
OB_PROP_DEVICE_COMMUNICATION_TYPE_INT | Device communication type, 0: USB; 1: Ethernet(RTSP) + |
OB_PROP_SWITCH_IR_MODE_INT | Switch infrared imaging mode, 0: active IR mode, 1: passive IR mode. + |
OB_PROP_LASER_POWER_LEVEL_CONTROL_INT | Laser power level. + |
OB_PROP_LDP_MEASURE_DISTANCE_INT | LDP's measure distance, unit: mm. + |
OB_PROP_TIMER_RESET_SIGNAL_BOOL | Reset device time to zero. + |
OB_PROP_TIMER_RESET_TRIGGER_OUT_ENABLE_BOOL | Enable send reset device time signal to other device. true: enable, false: disable. + |
OB_PROP_TIMER_RESET_DELAY_US_INT | Delay to reset device time, unit: us. + |
OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL | Signal to capture image. + |
OB_PROP_IR_RIGHT_MIRROR_BOOL | Right IR sensor mirror state. + |
OB_PROP_CAPTURE_IMAGE_FRAME_NUMBER_INT | Number frame to capture once a 'OB_PROP_CAPTURE_IMAGE_SIGNAL_BOOL' effect. range: [1, 255]. + |
OB_PROP_IR_RIGHT_FLIP_BOOL | Right IR sensor flip state. true: flip image, false: origin, default: false. + |
OB_PROP_COLOR_ROTATE_INT | Color sensor rotation, angle{0, 90, 180, 270}. + |
OB_PROP_IR_ROTATE_INT | IR/Left-IR sensor rotation, angle{0, 90, 180, 270}. + |
OB_PROP_IR_RIGHT_ROTATE_INT | Right IR sensor rotation, angle{0, 90, 180, 270}. + |
OB_PROP_DEPTH_ROTATE_INT | Depth sensor rotation, angle{0, 90, 180, 270}. + |
OB_PROP_LASER_POWER_ACTUAL_LEVEL_INT | Get hardware laser power actual level which real state of laser element. OB_PROP_LASER_POWER_LEVEL_CONTROL_INT99)will effect this command which it setting and changed the hardware laser energy level. + |
OB_PROP_USB_POWER_STATE_INT | USB's power state, enum type: OBUSBPowerState. + |
OB_PROP_DC_POWER_STATE_INT | DC's power state, enum type: OBDCPowerState. + |
OB_PROP_DEVICE_DEVELOPMENT_MODE_INT | Device development mode switch, optional modes can refer to the definition in OBDeviceDevelopmentMode,the default mode is OB_USER_MODE. +
|
OB_PROP_SYNC_SIGNAL_TRIGGER_OUT_BOOL | Multi-DeviceSync synchronized signal trigger out is enable state. true: enable, false: disable. + |
OB_PROP_RESTORE_FACTORY_SETTINGS_BOOL | Restore factory settings and factory parameters. +
|
OB_PROP_BOOT_INTO_RECOVERY_MODE_BOOL | Enter recovery mode (flashing mode) when boot the device. +
|
OB_PROP_DEVICE_IN_RECOVERY_MODE_BOOL | Query whether the current device is running in recovery mode (read-only) + |
OB_PROP_CAPTURE_INTERVAL_MODE_INT | Capture interval mode, 0:time interval, 1:number interval. + |
OB_PROP_CAPTURE_IMAGE_TIME_INTERVAL_INT | Capture time interval. + |
OB_PROP_CAPTURE_IMAGE_NUMBER_INTERVAL_INT | Capture number interval. + |
OB_PROP_TIMER_RESET_ENABLE_BOOL | |
OB_PROP_DEVICE_USB2_REPEAT_IDENTIFY_BOOL | Enable or disable the device to retry USB2.0 re-identification when the device is connected to a USB2.0 port. +This feature ensures that the device is not mistakenly identified as a USB 2.0 device when connected to a USB 3.0 port. + |
OB_PROP_DEVICE_REBOOT_DELAY_INT | Reboot device delay mode. Delay time unit: ms, range: [0, 8000). + |
OB_PROP_LASER_OVERCURRENT_PROTECTION_STATUS_BOOL | Query the status of laser overcurrent protection (read-only) + |
OB_PROP_LASER_PULSE_WIDTH_PROTECTION_STATUS_BOOL | Query the status of laser pulse width protection (read-only) + |
OB_PROP_DEPTH_NOISE_REMOVAL_FILTER_BOOL | depth noise removal filter + |
OB_PROP_LASER_ALWAYS_ON_BOOL | Laser always on, true: always on, false: off, laser will be turned off when out of exposure time. + |
OB_PROP_LASER_ON_OFF_PATTERN_INT | Laser on/off alternate mode, 0: off, 1: on-off alternate, 2: off-on alternate. +
|
OB_PROP_DEPTH_UNIT_FLEXIBLE_ADJUSTMENT_FLOAT | Depth unit flexible adjustment. +This property allows continuous adjustment of the depth unit, unlike OB_PROP_DEPTH_PRECISION_LEVEL_INT must be set to some fixed value. + |
OB_PROP_LASER_CONTROL_INT | Laser control, 0: off, 1: on, 2: auto. + |
OB_PROP_IR_BRIGHTNESS_INT | IR brightness. + |
OB_PROP_SLAVE_DEVICE_SYNC_STATUS_BOOL | slave device sync status + |
OB_PROP_COLOR_AE_MAX_EXPOSURE_INT | Color AE max exposure. + |
OB_PROP_IR_AE_MAX_EXPOSURE_INT | IR AE max exposure. + |
OB_PROP_DISP_SEARCH_RANGE_MODE_INT | disparity search range mode + |
OB_PROP_CPU_TEMPERATURE_CALIBRATION_BOOL | cpu temperature correction . true: calibrate temperature + |
OB_STRUCT_BASELINE_CALIBRATION_PARAM | Baseline calibration parameters. + |
OB_STRUCT_DEVICE_TEMPERATURE | Device temperature information. + |
OB_STRUCT_TOF_EXPOSURE_THRESHOLD_CONTROL | TOF exposure threshold range. + |
OB_STRUCT_DEVICE_SERIAL_NUMBER | get/set serial number + |
OB_STRUCT_DEVICE_TIME | get/set device time + |
OB_STRUCT_MULTI_DEVICE_SYNC_CONFIG | Multi-device synchronization mode and parameter configuration. + |
OB_STRUCT_RGB_CROP_ROI | RGB cropping ROI. + |
OB_STRUCT_DEVICE_IP_ADDR_CONFIG | Device IP address configuration. + |
OB_STRUCT_CURRENT_DEPTH_ALG_MODE | The current camera depth mode. + |
OB_STRUCT_DEPTH_PRECISION_SUPPORT_LIST | A list of depth accuracy levels, returning an array of uin16_t, corresponding to the enumeration. + |
OB_STRUCT_DEVICE_STATIC_IP_CONFIG_RECORD | Device network static ip config record. +Using for get last static ip config,witch is record in device flash when user set static ip config +
|
OB_STRUCT_DEPTH_HDR_CONFIG | Using to configure the depth sensor's HDR mode. +The Value type is OBHdrConfig +
|
OB_STRUCT_COLOR_AE_ROI | Color Sensor AE ROI configuration. +The Value type is OBRegionOfInterest + |
OB_STRUCT_DEPTH_AE_ROI | Depth Sensor AE ROI configuration. +The Value type is OBRegionOfInterest +Since the ir sensor is the same physical sensor as the depth sensor, this property will also effect the ir sensor. + |
OB_STRUCT_ASIC_SERIAL_NUMBER | ASIC serial number. + |
OB_PROP_COLOR_AUTO_EXPOSURE_BOOL | Color camera auto exposure. + |
OB_PROP_COLOR_EXPOSURE_INT | Color camera exposure adjustment. + |
OB_PROP_COLOR_GAIN_INT | Color camera gain adjustment. + |
OB_PROP_COLOR_AUTO_WHITE_BALANCE_BOOL | Color camera automatic white balance. + |
OB_PROP_COLOR_WHITE_BALANCE_INT | Color camera white balance adjustment. + |
OB_PROP_COLOR_BRIGHTNESS_INT | Color camera brightness adjustment. + |
OB_PROP_COLOR_SHARPNESS_INT | Color camera sharpness adjustment. + |
OB_PROP_COLOR_SHUTTER_INT | Color camera shutter adjustment. + |
OB_PROP_COLOR_SATURATION_INT | Color camera saturation adjustment. + |
OB_PROP_COLOR_CONTRAST_INT | Color camera contrast adjustment. + |
OB_PROP_COLOR_GAMMA_INT | Color camera gamma adjustment. + |
OB_PROP_COLOR_ROLL_INT | Color camera image rotation. + |
OB_PROP_COLOR_AUTO_EXPOSURE_PRIORITY_INT | Color camera auto exposure priority. + |
OB_PROP_COLOR_BACKLIGHT_COMPENSATION_INT | Color camera brightness compensation. + |
OB_PROP_COLOR_HUE_INT | Color camera color tint. + |
OB_PROP_COLOR_POWER_LINE_FREQUENCY_INT | Color Camera Power Line Frequency. + |
OB_PROP_DEPTH_AUTO_EXPOSURE_BOOL | Automatic exposure of depth camera (infrared camera will be set synchronously under some models of devices) + |
OB_PROP_DEPTH_EXPOSURE_INT | Depth camera exposure adjustment (infrared cameras will be set synchronously under some models of devices) + |
OB_PROP_DEPTH_GAIN_INT | Depth camera gain adjustment (infrared cameras will be set synchronously under some models of devices) + |
OB_PROP_IR_AUTO_EXPOSURE_BOOL | Infrared camera auto exposure (depth camera will be set synchronously under some models of devices) + |
OB_PROP_IR_EXPOSURE_INT | Infrared camera exposure adjustment (some models of devices will set the depth camera synchronously) + |
OB_PROP_IR_GAIN_INT | Infrared camera gain adjustment (the depth camera will be set synchronously under some models of devices) + |
OB_PROP_IR_CHANNEL_DATA_SOURCE_INT | Select Infrared camera data source channel. If not support throw exception. 0 : IR stream from IR Left sensor; 1 : IR stream from IR Right sensor;. + |
OB_PROP_DEPTH_RM_FILTER_BOOL | Depth effect dedistortion, true: on, false: off. mutually exclusive with D2C function, RM_Filter disable When hardware or software D2C is enabled. + |
OB_PROP_COLOR_MAXIMAL_GAIN_INT | Color camera maximal gain. + |
OB_PROP_COLOR_MAXIMAL_SHUTTER_INT | Color camera shutter gain. + |
OB_PROP_IR_SHORT_EXPOSURE_BOOL | The enable/disable switch for IR short exposure function, supported only by a few devices. + |
OB_PROP_COLOR_HDR_BOOL | Color camera HDR. + |
OB_PROP_IR_LONG_EXPOSURE_BOOL | IR long exposure mode switch read and write. + |
OB_PROP_SKIP_FRAME_BOOL | Setting and getting the USB device frame skipping mode status, true: frame skipping mode, false: non-frame skipping mode. + |
OB_PROP_HDR_MERGE_BOOL | Depth HDR merge, true: on, false: off. + |
OB_PROP_COLOR_FOCUS_INT | Color camera FOCUS. + |
OB_PROP_SDK_DISPARITY_TO_DEPTH_BOOL | Software disparity to depth. + |
OB_PROP_SDK_DEPTH_FRAME_UNPACK_BOOL | Depth data unpacking function switch (each open stream will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) + |
OB_PROP_SDK_IR_FRAME_UNPACK_BOOL | IR data unpacking function switch (each current will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) + |
OB_PROP_SDK_ACCEL_FRAME_TRANSFORMED_BOOL | Accel data conversion function switch (on by default) + |
OB_PROP_SDK_GYRO_FRAME_TRANSFORMED_BOOL | Gyro data conversion function switch (on by default) + |
OB_PROP_SDK_IR_LEFT_FRAME_UNPACK_BOOL | Left IR frame data unpacking function switch (each current will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) + |
OB_PROP_SDK_IR_RIGHT_FRAME_UNPACK_BOOL | Right IR frame data unpacking function switch (each current will be turned on by default, support RLE/Y10/Y11/Y12/Y14 format) + |
OB_PROP_SDK_DEPTH_RECTIFY_MG_FILTER_BOOL | depth Margin Filter + |
OB_RAW_DATA_CAMERA_CALIB_JSON_FILE | Calibration JSON file read from device (Femto Mega, read only) + |
Definition at line 24 of file Property.h.
+ +enum OBPropertyType | +
The data type used to describe all property settings.
+Enumerator | |
---|---|
OB_BOOL_PROPERTY | Boolean property + |
OB_INT_PROPERTY | Integer property + |
OB_FLOAT_PROPERTY | Floating-point property + |
OB_STRUCT_PROPERTY | Struct property + |
Definition at line 746 of file Property.h.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Header file for recording and playback functions. +More...
+#include "ObTypes.h"
Go to the source code of this file.
++Functions | |
ob_recorder * | ob_create_recorder (ob_error **error) |
Create a recorder for data recording. | |
ob_recorder * | ob_create_recorder_with_device (ob_device *dev, ob_error **error) |
Create a recorder for data recording. | |
void | ob_delete_recorder (ob_recorder *recorder, ob_error **error) |
Delete the recorder object. | |
void | ob_recorder_start (ob_recorder *recorder, const char *filename, bool async, ob_error **error) |
Start recording. | |
void | ob_recorder_stop (ob_recorder *recorder, ob_error **error) |
Stop recording. | |
void | ob_recorder_write_frame (ob_recorder *recorder, ob_frame *frame, ob_error **error) |
Write frame data to the recorder. | |
ob_playback * | ob_create_playback (const char *filename, ob_error **error) |
Create a playback object. | |
void | ob_delete_playback (ob_playback *playback, ob_error **error) |
Delete the playback object. | |
void | ob_playback_start (ob_playback *playback, ob_playback_callback callback, void *user_data, ob_media_type type, ob_error **error) |
Start playback, with data returned from the callback. | |
void | ob_playback_stop (ob_playback *playback, ob_error **error) |
Stop playback. | |
void | ob_set_playback_state_callback (ob_playback *playback, ob_media_state_callback callback, void *user_data, ob_error **error) |
Set the playback state. | |
ob_device_info * | ob_playback_get_device_info (ob_playback *playback, ob_error **error) |
Get the device information in the recording file. | |
ob_camera_param | ob_playback_get_camera_param (ob_playback *playback, ob_error **error) |
Get the intrinsic and extrinsic parameter information in the recording file. | |
Header file for recording and playback functions.
+ +Definition in file RecordPlayback.h.
+ob_recorder * ob_create_recorder | +( | +ob_error ** | +error | ) | ++ |
Create a recorder for data recording.
+[out] | error | Pointer to log error messages. |
ob_recorder * ob_create_recorder_with_device | +( | +ob_device * | +dev, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Create a recorder for data recording.
+dev | The device object used to create the recorder. | |
[out] | error | Pointer to log error messages. |
void ob_delete_recorder | +( | +ob_recorder * | +recorder, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete the recorder object.
+recorder | Pointer to the recorder object. | |
[out] | error | Pointer to log error messages. |
void ob_recorder_start | +( | +ob_recorder * | +recorder, | +
+ | + | const char * | +filename, | +
+ | + | bool | +async, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Start recording.
+[in] | recorder | Pointer to the recorder object. |
[in] | filename | Recorded file name. |
[in] | async | Whether to record asynchronously. |
[out] | error | Pointer to log error messages. |
void ob_recorder_stop | +( | +ob_recorder * | +recorder, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Stop recording.
+[in] | recorder | Pointer to the recorder object. |
[out] | error | Pointer to log error messages. |
void ob_recorder_write_frame | +( | +ob_recorder * | +recorder, | +
+ | + | ob_frame * | +frame, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Write frame data to the recorder.
+[in] | recorder | Pointer to the recorder object. |
[in] | frame | Pointer to the frame data to write. |
[out] | error | Pointer to log error messages. |
ob_playback * ob_create_playback | +( | +const char * | +filename, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Create a playback object.
+[in] | filename | Playback filename. |
[out] | error | Pointer to log error messages. |
void ob_delete_playback | +( | +ob_playback * | +playback, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete the playback object.
+[in] | playback | Pointer to the playback object. |
[out] | error | Pointer to log error messages. |
void ob_playback_start | +( | +ob_playback * | +playback, | +
+ | + | ob_playback_callback | +callback, | +
+ | + | void * | +user_data, | +
+ | + | ob_media_type | +type, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Start playback, with data returned from the callback.
+[in] | playback | Pointer to the playback object. |
[in] | callback | Callback function for playback data. |
[in] | user_data | User data. |
[in] | type | Type of playback data. |
[out] | error | Pointer to log error messages. |
void ob_playback_stop | +( | +ob_playback * | +playback, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Stop playback.
+[in] | playback | Pointer to the playback object. |
[out] | error | Pointer to log error messages. |
void ob_set_playback_state_callback | +( | +ob_playback * | +playback, | +
+ | + | ob_media_state_callback | +callback, | +
+ | + | void * | +user_data, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Set the playback state.
+[in] | playback | Pointer to the playback object. |
[in] | callback | Playback status callback function. |
[in] | user_data | User data. |
[out] | error | Pointer to log error messages. |
ob_device_info * ob_playback_get_device_info | +( | +ob_playback * | +playback, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the device information in the recording file.
+[in] | playback | Pointer to the playback object. |
[out] | error | Pointer to log error messages. |
ob_camera_param ob_playback_get_camera_param | +( | +ob_playback * | +playback, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the intrinsic and extrinsic parameter information in the recording file.
+[in] | playback | Pointer to the playback object. |
[out] | error | Pointer to log error messages. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Header file for recording and playback functions. +More...
+ +Go to the source code of this file.
++Classes | |
class | ob::Recorder |
class | ob::Playback |
+Namespaces | |
namespace | ob |
+Typedefs | |
using | ob::PlaybackCallback = std::function< void(std::shared_ptr< Frame > frame)> |
using | ob::MediaStateCallback = std::function< void(OBMediaState state)> |
Header file for recording and playback functions.
+ +Definition in file RecordPlayback.hpp.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Defines types related to sensors, used for obtaining stream configurations, opening and closing streams, and setting and getting sensor properties. +More...
+#include "ObTypes.h"
Go to the source code of this file.
++Functions | |
ob_sensor_type | ob_sensor_get_type (ob_sensor *sensor, ob_error **error) |
Get the type of the sensor. | |
ob_stream_profile_list * | ob_sensor_get_stream_profile_list (ob_sensor *sensor, ob_error **error) |
Get a list of all supported stream profiles. | |
ob_filter_list * | ob_sensor_get_recommended_filter_list (ob_sensor *sensor, ob_error **error) |
Request the list of recommended filter list. | |
uint32_t | ob_filter_list_get_count (ob_filter_list *filter_list, ob_error **error) |
Get the number of recommended filter list. | |
ob_filter * | ob_get_filter (ob_filter_list *filter_list, uint32_t index, ob_error **error) |
Get the number of recommended filter list. | |
const char * | ob_get_filter_name (ob_filter *filter, ob_error **error) |
Get the name of ob_filter. | |
void | ob_delete_filter_list (ob_filter_list *filter_list, ob_error **error) |
Delete a list of ob_filter objects. | |
void | ob_sensor_start (ob_sensor *sensor, ob_stream_profile *profile, ob_frame_callback callback, void *user_data, ob_error **error) |
Open the current sensor and set the callback data frame. | |
void | ob_sensor_stop (ob_sensor *sensor, ob_error **error) |
Stop the sensor stream. | |
void | ob_sensor_switch_profile (ob_sensor *sensor, ob_stream_profile *profile, ob_error **error) |
Dynamically switch resolutions. | |
void | ob_delete_sensor_list (ob_sensor_list *sensor_list, ob_error **error) |
Delete a list of sensor objects. | |
uint32_t | ob_sensor_list_get_sensor_count (ob_sensor_list *sensor_list, ob_error **error) |
Get the number of sensors in the sensor list. | |
ob_sensor_type | ob_sensor_list_get_sensor_type (ob_sensor_list *sensor_list, uint32_t index, ob_error **error) |
Get the sensor type. | |
ob_sensor * | ob_sensor_list_get_sensor_by_type (ob_sensor_list *sensor_list, ob_sensor_type sensorType, ob_error **error) |
Get a sensor by sensor type. | |
ob_sensor * | ob_sensor_list_get_sensor (ob_sensor_list *sensor_list, uint32_t index, ob_error **error) |
Get a sensor by index number. | |
void | ob_delete_sensor (ob_sensor *sensor, ob_error **error) |
Delete a sensor object. | |
Defines types related to sensors, used for obtaining stream configurations, opening and closing streams, and setting and getting sensor properties.
+ +Definition in file Sensor.h.
+ob_sensor_type ob_sensor_get_type | +( | +ob_sensor * | +sensor, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the type of the sensor.
+[in] | sensor | The sensor object. |
[out] | error | Logs error messages. |
ob_stream_profile_list * ob_sensor_get_stream_profile_list | +( | +ob_sensor * | +sensor, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get a list of all supported stream profiles.
+[in] | sensor | The sensor object. |
[out] | error | Logs error messages. |
ob_filter_list * ob_sensor_get_recommended_filter_list | +( | +ob_sensor * | +sensor, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Request the list of recommended filter list.
+[in] | sensor | The ob_sensor object. |
[out] | error | Log error messages. |
uint32_t ob_filter_list_get_count | +( | +ob_filter_list * | +filter_list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the number of recommended filter list.
+filter_list | Recommended filter list |
error | Log error messages |
ob_filter * ob_get_filter | +( | +ob_filter_list * | +filter_list, | +
+ | + | uint32_t | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the number of recommended filter list.
+filter_list | Recommended filter list |
index | Recommended filter index |
error | Log error messages |
const char * ob_get_filter_name | +( | +ob_filter * | +filter, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the name of ob_filter.
+filter | ob_filter object |
error | Log error messages |
void ob_delete_filter_list | +( | +ob_filter_list * | +filter_list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete a list of ob_filter objects.
+[in] | filter_list | The list of ob_filter objects to delete. |
[out] | error | Logs error messages. |
void ob_sensor_start | +( | +ob_sensor * | +sensor, | +
+ | + | ob_stream_profile * | +profile, | +
+ | + | ob_frame_callback | +callback, | +
+ | + | void * | +user_data, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Open the current sensor and set the callback data frame.
+[in] | sensor | The sensor object. |
[in] | profile | The stream configuration information. |
[in] | callback | The callback function triggered when frame data arrives. |
[in] | user_data | Any user data to pass in and get from the callback. |
[out] | error | Logs error messages. |
void ob_sensor_stop | +( | +ob_sensor * | +sensor, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Stop the sensor stream.
+[in] | sensor | The sensor object. |
[out] | error | Logs error messages. |
void ob_sensor_switch_profile | +( | +ob_sensor * | +sensor, | +
+ | + | ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Dynamically switch resolutions.
+[in] | sensor | The sensor object. |
[in] | profile | The stream configuration information. |
[out] | error | Logs error messages. |
void ob_delete_sensor_list | +( | +ob_sensor_list * | +sensor_list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete a list of sensor objects.
+[in] | sensor_list | The list of sensor objects to delete. |
[out] | error | Logs error messages. |
uint32_t ob_sensor_list_get_sensor_count | +( | +ob_sensor_list * | +sensor_list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the number of sensors in the sensor list.
+[in] | sensor_list | The list of sensor objects. |
[out] | error | Logs error messages. |
ob_sensor_type ob_sensor_list_get_sensor_type | +( | +ob_sensor_list * | +sensor_list, | +
+ | + | uint32_t | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the sensor type.
+[in] | sensor_list | The list of sensor objects. |
[in] | index | The index of the sensor on the list. |
[out] | error | Logs error messages. |
ob_sensor * ob_sensor_list_get_sensor_by_type | +( | +ob_sensor_list * | +sensor_list, | +
+ | + | ob_sensor_type | +sensorType, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get a sensor by sensor type.
+[in] | sensor_list | The list of sensor objects. |
[in] | sensorType | The sensor type to be obtained. |
[out] | error | Logs error messages. |
ob_sensor * ob_sensor_list_get_sensor | +( | +ob_sensor_list * | +sensor_list, | +
+ | + | uint32_t | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get a sensor by index number.
+[in] | sensor_list | The list of sensor objects. |
[in] | index | The index of the sensor on the list. |
[out] | error | Logs error messages. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Defines types related to sensors, which are used to obtain stream configurations, open and close streams, and set and get sensor properties. +More...
+#include "Types.hpp"
#include "libobsensor/hpp/Filter.hpp"
#include <functional>
#include <memory>
Go to the source code of this file.
++Classes | |
class | ob::Sensor |
class | ob::SensorList |
class | ob::OBFilterList |
Class representing a list of FrameProcessingBlock. More... | |
+Namespaces | |
namespace | ob |
+Typedefs | |
using | ob::FrameCallback = std::function< void(std::shared_ptr< Frame > frame)> |
Callback function for frame data. | |
Defines types related to sensors, which are used to obtain stream configurations, open and close streams, and set and get sensor properties.
+ +Definition in file Sensor.hpp.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The stream profile related type is used to get information such as the width, height, frame rate, and format of the stream. +More...
+#include "ObTypes.h"
Go to the source code of this file.
++Functions | |
ob_format | ob_stream_profile_format (ob_stream_profile *profile, ob_error **error) |
Get stream profile format. | |
ob_stream_type | ob_stream_profile_type (ob_stream_profile *profile, ob_error **error) |
Get stream profile type. | |
ob_extrinsic | ob_stream_profile_get_extrinsic_to (ob_stream_profile *source, ob_stream_profile *target, ob_error **error) |
Get the extrinsic for source stream to target stream. | |
uint32_t | ob_video_stream_profile_fps (ob_stream_profile *profile, ob_error **error) |
Get the frame rate of the video stream. | |
uint32_t | ob_video_stream_profile_width (ob_stream_profile *profile, ob_error **error) |
Get the width of the video stream. | |
uint32_t | ob_video_stream_profile_height (ob_stream_profile *profile, ob_error **error) |
Get the height of the video stream. | |
ob_camera_intrinsic | ob_video_stream_get_intrinsic (ob_stream_profile *profile, ob_error **error) |
Get the intrinsic of the video stream. | |
ob_camera_distortion | ob_video_stream_get_distortion (ob_stream_profile *profile, ob_error **error) |
Get the distortion of the video stream. | |
ob_accel_full_scale_range | ob_accel_stream_profile_full_scale_range (ob_stream_profile *profile, ob_error **error) |
Get the full-scale range of the accelerometer stream. | |
ob_accel_sample_rate | ob_accel_stream_profile_sample_rate (ob_stream_profile *profile, ob_error **error) |
Get the sampling frequency of the accelerometer frame. | |
ob_accel_intrinsic | ob_accel_stream_profile_get_intrinsic (ob_stream_profile *profile, ob_error **error) |
Get the intrinsic of the accelerometer stream. | |
ob_gyro_full_scale_range | ob_gyro_stream_profile_full_scale_range (ob_stream_profile *profile, ob_error **error) |
Get the full-scale range of the gyroscope stream. | |
ob_gyro_intrinsic | ob_gyro_stream_get_intrinsic (ob_stream_profile *profile, ob_error **error) |
Get the intrinsic of the gyroscope stream. | |
ob_gyro_sample_rate | ob_gyro_stream_profile_sample_rate (ob_stream_profile *profile, ob_error **error) |
Get the sampling frequency of the gyroscope stream. | |
ob_stream_profile * | ob_stream_profile_list_get_video_stream_profile (ob_stream_profile_list *profile_list, int width, int height, ob_format format, int fps, ob_error **error) |
Match the corresponding ob_stream_profile through the passed parameters. If there are multiple matches, the first one in the list will be returned by default. If no matched profile is found, an error will be returned. | |
ob_stream_profile * | ob_stream_profile_list_get_accel_stream_profile (ob_stream_profile_list *profile_list, ob_accel_full_scale_range fullScaleRange, ob_accel_sample_rate sampleRate, ob_error **error) |
Match the corresponding ob_stream_profile through the passed parameters. If there are multiple matches, the first one in the list will be returned by default. If no matched profile is found, an error will be returned. | |
ob_stream_profile * | ob_stream_profile_list_get_gyro_stream_profile (ob_stream_profile_list *profile_list, ob_gyro_full_scale_range fullScaleRange, ob_gyro_sample_rate sampleRate, ob_error **error) |
Match the corresponding ob_stream_profile through the passed parameters. If there are multiple matches, the first one in the list will be returned by default. If no matched profile is found, an error will be returned. | |
ob_stream_profile * | ob_stream_profile_list_get_profile (ob_stream_profile_list *profile_list, int index, ob_error **error) |
Get the corresponding StreamProfile by subscripting. | |
uint32_t | ob_stream_profile_list_count (ob_stream_profile_list *profile_list, ob_error **error) |
Get the number of StreamProfile lists. | |
void | ob_delete_stream_profile_list (ob_stream_profile_list *profile_list, ob_error **error) |
Delete the stream profile list. | |
void | ob_delete_stream_profile (ob_stream_profile *profile, ob_error **error) |
Delete the stream configuration. | |
The stream profile related type is used to get information such as the width, height, frame rate, and format of the stream.
+ +Definition in file StreamProfile.h.
+ob_format ob_stream_profile_format | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get stream profile format.
+[in] | profile | Stream profile object |
[out] | error | Log error messages |
ob_stream_type ob_stream_profile_type | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get stream profile type.
+[in] | profile | Stream profile object |
[out] | error | Log error messages |
ob_extrinsic ob_stream_profile_get_extrinsic_to | +( | +ob_stream_profile * | +source, | +
+ | + | ob_stream_profile * | +target, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the extrinsic for source stream to target stream.
+source | Source stream profile |
target | Target stream profile |
error | Log error messages |
uint32_t ob_video_stream_profile_fps | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the frame rate of the video stream.
+[in] | profile | Stream profile object |
[out] | error | Log error messages |
uint32_t ob_video_stream_profile_width | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the width of the video stream.
+[in] | profile | Stream profile object , If the profile is not a video stream configuration, an error will be returned |
[out] | error | Log error messages |
uint32_t ob_video_stream_profile_height | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the height of the video stream.
+[in] | profile | Stream profile object , If the profile is not a video stream configuration, an error will be returned |
[out] | error | Log error messages |
ob_camera_intrinsic ob_video_stream_get_intrinsic | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the intrinsic of the video stream.
+profile | Stream profile object |
error | Log error messages |
ob_camera_distortion ob_video_stream_get_distortion | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the distortion of the video stream.
+profile | Stream profile object |
error | Log error messages |
ob_accel_full_scale_range ob_accel_stream_profile_full_scale_range | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the full-scale range of the accelerometer stream.
+[in] | profile | Stream profile object. If the profile is not for the accelerometer stream, an error will be returned. |
[out] | error | Log error messages. |
ob_accel_sample_rate ob_accel_stream_profile_sample_rate | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the sampling frequency of the accelerometer frame.
+[in] | profile | Stream profile object. If the profile is not for the accelerometer stream, an error will be returned. |
[out] | error | Log error messages. |
ob_accel_intrinsic ob_accel_stream_profile_get_intrinsic | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the intrinsic of the accelerometer stream.
+profile | Stream profile object. If the profile is not for the accelerometer stream, an error will be returned. |
error | Log error messages. |
ob_gyro_full_scale_range ob_gyro_stream_profile_full_scale_range | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the full-scale range of the gyroscope stream.
+[in] | profile | Stream profile object. If the profile is not for the gyroscope stream, an error will be returned. |
[out] | error | Log error messages. |
ob_gyro_intrinsic ob_gyro_stream_get_intrinsic | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the intrinsic of the gyroscope stream.
+profile | Stream profile object. If the profile is not for the gyroscope stream, an error will be returned. |
error | Log error messages. |
ob_gyro_sample_rate ob_gyro_stream_profile_sample_rate | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the sampling frequency of the gyroscope stream.
+[in] | profile | Stream profile object. If the profile is not for the gyroscope stream, an error will be returned. |
[out] | error | Log error messages. |
ob_stream_profile * ob_stream_profile_list_get_video_stream_profile | +( | +ob_stream_profile_list * | +profile_list, | +
+ | + | int | +width, | +
+ | + | int | +height, | +
+ | + | ob_format | +format, | +
+ | + | int | +fps, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Match the corresponding ob_stream_profile through the passed parameters. If there are multiple matches, the first one in the list will be returned by default. If no matched profile is found, an error will be returned.
+[in] | profile_list | Resolution list. |
[in] | width | Width. If you don't need to add matching conditions, you can pass OB_WIDTH_ANY. |
[in] | height | Height. If you don't need to add matching conditions, you can pass OB_HEIGHT_ANY. |
[in] | format | Format. If you don't need to add matching conditions, you can pass OB_FORMAT_ANY. |
[in] | fps | Frame rate. If you don't need to add matching conditions, you can pass OB_FPS_ANY. |
[out] | error | Log error messages. |
ob_stream_profile * ob_stream_profile_list_get_accel_stream_profile | +( | +ob_stream_profile_list * | +profile_list, | +
+ | + | ob_accel_full_scale_range | +fullScaleRange, | +
+ | + | ob_accel_sample_rate | +sampleRate, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Match the corresponding ob_stream_profile through the passed parameters. If there are multiple matches, the first one in the list will be returned by default. If no matched profile is found, an error will be returned.
+[in] | profile_list | Resolution list. |
[in] | fullScaleRange | Full-scale range. If you don't need to add matching conditions, you can pass 0. |
[in] | sampleRate | Sample rate. If you don't need to add matching conditions, you can pass 0. |
[out] | error | Log error messages. |
ob_stream_profile * ob_stream_profile_list_get_gyro_stream_profile | +( | +ob_stream_profile_list * | +profile_list, | +
+ | + | ob_gyro_full_scale_range | +fullScaleRange, | +
+ | + | ob_gyro_sample_rate | +sampleRate, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Match the corresponding ob_stream_profile through the passed parameters. If there are multiple matches, the first one in the list will be returned by default. If no matched profile is found, an error will be returned.
+[in] | profile_list | Resolution list. |
[in] | fullScaleRange | Full-scale range. If you don't need to add matching conditions, you can pass 0. |
[in] | sampleRate | Sample rate. If you don't need to add matching conditions, you can pass 0. |
[out] | error | Log error messages. |
ob_stream_profile * ob_stream_profile_list_get_profile | +( | +ob_stream_profile_list * | +profile_list, | +
+ | + | int | +index, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the corresponding StreamProfile by subscripting.
+[in] | profile_list | StreamProfile lists. |
[in] | index | Index. |
[out] | error | Log error messages. |
uint32_t ob_stream_profile_list_count | +( | +ob_stream_profile_list * | +profile_list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Get the number of StreamProfile lists.
+[in] | profile_list | StreamProfile list. |
[out] | error | Log error messages. |
void ob_delete_stream_profile_list | +( | +ob_stream_profile_list * | +profile_list, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete the stream profile list.
+[in] | profile_list | Stream configuration list. |
[out] | error | Log error messages. |
void ob_delete_stream_profile | +( | +ob_stream_profile * | +profile, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Delete the stream configuration.
+[in] | profile | Stream profile object . |
[out] | error | Log error messages. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The stream profile related type is used to get information such as the width, height, frame rate, and format of the stream. +More...
+ +Go to the source code of this file.
++Classes | |
class | ob::StreamProfile |
class | ob::VideoStreamProfile |
Class representing a video stream profile. More... | |
class | ob::AccelStreamProfile |
Class representing an accelerometer stream profile. More... | |
class | ob::GyroStreamProfile |
Class representing a gyroscope stream profile. More... | |
class | ob::StreamProfileList |
+Namespaces | |
namespace | ob |
The stream profile related type is used to get information such as the width, height, frame rate, and format of the stream.
+ +Definition in file StreamProfile.hpp.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes.h). +More...
+ +Go to the source code of this file.
++Typedefs | |
using | SendFileCallback = std::function< void(OBFileTranState state, const char *message, uint8_t percent)> |
Callback function for file transfer status updates. | |
using | DeviceUpgradeCallback = std::function< void(OBUpgradeState state, const char *message, uint8_t percent)> |
Callback function for device upgrade status updates. | |
using | DeviceStateChangedCallback = std::function< void(OBDeviceState state, const char *message)> |
Callback function for device status updates. | |
using | GetDataCallback = std::function< void(OBDataTranState state, OBDataChunk *dataChunk)> |
Callback function for getting raw data property data when data and progress callbacks are made. | |
using | SetDataCallback = std::function< void(OBDataTranState state, uint8_t percent)> |
Callback function for setting the raw data property when progress callbacks are made. | |
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes.h).
+ +Definition in file Types.hpp.
+using SendFileCallback = std::function<void(OBFileTranState state, const char *message, uint8_t percent)> | +
using DeviceUpgradeCallback = std::function<void(OBUpgradeState state, const char *message, uint8_t percent)> | +
using DeviceStateChangedCallback = std::function<void(OBDeviceState state, const char *message)> | +
using GetDataCallback = std::function<void(OBDataTranState state, OBDataChunk *dataChunk)> | +
using SetDataCallback = std::function<void(OBDataTranState state, uint8_t percent)> | +
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include "ObTypes.h"
Go to the source code of this file.
++Functions | |
bool | ob_calibration_3d_to_3d (const ob_calibration_param calibration_param, const ob_point3f source_point3f, const ob_sensor_type source_sensor_type, const ob_sensor_type target_sensor_type, ob_point3f *target_point3f, ob_error **error) |
Transform a 3d point of a source coordinate system into a 3d point of the target coordinate system. | |
bool | ob_calibration_2d_to_3d (const ob_calibration_param calibration_param, const ob_point2f source_point2f, const float source_depth_pixel_value, const ob_sensor_type source_sensor_type, const ob_sensor_type target_sensor_type, ob_point3f *target_point3f, ob_error **error) |
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 3d point of the target coordinate system. | |
bool | ob_calibration_2d_to_3d_undistortion (const ob_calibration_param calibration_param, const ob_point2f source_point2f, const float source_depth_pixel_value, const ob_sensor_type source_sensor_type, const ob_sensor_type target_sensor_type, ob_point3f *target_point3f, ob_error **error) |
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 3d point of the target coordinate system. | |
bool | ob_calibration_3d_to_2d (const ob_calibration_param calibration_param, const ob_point3f source_point3f, const ob_sensor_type source_sensor_type, const ob_sensor_type target_sensor_type, ob_point2f *target_point2f, ob_error **error) |
Transform a 3d point of a source coordinate system into a 2d pixel coordinate of the target camera. | |
bool | ob_calibration_2d_to_2d (const ob_calibration_param calibration_param, const ob_point2f source_point2f, const float source_depth_pixel_value, const ob_sensor_type source_sensor_type, const ob_sensor_type target_sensor_type, ob_point2f *target_point2f, ob_error **error) |
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 2d pixel coordinate of the target camera. | |
ob_frame * | transformation_depth_frame_to_color_camera (ob_device *device, ob_frame *depth_frame, uint32_t target_color_camera_width, uint32_t target_color_camera_height, ob_error **error) |
Transforms the depth frame into the geometry of the color camera. | |
bool | transformation_init_xy_tables (const ob_calibration_param calibration_param, const ob_sensor_type sensor_type, float *data, uint32_t *data_size, ob_xy_tables *xy_tables, ob_error **error) |
Init transformation tables. | |
void | transformation_depth_to_pointcloud (ob_xy_tables *xy_tables, const void *depth_image_data, void *pointcloud_data, ob_error **error) |
Transform depth image to point cloud data. | |
void | transformation_depth_to_rgbd_pointcloud (ob_xy_tables *xy_tables, const void *depth_image_data, const void *color_image_data, void *pointcloud_data, ob_error **error) |
Transform depth image to point cloud data. | |
bool ob_calibration_3d_to_3d | +( | +const ob_calibration_param | +calibration_param, | +
+ | + | const ob_point3f | +source_point3f, | +
+ | + | const ob_sensor_type | +source_sensor_type, | +
+ | + | const ob_sensor_type | +target_sensor_type, | +
+ | + | ob_point3f * | +target_point3f, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Transform a 3d point of a source coordinate system into a 3d point of the target coordinate system.
+[in] | calibration_param | Device calibration param,see pipeline::getCalibrationParam |
[in] | source_point3f | Source 3d point value |
[in] | source_sensor_type | Source sensor type |
[in] | target_sensor_type | Target sensor type |
[out] | target_point3f | Target 3d point value |
[out] | error | Log error messages |
bool ob_calibration_2d_to_3d | +( | +const ob_calibration_param | +calibration_param, | +
+ | + | const ob_point2f | +source_point2f, | +
+ | + | const float | +source_depth_pixel_value, | +
+ | + | const ob_sensor_type | +source_sensor_type, | +
+ | + | const ob_sensor_type | +target_sensor_type, | +
+ | + | ob_point3f * | +target_point3f, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 3d point of the target coordinate system.
+[in] | calibration_param | Device calibration param,see pipeline::getCalibrationParam |
[in] | source_point2f | Source 2d point value |
[in] | source_depth_pixel_value | The depth of sourcePoint2f in millimeters |
[in] | source_sensor_type | Source sensor type |
[in] | target_sensor_type | Target sensor type |
[out] | target_point3f | Target 3d point value |
[out] | error | Log error messages |
bool ob_calibration_2d_to_3d_undistortion | +( | +const ob_calibration_param | +calibration_param, | +
+ | + | const ob_point2f | +source_point2f, | +
+ | + | const float | +source_depth_pixel_value, | +
+ | + | const ob_sensor_type | +source_sensor_type, | +
+ | + | const ob_sensor_type | +target_sensor_type, | +
+ | + | ob_point3f * | +target_point3f, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 3d point of the target coordinate system.
+[in] | calibration_param | Device calibration param,see pipeline::getCalibrationParam |
[in] | source_point2f | Source 2d point value |
[in] | source_depth_pixel_value | The depth of sourcePoint2f in millimeters |
[in] | source_sensor_type | Source sensor type |
[in] | target_sensor_type | Target sensor type |
[out] | target_point3f | Target 3d point value |
[out] | error | Log error messages |
bool ob_calibration_3d_to_2d | +( | +const ob_calibration_param | +calibration_param, | +
+ | + | const ob_point3f | +source_point3f, | +
+ | + | const ob_sensor_type | +source_sensor_type, | +
+ | + | const ob_sensor_type | +target_sensor_type, | +
+ | + | ob_point2f * | +target_point2f, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Transform a 3d point of a source coordinate system into a 2d pixel coordinate of the target camera.
+[in] | calibration_param | Device calibration param,see pipeline::getCalibrationParam |
[in] | source_point3f | Source 3d point value |
[in] | source_sensor_type | Source sensor type |
[in] | target_sensor_type | Target sensor type |
[out] | target_point2f | Target 2d point value |
[out] | error | Log error messages |
bool ob_calibration_2d_to_2d | +( | +const ob_calibration_param | +calibration_param, | +
+ | + | const ob_point2f | +source_point2f, | +
+ | + | const float | +source_depth_pixel_value, | +
+ | + | const ob_sensor_type | +source_sensor_type, | +
+ | + | const ob_sensor_type | +target_sensor_type, | +
+ | + | ob_point2f * | +target_point2f, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 2d pixel coordinate of the target camera.
+[in] | calibration_param | Device calibration param,see pipeline::getCalibrationParam |
[in] | source_point2f | Source 2d point value |
[in] | source_depth_pixel_value | The depth of sourcePoint2f in millimeters |
[in] | source_sensor_type | Source sensor type |
[in] | target_sensor_type | Target sensor type |
[out] | target_point2f | Target 2d point value |
[out] | error | Log error messages |
ob_frame * transformation_depth_frame_to_color_camera | +( | +ob_device * | +device, | +
+ | + | ob_frame * | +depth_frame, | +
+ | + | uint32_t | +target_color_camera_width, | +
+ | + | uint32_t | +target_color_camera_height, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Transforms the depth frame into the geometry of the color camera.
+[in] | device | Device handle |
[in] | depth_frame | Input depth frame |
[in] | target_color_camera_width | Target color camera width |
[in] | target_color_camera_height | Target color camera height |
[out] | error | Log error messages |
bool transformation_init_xy_tables | +( | +const ob_calibration_param | +calibration_param, | +
+ | + | const ob_sensor_type | +sensor_type, | +
+ | + | float * | +data, | +
+ | + | uint32_t * | +data_size, | +
+ | + | ob_xy_tables * | +xy_tables, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Init transformation tables.
+[in] | calibration_param | Device calibration param,see pipeline::getCalibrationParam |
[in] | sensor_type | sensor type |
[in] | data | input data,needs to be allocated externally.During initialization, the external allocation size is 'data_size', for example, data_size = 1920
|
[in] | data_size | input data size |
[out] | xy_tables | output xy tables |
[out] | error | Log error messages |
void transformation_depth_to_pointcloud | +( | +ob_xy_tables * | +xy_tables, | +
+ | + | const void * | +depth_image_data, | +
+ | + | void * | +pointcloud_data, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Transform depth image to point cloud data.
+[in] | xy_tables | input xy tables,see transformation_init_xy_tables |
[in] | depth_image_data | input depth image data |
[out] | pointcloud_data | output point cloud data |
[out] | error | Log error messages |
void transformation_depth_to_rgbd_pointcloud | +( | +ob_xy_tables * | +xy_tables, | +
+ | + | const void * | +depth_image_data, | +
+ | + | const void * | +color_image_data, | +
+ | + | void * | +pointcloud_data, | +
+ | + | ob_error ** | +error | +
+ | ) | ++ |
Transform depth image to point cloud data.
+[in] | xy_tables | input xy tables,see transformation_init_xy_tables |
[in] | depth_image_data | input depth image data |
[in] | color_image_data | input color image data (only RGB888 support) |
[out] | pointcloud_data | output point cloud data |
[out] | error | Log error messages |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The SDK utils class. +More...
+#include "Types.hpp"
Go to the source code of this file.
++Classes | |
class | ob::CoordinateTransformHelper |
+Namespaces | |
namespace | ob |
The SDK utils class.
+ +Definition in file Utils.hpp.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Functions for retrieving the SDK version number information. +More...
+ +Go to the source code of this file.
++Functions | |
int | ob_get_version () |
Get the SDK version number. | |
int | ob_get_major_version () |
Get the SDK major version number. | |
int | ob_get_minor_version () |
Get the SDK minor version number. | |
int | ob_get_patch_version () |
Get the SDK patch version number. | |
const char * | ob_get_stage_version () |
Get the SDK stage version. | |
Functions for retrieving the SDK version number information.
+ +Definition in file Version.h.
+int ob_get_version | +( | +) | ++ |
Get the SDK version number.
+int ob_get_major_version | +( | +) | ++ |
Get the SDK major version number.
+int ob_get_minor_version | +( | +) | ++ |
Get the SDK minor version number.
+int ob_get_patch_version | +( | +) | ++ |
Get the SDK patch version number.
+const char * ob_get_stage_version | +( | +) | ++ |
Get the SDK stage version.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Provides functions to retrieve version information of the SDK. +More...
+ +Go to the source code of this file.
++Classes | |
class | ob::Version |
+Namespaces | |
namespace | ob |
Provides functions to retrieve version information of the SDK.
+ +Definition in file Version.hpp.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
▼Nob | |
CAccelFrame | Define the AccelFrame class, which inherits from the Frame class |
CAccelStreamProfile | Class representing an accelerometer stream profile |
CAlign | Align for depth to other or other to depth |
CCameraParamList | Class representing a list of camera parameters |
CColorFrame | |
CCompressionFilter | Subclass of Filter that performs compression |
CConfig | Config class for configuring pipeline parameters |
CContext | |
CCoordinateTransformHelper | |
CDecimationFilter | Decimation filter,reducing complexity by subsampling depth maps and losing depth details |
CDecompressionFilter | Subclass of Filter that performs decompression |
CDepthFrame | |
CDevice | |
CDeviceInfo | A class describing device information, representing the name, id, serial number and other basic information of an RGBD camera |
CDeviceList | Class representing a list of devices |
CDevicePresetList | Class representing a list of device presets @breif A device preset is a set of parameters or configurations that can be applied to the device to achieve a specific effect or function |
CDisparityTransform | Depth to disparity or disparity to depth |
CEdgeNoiseRemovalFilter | The edge noise removal filter,removing scattering depth pixels |
CError | |
CFilter | Base class for all filters in the SDK |
CFormatConvertFilter | Subclass of Filter that performs format conversion |
CFrame | |
CFrameHelper | Define the FrameHelper class |
CFrameSet | Define the FrameSet class, which inherits from the Frame class |
CGyroFrame | Define the GyroFrame class, which inherits from the Frame class |
CGyroStreamProfile | Class representing a gyroscope stream profile |
CHdrMerge | HdrMerge processing block, the processing merges between depth frames with different sub-preset sequence ids |
CHoleFillingFilter | Hole filling filter,the processing performed depends on the selected hole filling mode |
CIRFrame | |
CNoiseRemovalFilter | The noise removal filter,removing scattering depth pixels |
COBDepthWorkModeList | Class representing a list of OBDepthWorkMode |
COBFilterList | Class representing a list of FrameProcessingBlock |
CPipeline | |
CPlayback | |
CPointCloudFilter | Subclass of Filter that generates point clouds |
CPointsFrame | |
CRawPhaseFrame | Define the RawPhaseFrame class, which inherits from the VideoFrame class |
CRecorder | |
CSensor | |
CSensorList | |
CSequenceIdFilter | Create SequenceIdFilter processing block |
CSpatialAdvancedFilter | Spatial advanced filter smooths the image by calculating frame with alpha and delta settings alpha defines the weight of the current pixel for smoothing, delta defines the depth gradient below which the smoothing will occur as number of depth levels |
CSpatialFastFilter | Spatial fast filter smooths the image by calculating frame with filter window size settings |
CSpatialModerateFilter | Spatial moderate filter smooths the image by calculating frame with filter window size,magnitude and disp diff settings |
CStreamProfile | |
CStreamProfileList | |
CTemporalFilter | Temporal filter |
CThresholdFilter | Creates depth Thresholding filter By controlling min and max options on the block |
CVersion | |
CVideoFrame | |
CVideoStreamProfile | Class representing a video stream profile |
CAE_ROI | The rect of the region of interest |
CBASELINE_CALIBRATION_PARAM | Baseline calibration parameters |
CDISP_OFFSET_CONFIG | |
CHDR_CONFIG | HDR Configuration |
Cob_device_timestamp_reset_config | The timestamp reset configuration of the device |
Cob_error | The error class exposed by the SDK, users can get detailed error information according to the error |
Cob_margin_filter_config | Configuration for depth margin filter |
Cob_multi_device_sync_config | The synchronization configuration of the device |
COBAccelIntrinsic | Structure for accelerometer intrinsic parameters |
COBAccelValue | Data structures for accelerometers and gyroscopes |
COBBoolPropertyRange | Structure for boolean range |
COBCalibrationParam | Calibration parameters |
COBCameraAlignIntrinsic | Video stream intrinsics |
COBCameraDistortion | Structure for distortion parameters |
COBCameraIntrinsic | Structure for camera intrinsic parameters |
COBCameraParam | Structure for camera parameters |
COBCameraParam_V0 | Camera parameters |
COBColorPoint | 3D point structure with color information |
COBCompressionParams | |
COBD2CTransform | Structure for rotation/transformation |
COBDataBundle | Internal API for future publication |
COBDataChunk | Structure for transmitting data blocks |
COBDepthWorkMode | Depth work mode |
COBDeviceSyncConfig | Device synchronization configuration |
COBDeviceTemperature | Temperature parameters of the device (unit: Celsius) |
COBEdgeNoiseRemovalFilterParams | |
COBFloatPropertyRange | Structure for float range |
COBGyroIntrinsic | Structure for gyroscope intrinsic parameters |
COBIntPropertyRange | Structure for integer range |
COBMGCFilterConfig | Configuration for mgc filter |
COBNetIpConfig | IP address configuration for network devices (IPv4) |
COBNoiseRemovalFilterParams | |
COBPoint | 3D point structure in the SDK |
COBPoint2f | 2D point structure in the SDK |
COBPropertyItem | Used to describe the characteristics of each property |
COBProtocolVersion | Control command protocol version number |
COBRect | Rectangle |
COBSequenceIdItem | SequenceId fliter list item |
COBSpatialAdvancedFilterParams | |
COBSpatialFastFilterParams | |
COBSpatialModerateFilterParams | |
COBTofExposureThresholdControl | TOF Exposure Threshold |
COBUint16PropertyRange | Structure for float range |
COBUint8PropertyRange | Structure for float range |
COBXYTables |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::AccelFrame, including all inherited members.
+AccelFrame(Frame &frame) | ob::AccelFrame | explicit |
AccelFrame(std::unique_ptr< FrameImpl > impl) | ob::AccelFrame | explicit |
as() | ob::Frame | inline |
data() | ob::Frame | virtual |
dataSize() | ob::Frame | virtual |
format() | ob::Frame | virtual |
Frame(std::unique_ptr< FrameImpl > impl) | ob::Frame | explicit |
Frame(Frame &frame) | ob::Frame | |
getDevice() | ob::Frame | |
getMetadataValue(OBFrameMetadataType type) | ob::Frame | |
getSensor() | ob::Frame | |
getStreamProfile() | ob::Frame | |
globalTimeStampUs() | ob::Frame | |
hasMetadata(OBFrameMetadataType type) | ob::Frame | |
impl_ | ob::Frame | protected |
index() | ob::Frame | virtual |
is() | ob::Frame | |
metadata() | ob::Frame | |
metadataSize() | ob::Frame | |
systemTimeStamp() | ob::Frame | |
systemTimeStampUs() | ob::Frame | |
temperature() | ob::AccelFrame | |
timeStamp() | ob::Frame | |
timeStampUs() | ob::Frame | |
type() | ob::Frame | virtual |
value() | ob::AccelFrame | |
~AccelFrame() noexcept override=default | ob::AccelFrame | |
~Frame() noexcept | ob::Frame | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Define the AccelFrame class, which inherits from the Frame class. + More...
+ +#include <Frame.hpp>
+Public Member Functions | |
AccelFrame (Frame &frame) | |
AccelFrame (std::unique_ptr< FrameImpl > impl) | |
~AccelFrame () noexcept override=default | |
OBAccelValue | value () |
Get the accelerometer frame data. | |
float | temperature () |
Get the temperature when the frame was sampled. | |
Public Member Functions inherited from ob::Frame | |
Frame (std::unique_ptr< FrameImpl > impl) | |
Frame (Frame &frame) | |
virtual | ~Frame () noexcept |
virtual OBFrameType | type () |
Get the type of frame. | |
virtual OBFormat | format () |
Get the format of the frame. | |
virtual uint64_t | index () |
Get the sequence number of the frame. | |
virtual void * | data () |
Get the frame data. | |
virtual uint32_t | dataSize () |
Get the size of the frame data. | |
uint64_t | timeStamp () |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | timeStampUs () |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | systemTimeStamp () |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | systemTimeStampUs () |
Get the system timestamp of the frame in microseconds. | |
uint64_t | globalTimeStampUs () |
Get the global timestamp of the frame in microseconds. | |
void * | metadata () |
Get the metadata of the frame. | |
uint32_t | metadataSize () |
Get the size of the metadata of the frame. | |
bool | hasMetadata (OBFrameMetadataType type) |
Check if the frame object has metadata of a given type. | |
int64_t | getMetadataValue (OBFrameMetadataType type) |
Get the metadata value. | |
std::shared_ptr< StreamProfile > | getStreamProfile () |
get StreamProfile of the frame | |
std::shared_ptr< Sensor > | getSensor () |
get owner sensor of the frame | |
std::shared_ptr< Device > | getDevice () |
get owner device of the frame | |
template<typename T > | |
bool | is () |
Check if the runtime type of the frame object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the frame object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Frame | |
std::unique_ptr< FrameImpl > | impl_ |
Define the AccelFrame class, which inherits from the Frame class.
+ + +
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridedefaultnoexcept | +
OBAccelValue ob::AccelFrame::value | +( | +) | ++ |
Get the accelerometer frame data.
+float ob::AccelFrame::temperature | +( | +) | ++ |
Get the temperature when the frame was sampled.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::AccelStreamProfile, including all inherited members.
+AccelStreamProfile(StreamProfile &profile) | ob::AccelStreamProfile | explicit |
AccelStreamProfile(std::unique_ptr< StreamProfileImpl > impl) | ob::AccelStreamProfile | explicit |
as() | ob::StreamProfile | inline |
format() const | ob::StreamProfile | |
fullScaleRange() const | ob::AccelStreamProfile | |
getExtrinsicTo(std::shared_ptr< StreamProfile > target) | ob::StreamProfile | |
getIntrinsic() | ob::AccelStreamProfile | |
impl_ | ob::StreamProfile | protected |
is() | ob::StreamProfile | |
sampleRate() const | ob::AccelStreamProfile | |
StreamProfile(std::unique_ptr< StreamProfileImpl > impl) | ob::StreamProfile | |
StreamProfile(StreamProfile &streamProfile) | ob::StreamProfile | |
type() const | ob::StreamProfile | |
~AccelStreamProfile() noexcept override | ob::AccelStreamProfile | |
~StreamProfile() noexcept | ob::StreamProfile | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Class representing an accelerometer stream profile. + More...
+ +#include <StreamProfile.hpp>
+Public Member Functions | |
AccelStreamProfile (StreamProfile &profile) | |
AccelStreamProfile (std::unique_ptr< StreamProfileImpl > impl) | |
~AccelStreamProfile () noexcept override | |
OBAccelFullScaleRange | fullScaleRange () const |
Return the full scale range. | |
OBAccelSampleRate | sampleRate () const |
Return the sampling frequency. | |
OBAccelIntrinsic | getIntrinsic () |
get the intrinsic parameters of the stream. | |
Public Member Functions inherited from ob::StreamProfile | |
StreamProfile (std::unique_ptr< StreamProfileImpl > impl) | |
StreamProfile (StreamProfile &streamProfile) | |
virtual | ~StreamProfile () noexcept |
OBFormat | format () const |
Get the format of the stream. | |
OBStreamType | type () const |
Get the type of stream. | |
OBExtrinsic | getExtrinsicTo (std::shared_ptr< StreamProfile > target) |
Get the extrinsic parameters from current stream profile to the given target stream profile. | |
template<typename T > | |
bool | is () |
Check if frame object is compatible with the given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Converts object type to target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::StreamProfile | |
std::unique_ptr< StreamProfileImpl > | impl_ |
Class representing an accelerometer stream profile.
+ +Definition at line 130 of file StreamProfile.hpp.
+
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridenoexcept | +
OBAccelFullScaleRange ob::AccelStreamProfile::fullScaleRange | +( | +) | +const | +
Return the full scale range.
+OBAccelSampleRate ob::AccelStreamProfile::sampleRate | +( | +) | +const | +
Return the sampling frequency.
+OBAccelIntrinsic ob::AccelStreamProfile::getIntrinsic | +( | +) | ++ |
get the intrinsic parameters of the stream.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Align, including all inherited members.
+Align(OBStreamType align_to_stream) | ob::Align | |
as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getAlignToStreamType() | ob::Align | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Align for depth to other or other to depth. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
Align (OBStreamType align_to_stream) | |
Creaet Align filter. | |
OBStreamType | getAlignToStreamType () |
Get the stream type to be aligned with. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
Align for depth to other or other to depth.
+ +Definition at line 405 of file Filter.hpp.
+ob::Align::Align | +( | +OBStreamType | +align_to_stream | ) | ++ |
Creaet Align filter.
+OBStreamType | alignment is performed between a depth image and another image. |
OBStreamType ob::Align::getAlignToStreamType | +( | +) | ++ |
Get the stream type to be aligned with.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::CameraParamList, including all inherited members.
+CameraParamList(std::unique_ptr< CameraParamListImpl > impl) | ob::CameraParamList | |
count() | ob::CameraParamList | |
getCameraParam(uint32_t index) | ob::CameraParamList | |
~CameraParamList() noexcept | ob::CameraParamList |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Class representing a list of camera parameters. + More...
+ +#include <Device.hpp>
+Public Member Functions | |
CameraParamList (std::unique_ptr< CameraParamListImpl > impl) | |
~CameraParamList () noexcept | |
uint32_t | count () |
Get the number of camera parameter groups. | |
OBCameraParam | getCameraParam (uint32_t index) |
Get the camera parameters for the specified index. | |
Class representing a list of camera parameters.
+ +Definition at line 867 of file Device.hpp.
+ob::CameraParamList::CameraParamList | +( | +std::unique_ptr< CameraParamListImpl > | +impl | ) | ++ |
+
|
+ +noexcept | +
uint32_t ob::CameraParamList::count | +( | +) | ++ |
Get the number of camera parameter groups.
+OBCameraParam ob::CameraParamList::getCameraParam | +( | +uint32_t | +index | ) | ++ |
Get the camera parameters for the specified index.
+index | the index of the parameter group |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::ColorFrame, including all inherited members.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Frame.hpp>
+Public Member Functions | |
ColorFrame (Frame &frame) | |
ColorFrame (std::unique_ptr< FrameImpl > impl) | |
~ColorFrame () noexcept override=default | |
Public Member Functions inherited from ob::VideoFrame | |
VideoFrame (Frame &frame) | |
VideoFrame (std::unique_ptr< FrameImpl > impl) | |
~VideoFrame () noexcept override=default | |
uint32_t | width () |
Get the width of the frame. | |
uint32_t | height () |
Get the height of the frame. | |
uint8_t | pixelAvailableBitSize () |
Get the effective number of pixels in the frame. | |
Public Member Functions inherited from ob::Frame | |
Frame (std::unique_ptr< FrameImpl > impl) | |
Frame (Frame &frame) | |
virtual | ~Frame () noexcept |
virtual OBFrameType | type () |
Get the type of frame. | |
virtual OBFormat | format () |
Get the format of the frame. | |
virtual uint64_t | index () |
Get the sequence number of the frame. | |
virtual void * | data () |
Get the frame data. | |
virtual uint32_t | dataSize () |
Get the size of the frame data. | |
uint64_t | timeStamp () |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | timeStampUs () |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | systemTimeStamp () |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | systemTimeStampUs () |
Get the system timestamp of the frame in microseconds. | |
uint64_t | globalTimeStampUs () |
Get the global timestamp of the frame in microseconds. | |
void * | metadata () |
Get the metadata of the frame. | |
uint32_t | metadataSize () |
Get the size of the metadata of the frame. | |
bool | hasMetadata (OBFrameMetadataType type) |
Check if the frame object has metadata of a given type. | |
int64_t | getMetadataValue (OBFrameMetadataType type) |
Get the metadata value. | |
std::shared_ptr< StreamProfile > | getStreamProfile () |
get StreamProfile of the frame | |
std::shared_ptr< Sensor > | getSensor () |
get owner sensor of the frame | |
std::shared_ptr< Device > | getDevice () |
get owner device of the frame | |
template<typename T > | |
bool | is () |
Check if the runtime type of the frame object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the frame object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Frame | |
std::unique_ptr< FrameImpl > | impl_ |
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridedefaultnoexcept | +
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::CompressionFilter, including all inherited members.
+as() | ob::Filter | inline |
CompressionFilter() | ob::CompressionFilter | |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setCompressionParams(OBCompressionMode mode, void *params) | ob::CompressionFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The CompressionFilter class is a subclass of Filter that performs compression. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
CompressionFilter () | |
void | setCompressionParams (OBCompressionMode mode, void *params) |
Set the compression parameters. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
The CompressionFilter class is a subclass of Filter that performs compression.
+ +Definition at line 180 of file Filter.hpp.
+ob::CompressionFilter::CompressionFilter | +( | +) | ++ |
void ob::CompressionFilter::setCompressionParams | +( | +OBCompressionMode | +mode, | +
+ | + | void * | +params | +
+ | ) | ++ |
Set the compression parameters.
+mode | The compression mode: OB_COMPRESSION_LOSSLESS or OB_COMPRESSION_LOSSY. |
params | The compression parameters. When mode is OB_COMPRESSION_LOSSLESS, params is NULL. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Config, including all inherited members.
+Config() | ob::Config | |
disableAllStream() | ob::Config | |
disableStream(OBStreamType streamType) | ob::Config | |
enableAccelStream(ob_accel_full_scale_range fullScaleRange=OB_ACCEL_FULL_SCALE_RANGE_ANY, ob_accel_sample_rate sampleRate=OB_ACCEL_SAMPLE_RATE_ANY) | ob::Config | |
enableAllStream() | ob::Config | |
enableGyroStream(ob_gyro_full_scale_range fullScaleRange=OB_GYRO_FULL_SCALE_RANGE_ANY, ob_gyro_sample_rate sampleRate=OB_GYRO_SAMPLE_RATE_ANY) | ob::Config | |
enableStream(std::shared_ptr< StreamProfile > streamProfile) | ob::Config | |
enableVideoStream(ob_stream_type type, int width=OB_WIDTH_ANY, int height=OB_HEIGHT_ANY, int fps=OB_FPS_ANY, OBFormat format=OB_FORMAT_ANY) | ob::Config | |
getEnabledStreamProfileList() const | ob::Config | |
Pipeline | ob::Config | friend |
setAlignMode(OBAlignMode mode) | ob::Config | |
setD2CTargetResolution(uint32_t d2cTargetWidth, uint32_t d2cTargetHeight) | ob::Config | |
setDepthScaleRequire(bool enable) | ob::Config | |
setFrameAggregateOutputMode(OBFrameAggregateOutputMode mode) | ob::Config | |
~Config() noexcept | ob::Config |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Config class for configuring pipeline parameters. + More...
+ +#include <Pipeline.hpp>
+Public Member Functions | |
Config () | |
Construct a new Config object. | |
~Config () noexcept | |
Destroy the Config object. | |
void | enableStream (std::shared_ptr< StreamProfile > streamProfile) |
Enable a stream to be used in the pipeline. | |
void | enableAllStream () |
Enable all streams to be used in the pipeline. | |
void | enableVideoStream (ob_stream_type type, int width=OB_WIDTH_ANY, int height=OB_HEIGHT_ANY, int fps=OB_FPS_ANY, OBFormat format=OB_FORMAT_ANY) |
Enable a video stream to be used in the pipeline. | |
void | enableAccelStream (ob_accel_full_scale_range fullScaleRange=OB_ACCEL_FULL_SCALE_RANGE_ANY, ob_accel_sample_rate sampleRate=OB_ACCEL_SAMPLE_RATE_ANY) |
Enable an accelerometer stream to be used in the pipeline. | |
void | enableGyroStream (ob_gyro_full_scale_range fullScaleRange=OB_GYRO_FULL_SCALE_RANGE_ANY, ob_gyro_sample_rate sampleRate=OB_GYRO_SAMPLE_RATE_ANY) |
Enable a gyroscope stream to be used in the pipeline. | |
void | disableStream (OBStreamType streamType) |
Disable a stream to be used in the pipeline. | |
void | disableAllStream () |
Disable all streams to be used in the pipeline. | |
std::shared_ptr< StreamProfileList > | getEnabledStreamProfileList () const |
Get the Enabled Stream Profile List. | |
void | setAlignMode (OBAlignMode mode) |
Set the alignment mode. | |
void | setDepthScaleRequire (bool enable) |
Set whether the depth needs to be scaled after setting D2C. | |
void | setD2CTargetResolution (uint32_t d2cTargetWidth, uint32_t d2cTargetHeight) |
Set the D2C target resolution. | |
void | setFrameAggregateOutputMode (OBFrameAggregateOutputMode mode) |
Set the frame aggregation output mode for the pipeline configuration. | |
+Friends | |
class | Pipeline |
Config class for configuring pipeline parameters.
+The Config class provides an interface for configuring pipeline parameters.
+ +Definition at line 210 of file Pipeline.hpp.
+ob::Config::Config | +( | +) | ++ |
Construct a new Config object.
+ +
+
|
+ +noexcept | +
Destroy the Config object.
+ +void ob::Config::enableStream | +( | +std::shared_ptr< StreamProfile > | +streamProfile | ) | ++ |
Enable a stream to be used in the pipeline.
+streamProfile | The stream configuration to be enabled |
void ob::Config::enableAllStream | +( | +) | ++ |
Enable all streams to be used in the pipeline.
+ + +void ob::Config::enableVideoStream | +( | +ob_stream_type | +type, | +
+ | + | int | +width = OB_WIDTH_ANY , |
+
+ | + | int | +height = OB_HEIGHT_ANY , |
+
+ | + | int | +fps = OB_FPS_ANY , |
+
+ | + | OBFormat | +format = OB_FORMAT_ANY |
+
+ | ) | ++ |
Enable a video stream to be used in the pipeline.
+This function allows users to enable a video stream with customizable parameters. If no parameters are specified, the stream will be enabled with default resolution settings. Users who wish to set custom resolutions should refer to the product manual, as available resolutions vary by camera model.
+type | The video stream type. |
width | The video stream width (default is OB_WIDTH_ANY, which selects the default resolution). |
height | The video stream height (default is OB_HEIGHT_ANY, which selects the default resolution). |
fps | The video stream frame rate (default is OB_FPS_ANY, which selects the default frame rate). |
format | The video stream format (default is OB_FORMAT_ANY, which selects the default format). |
void ob::Config::enableAccelStream | +( | +ob_accel_full_scale_range | +fullScaleRange = OB_ACCEL_FULL_SCALE_RANGE_ANY , |
+
+ | + | ob_accel_sample_rate | +sampleRate = OB_ACCEL_SAMPLE_RATE_ANY |
+
+ | ) | ++ |
Enable an accelerometer stream to be used in the pipeline.
+This function allows users to enable an accelerometer stream with customizable parameters. If no parameters are specified, the stream will be enabled with default settings. Users who wish to set custom full-scale ranges or sample rates should refer to the product manual, as available settings vary by device model.
+fullScaleRange | The full-scale range of the accelerometer (default is OB_ACCEL_FULL_SCALE_RANGE_ANY, which selects the default range). |
sampleRate | The sample rate of the accelerometer (default is OB_ACCEL_SAMPLE_RATE_ANY, which selects the default rate). |
void ob::Config::enableGyroStream | +( | +ob_gyro_full_scale_range | +fullScaleRange = OB_GYRO_FULL_SCALE_RANGE_ANY , |
+
+ | + | ob_gyro_sample_rate | +sampleRate = OB_GYRO_SAMPLE_RATE_ANY |
+
+ | ) | ++ |
Enable a gyroscope stream to be used in the pipeline.
+This function allows users to enable a gyroscope stream with customizable parameters. If no parameters are specified, the stream will be enabled with default settings. Users who wish to set custom full-scale ranges or sample rates should refer to the product manual, as available settings vary by device model.
+fullScaleRange | The full-scale range of the gyroscope (default is OB_GYRO_FULL_SCALE_RANGE_ANY, which selects the default range). |
sampleRate | The sample rate of the gyroscope (default is OB_GYRO_SAMPLE_RATE_ANY, which selects the default rate). |
void ob::Config::disableStream | +( | +OBStreamType | +streamType | ) | ++ |
Disable a stream to be used in the pipeline.
+streamType | The stream configuration to be disabled |
void ob::Config::disableAllStream | +( | +) | ++ |
Disable all streams to be used in the pipeline.
+ +std::shared_ptr< StreamProfileList > ob::Config::getEnabledStreamProfileList | +( | +) | +const | +
Get the Enabled Stream Profile List.
+void ob::Config::setAlignMode | +( | +OBAlignMode | +mode | ) | ++ |
Set the alignment mode.
+mode | The alignment mode |
void ob::Config::setDepthScaleRequire | +( | +bool | +enable | ) | ++ |
Set whether the depth needs to be scaled after setting D2C.
+enable | Whether scaling is required |
void ob::Config::setD2CTargetResolution | +( | +uint32_t | +d2cTargetWidth, | +
+ | + | uint32_t | +d2cTargetHeight | +
+ | ) | ++ |
Set the D2C target resolution.
+The D2C target resolution is applicable to cases where the color stream is not enabled using the OrbbecSDK and the depth needs to be D2C.
+d2cTargetWidth | The D2C target width resolution |
d2cTargetHeight | The D2C target height resolution |
void ob::Config::setFrameAggregateOutputMode | +( | +OBFrameAggregateOutputMode | +mode | ) | ++ |
Set the frame aggregation output mode for the pipeline configuration.
+The processing strategy when the FrameSet generated by the frame aggregation function does not contain the frames of all opened streams (which can be caused by different frame rates of each stream, or by the loss of frames of one stream): drop directly or output to the user.
+mode | The frame aggregation output mode to be set (default mode is OB_FRAME_AGGREGATE_OUTPUT_FULL_FRAME_REQUIRE) |
+
|
+ +friend | +
Definition at line 332 of file Pipeline.hpp.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Context, including all inherited members.
+changeNetDeviceIpConfig(const char *deviceUid, const OBNetIpConfig &config) | ob::Context | |
Context(const char *configPath="") | ob::Context | |
createNetDevice(const char *address, uint16_t port) | ob::Context | |
DeviceChangedCallback typedef | ob::Context | |
enableDeviceClockSync(uint64_t repeatInterval) | ob::Context | |
enableNetDeviceEnumeration(bool enable) | ob::Context | |
freeIdleMemory() | ob::Context | |
loadLicense(const char *filePath, const char *key=OB_DEFAULT_DECRYPT_KEY) | ob::Context | static |
loadLicenseFromData(const char *data, uint32_t dataLen, const char *key=OB_DEFAULT_DECRYPT_KEY) | ob::Context | static |
LogCallback typedef | ob::Context | |
queryDeviceList() | ob::Context | |
setDeviceChangedCallback(DeviceChangedCallback callback) | ob::Context | |
setLoggerSeverity(OBLogSeverity severity) | ob::Context | static |
setLoggerToCallback(OBLogSeverity severity, LogCallback callback) | ob::Context | static |
setLoggerToConsole(OBLogSeverity severity) | ob::Context | static |
setLoggerToFile(OBLogSeverity severity, const char *directory) | ob::Context | static |
setUVCBackend(OBUvcBackend uvcBackend) | ob::Context | |
~Context() noexcept | ob::Context | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Context.hpp>
+Public Types | |
using | DeviceChangedCallback = std::function< void(std::shared_ptr< DeviceList > removedList, std::shared_ptr< DeviceList > addedList)> |
using | LogCallback = std::function< void(OBLogSeverity severity, const char *logMsg)> |
Log output callback function. | |
+Public Member Functions | |
Context (const char *configPath="") | |
The Context class is a management class that describes the runtime of the SDK. It is responsible for applying and releasing resources for the SDK. The context has the ability to manage multiple devices, enumerate devices, monitor device callbacks, and enable functions such as multi-device synchronization. | |
virtual | ~Context () noexcept |
std::shared_ptr< DeviceList > | queryDeviceList () |
Queries the enumerated device list. | |
void | enableNetDeviceEnumeration (bool enable) |
enable or disable net device enumeration. | |
std::shared_ptr< Device > | createNetDevice (const char *address, uint16_t port) |
Creates a network device object. | |
void | changeNetDeviceIpConfig (const char *deviceUid, const OBNetIpConfig &config) |
Changes the IP configuration of a network device. | |
void | setDeviceChangedCallback (DeviceChangedCallback callback) |
Set the device plug-in callback function. | |
void | enableDeviceClockSync (uint64_t repeatInterval) |
Activates device clock synchronization to synchronize the clock of the host and all created devices (if supported). | |
void | freeIdleMemory () |
Frees idle memory from the internal frame memory pool. | |
void | setUVCBackend (OBUvcBackend uvcBackend) |
Set the UVC backend for the specified context This function configures the Universal Video Class (UVC) backend for the given context, allowing the selection of a specific backend for video capture operations. | |
+Static Public Member Functions | |
static void | setLoggerSeverity (OBLogSeverity severity) |
Set the level of the global log, which affects both the log level output to the terminal and output to the file. | |
static void | setLoggerToFile (OBLogSeverity severity, const char *directory) |
Set log output to a file. | |
static void | setLoggerToConsole (OBLogSeverity severity) |
Set log output to the terminal. | |
static void | setLoggerToCallback (OBLogSeverity severity, LogCallback callback) |
Set the logger to callback. | |
static void | loadLicense (const char *filePath, const char *key=OB_DEFAULT_DECRYPT_KEY) |
Loads a license file. | |
static void | loadLicenseFromData (const char *data, uint32_t dataLen, const char *key=OB_DEFAULT_DECRYPT_KEY) |
Loads a license from data. | |
Definition at line 21 of file Context.hpp.
+using ob::Context::DeviceChangedCallback = std::function<void(std::shared_ptr<DeviceList> removedList, std::shared_ptr<DeviceList> addedList)> | +
Definition at line 69 of file Context.hpp.
+ +using ob::Context::LogCallback = std::function<void(OBLogSeverity severity, const char *logMsg)> | +
Log output callback function.
+severity | The current callback log level. |
logMsg | The log message. |
Definition at line 120 of file Context.hpp.
+ +ob::Context::Context | +( | +const char * | +configPath = "" | ) | ++ |
The Context class is a management class that describes the runtime of the SDK. It is responsible for applying and releasing resources for the SDK. The context has the ability to manage multiple devices, enumerate devices, monitor device callbacks, and enable functions such as multi-device synchronization.
+ +
+
|
+ +virtualnoexcept | +
std::shared_ptr< DeviceList > ob::Context::queryDeviceList | +( | +) | ++ |
Queries the enumerated device list.
+void ob::Context::enableNetDeviceEnumeration | +( | +bool | +enable | ) | ++ |
enable or disable net device enumeration.
+after enable, the net device will be discovered automatically and can be retrieved by queryDeviceList. The default state can be set in the configuration file.
+[out] | enable | true to enable, false to disable |
std::shared_ptr< Device > ob::Context::createNetDevice | +( | +const char * | +address, | +
+ | + | uint16_t | +port | +
+ | ) | ++ |
Creates a network device object.
+address | The IP address. |
port | The port. |
void ob::Context::changeNetDeviceIpConfig | +( | +const char * | +deviceUid, | +
+ | + | const OBNetIpConfig & | +config | +
+ | ) | ++ |
Changes the IP configuration of a network device.
+deviceUid | The device unique ID, which is the network device MAC address. It can be obtained through the DeviceList::uid() function. |
config | The new IP configuration. |
void ob::Context::setDeviceChangedCallback | +( | +DeviceChangedCallback | +callback | ) | ++ |
Set the device plug-in callback function.
+callback | The function triggered when the device is plugged and unplugged. |
void ob::Context::enableDeviceClockSync | +( | +uint64_t | +repeatInterval | ) | ++ |
Activates device clock synchronization to synchronize the clock of the host and all created devices (if supported).
+repeatInterval | The interval for auto-repeated synchronization, in milliseconds. If the value is 0, synchronization is performed only once. |
void ob::Context::freeIdleMemory | +( | +) | ++ |
Frees idle memory from the internal frame memory pool.
+ +
+
|
+ +static | +
Set the level of the global log, which affects both the log level output to the terminal and output to the file.
+severity | The log output level. |
+
|
+ +static | +
Set log output to a file.
+severity | The log level output to the file. |
directory | The log file output path. If the path is empty, the existing settings will continue to be used (if the existing configuration is also empty, the log will not be output to the file). |
+
|
+ +static | +
Set log output to the terminal.
+severity | The log level output to the terminal. |
+
|
+ +static | +
Set the logger to callback.
+severity | The callback log level. |
callback | The callback function. |
+
|
+ +static | +
Loads a license file.
+filePath | The license file path. |
key | The decryption key. |
+
|
+ +static | +
Loads a license from data.
+data | The license data. |
dataLen | The license data length. |
key | The decryption key. |
void ob::Context::setUVCBackend | +( | +OBUvcBackend | +uvcBackend | ) | ++ |
Set the UVC backend for the specified context This function configures the Universal Video Class (UVC) backend for the given context, allowing the selection of a specific backend for video capture operations.
+[in] | uvcBackend | Specifies the UVC backend to use:
|
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::CoordinateTransformHelper, including all inherited members.
+calibration2dTo2d(const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint2f *targetPoint2f) | ob::CoordinateTransformHelper | static |
calibration2dTo3d(const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f) | ob::CoordinateTransformHelper | static |
calibration2dTo3dUndistortion(const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f) | ob::CoordinateTransformHelper | static |
calibration3dTo2d(const OBCalibrationParam calibrationParam, const OBPoint3f sourcePoint3f, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint2f *targetPoint2f) | ob::CoordinateTransformHelper | static |
calibration3dTo3d(const OBCalibrationParam calibrationParam, const OBPoint3f sourcePoint3f, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f) | ob::CoordinateTransformHelper | static |
transformationDepthFrameToColorCamera(std::shared_ptr< ob::Device > device, std::shared_ptr< ob::Frame > depthFrame, uint32_t targetColorCameraWidth, uint32_t targetColorCameraHeight) | ob::CoordinateTransformHelper | static |
transformationDepthToPointCloud(OBXYTables *xyTables, const void *depthImageData, void *pointCloudData) | ob::CoordinateTransformHelper | static |
transformationDepthToRGBDPointCloud(OBXYTables *xyTables, const void *depthImageData, const void *colorImageData, void *pointCloudData) | ob::CoordinateTransformHelper | static |
transformationInitXYTables(const OBCalibrationParam calibrationParam, const OBSensorType sensorType, float *data, uint32_t *dataSize, OBXYTables *xyTables) | ob::CoordinateTransformHelper | static |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Utils.hpp>
+Static Public Member Functions | |
static bool | calibration3dTo3d (const OBCalibrationParam calibrationParam, const OBPoint3f sourcePoint3f, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f) |
Transform a 3d point of a source coordinate system into a 3d point of the target coordinate system. | |
static bool | calibration2dTo3d (const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f) |
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 3d point of the target coordinate system. | |
static bool | calibration2dTo3dUndistortion (const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint3f *targetPoint3f) |
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 3d point of the target coordinate system. | |
static bool | calibration3dTo2d (const OBCalibrationParam calibrationParam, const OBPoint3f sourcePoint3f, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint2f *targetPoint2f) |
Transform a 3d point of a source coordinate system into a 2d pixel coordinate of the target camera. | |
static bool | calibration2dTo2d (const OBCalibrationParam calibrationParam, const OBPoint2f sourcePoint2f, const float sourceDepthPixelValue, const OBSensorType sourceSensorType, const OBSensorType targetSensorType, OBPoint2f *targetPoint2f) |
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 2d pixel coordinate of the target camera. | |
static std::shared_ptr< ob::Frame > | transformationDepthFrameToColorCamera (std::shared_ptr< ob::Device > device, std::shared_ptr< ob::Frame > depthFrame, uint32_t targetColorCameraWidth, uint32_t targetColorCameraHeight) |
Transforms the depth frame into the geometry of the color camera. | |
static bool | transformationInitXYTables (const OBCalibrationParam calibrationParam, const OBSensorType sensorType, float *data, uint32_t *dataSize, OBXYTables *xyTables) |
Init transformation tables. | |
static void | transformationDepthToPointCloud (OBXYTables *xyTables, const void *depthImageData, void *pointCloudData) |
Transform depth image to point cloud data. | |
static void | transformationDepthToRGBDPointCloud (OBXYTables *xyTables, const void *depthImageData, const void *colorImageData, void *pointCloudData) |
Transform depth image to RGBD point cloud data. | |
+
|
+ +static | +
Transform a 3d point of a source coordinate system into a 3d point of the target coordinate system.
+calibrationParam | Device calibration param,see pipeline::getCalibrationParam |
sourcePoint3f | Source 3d point value |
sourceSensorType | Source sensor type |
targetSensorType | Target sensor type |
targetPoint3f | Target 3d point value |
+
|
+ +static | +
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 3d point of the target coordinate system.
+calibrationParam | Device calibration param,see pipeline::getCalibrationParam |
sourcePoint2f | Source 2d point value |
sourceDepthPixelValue | The depth of sourcePoint2f in millimeters |
sourceSensorType | Source sensor type |
targetSensorType | Target sensor type |
targetPoint3f | Target 3d point value |
+
|
+ +static | +
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 3d point of the target coordinate system.
+This function uses undistortion, which may result in longer processing time.
+calibrationParam | Device calibration param,see pipeline::getCalibrationParam |
sourcePoint2f | Source 2d point value |
sourceDepthPixelValue | The depth of sourcePoint2f in millimeters |
sourceSensorType | Source sensor type |
targetSensorType | Target sensor type |
targetPoint3f | Target 3d point value |
+
|
+ +static | +
Transform a 3d point of a source coordinate system into a 2d pixel coordinate of the target camera.
+calibrationParam | Device calibration param,see pipeline::getCalibrationParam |
sourcePoint3f | Source 3d point value |
sourceSensorType | Source sensor type |
targetSensorType | Target sensor type |
targetPoint2f | Target 2d point value |
+
|
+ +static | +
Transform a 2d pixel coordinate with an associated depth value of the source camera into a 2d pixel coordinate of the target camera.
+calibrationParam | Device calibration param,see pipeline::getCalibrationParam |
sourcePoint2f | Source 2d point value |
sourceDepthPixelValue | The depth of sourcePoint2f in millimeters |
sourceSensorType | Source sensor type |
targetSensorType | Target sensor type |
targetPoint2f | Target 2d point value |
+
|
+ +static | +
Transforms the depth frame into the geometry of the color camera.
+device | Device handle |
depthFrame | Input depth frame |
targetColorCameraWidth | Target color camera width |
targetColorCameraHeight | Target color camera height |
+
|
+ +static | +
Init transformation tables.
+calibrationParam | Device calibration param,see pipeline::getCalibrationParam |
sensorType | sensor type |
data | input data,needs to be allocated externally.During initialization, the external allocation size is 'dataSize', for example, dataSize = 1920 * 1080 * 2*sizeof(float) (1920 * 1080 represents the image resolution, and 2 represents two LUTs, one for x-coordinate and one for y-coordinate). |
dataSize | input data size |
xyTables | output xy tables |
+
|
+ +static | +
Transform depth image to point cloud data.
+xyTables | input xy tables,see CoordinateTransformHelper::transformationInitXYTables |
depthImageData | input depth image data |
pointCloudData | output point cloud data |
+
|
+ +static | +
Transform depth image to RGBD point cloud data.
+xyTables | input xy tables,see CoordinateTransformHelper::transformationInitXYTables |
depthImageData | input depth image data |
colorImageData | input color image data (only RGB888 support) |
pointCloudData | output RGBD point cloud data |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::DecimationFilter, including all inherited members.
+as() | ob::Filter | inline |
DecimationFilter() | ob::DecimationFilter | |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getScaleRange() | ob::DecimationFilter | |
getScaleValue() | ob::DecimationFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setScaleValue(uint8_t value) | ob::DecimationFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Decimation filter,reducing complexity by subsampling depth maps and losing depth details. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
DecimationFilter () | |
void | setScaleValue (uint8_t value) |
Set the decimation filter scale value. | |
uint8_t | getScaleValue () |
Get the decimation filter scale value. | |
OBUint8PropertyRange | getScaleRange () |
Get the property range of the decimation filter scale value. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
Decimation filter,reducing complexity by subsampling depth maps and losing depth details.
+ +Definition at line 522 of file Filter.hpp.
+ob::DecimationFilter::DecimationFilter | +( | +) | ++ |
void ob::DecimationFilter::setScaleValue | +( | +uint8_t | +value | ) | ++ |
Set the decimation filter scale value.
+type | The decimation filter scale value. |
uint8_t ob::DecimationFilter::getScaleValue | +( | +) | ++ |
Get the decimation filter scale value.
+ +OBUint8PropertyRange ob::DecimationFilter::getScaleRange | +( | +) | ++ |
Get the property range of the decimation filter scale value.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::DecompressionFilter, including all inherited members.
+as() | ob::Filter | inline |
DecompressionFilter() | ob::DecompressionFilter | |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The DecompressionFilter class is a subclass of Filter that performs decompression. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
DecompressionFilter () | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
The DecompressionFilter class is a subclass of Filter that performs decompression.
+ +Definition at line 196 of file Filter.hpp.
+ob::DecompressionFilter::DecompressionFilter | +( | +) | ++ |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::DepthFrame, including all inherited members.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Frame.hpp>
+Public Member Functions | |
DepthFrame (Frame &frame) | |
DepthFrame (std::unique_ptr< FrameImpl > impl) | |
~DepthFrame () noexcept override=default | |
float | getValueScale () |
Get the value scale of the depth frame. The pixel value of depth frame is multiplied by the scale to give a depth value in millimeters. For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValue*valueScale = 10000*0.1=1000mm. | |
Public Member Functions inherited from ob::VideoFrame | |
VideoFrame (Frame &frame) | |
VideoFrame (std::unique_ptr< FrameImpl > impl) | |
~VideoFrame () noexcept override=default | |
uint32_t | width () |
Get the width of the frame. | |
uint32_t | height () |
Get the height of the frame. | |
uint8_t | pixelAvailableBitSize () |
Get the effective number of pixels in the frame. | |
Public Member Functions inherited from ob::Frame | |
Frame (std::unique_ptr< FrameImpl > impl) | |
Frame (Frame &frame) | |
virtual | ~Frame () noexcept |
virtual OBFrameType | type () |
Get the type of frame. | |
virtual OBFormat | format () |
Get the format of the frame. | |
virtual uint64_t | index () |
Get the sequence number of the frame. | |
virtual void * | data () |
Get the frame data. | |
virtual uint32_t | dataSize () |
Get the size of the frame data. | |
uint64_t | timeStamp () |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | timeStampUs () |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | systemTimeStamp () |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | systemTimeStampUs () |
Get the system timestamp of the frame in microseconds. | |
uint64_t | globalTimeStampUs () |
Get the global timestamp of the frame in microseconds. | |
void * | metadata () |
Get the metadata of the frame. | |
uint32_t | metadataSize () |
Get the size of the metadata of the frame. | |
bool | hasMetadata (OBFrameMetadataType type) |
Check if the frame object has metadata of a given type. | |
int64_t | getMetadataValue (OBFrameMetadataType type) |
Get the metadata value. | |
std::shared_ptr< StreamProfile > | getStreamProfile () |
get StreamProfile of the frame | |
std::shared_ptr< Sensor > | getSensor () |
get owner sensor of the frame | |
std::shared_ptr< Device > | getDevice () |
get owner device of the frame | |
template<typename T > | |
bool | is () |
Check if the runtime type of the frame object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the frame object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Frame | |
std::unique_ptr< FrameImpl > | impl_ |
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridedefaultnoexcept | +
float ob::DepthFrame::getValueScale | +( | +) | ++ |
Get the value scale of the depth frame. The pixel value of depth frame is multiplied by the scale to give a depth value in millimeters. For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValue*valueScale = 10000*0.1=1000mm.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Device, including all inherited members.
+activateAuthorization(const char *authCode) | ob::Device | |
CoordinateTransformHelper | ob::Device | friend |
Device(Device &&device) | ob::Device | protected |
Device(std::unique_ptr< DeviceImpl > impl) | ob::Device | |
deviceUpgrade(const char *filePath, DeviceUpgradeCallback callback, bool async=true) | ob::Device | |
deviceUpgradeFromData(const char *fileData, uint32_t fileSize, DeviceUpgradeCallback callback, bool async=true) | ob::Device | |
exportSettingsAsPresetJsonData(const char *presetName, const uint8_t **data, uint32_t *dataSize) | ob::Device | |
exportSettingsAsPresetJsonFile(const char *filePath) | ob::Device | |
getAvailablePresetList() | ob::Device | |
getBoolProperty(OBPropertyID propertyId) | ob::Device | |
getBoolPropertyRange(OBPropertyID propertyId) | ob::Device | |
getCalibrationCameraParamList() | ob::Device | |
getCmdVersion(OBPropertyID propertyId) | ob::Device | |
getCurrentDepthModeName() | ob::Device | |
getCurrentDepthWorkMode() | ob::Device | |
getCurrentPresetName() | ob::Device | |
getDepthWorkModeList() | ob::Device | |
getDeviceInfo() | ob::Device | |
getDeviceState() | ob::Device | |
getFloatProperty(OBPropertyID propertyId) | ob::Device | |
getFloatPropertyRange(OBPropertyID propertyId) | ob::Device | |
getIntProperty(OBPropertyID propertyId) | ob::Device | |
getIntPropertyRange(OBPropertyID propertyId) | ob::Device | |
getMultiDeviceSyncConfig() | ob::Device | |
getProtocolVersion() | ob::Device | |
getRawData(OBPropertyID propertyId, GetDataCallback callback, bool async=false) | ob::Device | |
getSensor(OBSensorType type) | ob::Device | |
getSensorList() | ob::Device | |
getStructuredData(OBPropertyID propertyId, void *data, uint32_t *dataSize) | ob::Device | |
getStructuredDataExt(OBPropertyID propertyId) | ob::Device | |
getSupportedMultiDeviceSyncModeBitmap() | ob::Device | |
getSupportedProperty(uint32_t index) | ob::Device | |
getSupportedPropertyCount() | ob::Device | |
getSyncConfig() | ob::Device | |
getTimestampResetConfig() | ob::Device | |
impl_ | ob::Device | protected |
isGlobalTimestampSupported() | ob::Device | |
isPropertySupported(OBPropertyID propertyId, OBPermissionType permission) | ob::Device | |
loadDepthFilterConfig(const char *filePath) | ob::Device | |
loadPreset(const char *presetName) | ob::Device | |
loadPresetFromJsonData(const char *presetName, const uint8_t *data, uint32_t size) | ob::Device | |
loadPresetFromJsonFile(const char *filePath) | ob::Device | |
Pipeline | ob::Device | friend |
readAHB(uint32_t reg, uint32_t mask, uint32_t *value) | ob::Device | |
readCustomerData(void *data, uint32_t *dataSize) | ob::Device | |
readFlash(uint32_t offset, uint32_t dataSize, GetDataCallback callback, bool async=false) | ob::Device | |
readI2C(uint32_t moduleId, uint32_t reg, uint32_t mask, uint32_t *value) | ob::Device | |
reboot() | ob::Device | |
reboot(uint32_t delayMs) | ob::Device | |
Recorder | ob::Device | friend |
resetDefaultDepthFilterConfig() | ob::Device | |
sendFile(const char *filePath, const char *dstPath, SendFileCallback callback, bool async=true) | ob::Device | |
setBoolProperty(OBPropertyID propertyId, bool property) | ob::Device | |
setDeviceStateChangedCallback(DeviceStateChangedCallback callback) | ob::Device | |
setFloatProperty(OBPropertyID propertyId, float property) | ob::Device | |
setIntProperty(OBPropertyID propertyId, int32_t property) | ob::Device | |
setMultiDeviceSyncConfig(const OBMultiDeviceSyncConfig &config) | ob::Device | |
setRawData(OBPropertyID propertyId, const void *data, uint32_t dataSize, SetDataCallback callback, bool async=false) | ob::Device | |
setStructuredData(OBPropertyID propertyId, const void *data, uint32_t dataSize) | ob::Device | |
setStructuredDataExt(OBPropertyID propertyId, std::shared_ptr< OBDataBundle > dataBundle, SetDataCallback callback) | ob::Device | |
setSyncConfig(const OBDeviceSyncConfig &deviceSyncConfig) | ob::Device | |
setTimestampResetConfig(const OBDeviceTimestampResetConfig &config) | ob::Device | |
switchDepthWorkMode(const OBDepthWorkMode &workMode) | ob::Device | |
switchDepthWorkMode(const char *modeName) | ob::Device | |
syncDeviceTime() | ob::Device | |
timerSyncWithHost() | ob::Device | |
timestampReset() | ob::Device | |
triggerCapture() | ob::Device | |
writeAHB(uint32_t reg, uint32_t mask, uint32_t value) | ob::Device | |
writeAuthorizationCode(const char *authCodeStr) | ob::Device | |
writeCustomerData(const void *data, uint32_t dataSize) | ob::Device | |
writeFlash(uint32_t offset, const void *data, uint32_t dataSize, SetDataCallback callback, bool async=false) | ob::Device | |
writeI2C(uint32_t moduleId, uint32_t reg, uint32_t mask, uint32_t value) | ob::Device | |
~Device() noexcept | ob::Device | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Device.hpp>
+Public Member Functions | |
Device (std::unique_ptr< DeviceImpl > impl) | |
Describe the entity of the RGBD camera, representing a specific model of RGBD camera. | |
virtual | ~Device () noexcept |
std::shared_ptr< DeviceInfo > | getDeviceInfo () |
Get device information. | |
std::shared_ptr< SensorList > | getSensorList () |
Get device sensor list. | |
std::shared_ptr< Sensor > | getSensor (OBSensorType type) |
Get specific type of sensor if device not open, SDK will automatically open the connected device and return to the instance. | |
void | setIntProperty (OBPropertyID propertyId, int32_t property) |
Set int type of device property. | |
void | setFloatProperty (OBPropertyID propertyId, float property) |
Set float type of device property. | |
void | setBoolProperty (OBPropertyID propertyId, bool property) |
Set bool type of device property. | |
int32_t | getIntProperty (OBPropertyID propertyId) |
Get int type of device property. | |
float | getFloatProperty (OBPropertyID propertyId) |
Get float type of device property. | |
bool | getBoolProperty (OBPropertyID propertyId) |
Get bool type of device property. | |
OBIntPropertyRange | getIntPropertyRange (OBPropertyID propertyId) |
Get int type device property range (including current value and default value) | |
OBFloatPropertyRange | getFloatPropertyRange (OBPropertyID propertyId) |
Get float type device property range((including current value and default value) | |
OBBoolPropertyRange | getBoolPropertyRange (OBPropertyID propertyId) |
Get bool type device property range (including current value and default value) | |
void | writeAHB (uint32_t reg, uint32_t mask, uint32_t value) |
Write to an AHB register. | |
void | readAHB (uint32_t reg, uint32_t mask, uint32_t *value) |
Read from an AHB register. | |
void | writeI2C (uint32_t moduleId, uint32_t reg, uint32_t mask, uint32_t value) |
Write to an I2C register. | |
void | readI2C (uint32_t moduleId, uint32_t reg, uint32_t mask, uint32_t *value) |
Read from an I2C register. | |
void | writeFlash (uint32_t offset, const void *data, uint32_t dataSize, SetDataCallback callback, bool async=false) |
Set the properties for writing to Flash. | |
void | readFlash (uint32_t offset, uint32_t dataSize, GetDataCallback callback, bool async=false) |
Read a property from Flash. | |
void | writeCustomerData (const void *data, uint32_t dataSize) |
Set the customer data type of a device property. | |
void | readCustomerData (void *data, uint32_t *dataSize) |
Get the customer data type of a device property. | |
void | setRawData (OBPropertyID propertyId, const void *data, uint32_t dataSize, SetDataCallback callback, bool async=false) |
Set the raw data type of a device property (with asynchronous callback) | |
void | getRawData (OBPropertyID propertyId, GetDataCallback callback, bool async=false) |
Get the raw data type of a device property (with asynchronous callback) | |
void | setStructuredData (OBPropertyID propertyId, const void *data, uint32_t dataSize) |
Set the structured data type of a device property. | |
void | getStructuredData (OBPropertyID propertyId, void *data, uint32_t *dataSize) |
Get the structured data type of a device property. | |
void | setStructuredDataExt (OBPropertyID propertyId, std::shared_ptr< OBDataBundle > dataBundle, SetDataCallback callback) |
Set the structured data type of a device property (with extended data bundle) | |
std::shared_ptr< OBDataBundle > | getStructuredDataExt (OBPropertyID propertyId) |
Get the structured data type of a device property (with extended data bundle) | |
OBProtocolVersion | getProtocolVersion () |
Get the property protocol version. | |
OBCmdVersion | getCmdVersion (OBPropertyID propertyId) |
Get the cmdVersion of a property. | |
uint32_t | getSupportedPropertyCount () |
Get the number of properties supported by the device. | |
OBPropertyItem | getSupportedProperty (uint32_t index) |
Get the supported properties of the device. | |
bool | isPropertySupported (OBPropertyID propertyId, OBPermissionType permission) |
Check if a property permission is supported. | |
bool | isGlobalTimestampSupported () |
Check if the global timestamp is supported for the device. | |
void | deviceUpgrade (const char *filePath, DeviceUpgradeCallback callback, bool async=true) |
Upgrade the device firmware. | |
void | deviceUpgradeFromData (const char *fileData, uint32_t fileSize, DeviceUpgradeCallback callback, bool async=true) |
void | sendFile (const char *filePath, const char *dstPath, SendFileCallback callback, bool async=true) |
Send files to the specified path on the device side [Asynchronouscallback]. | |
OBDeviceState | getDeviceState () |
Get the current state. | |
void | setDeviceStateChangedCallback (DeviceStateChangedCallback callback) |
Set the device state changed callbacks. | |
bool | activateAuthorization (const char *authCode) |
Verify device authorization code. | |
void | writeAuthorizationCode (const char *authCodeStr) |
Write authorization code. | |
std::shared_ptr< CameraParamList > | getCalibrationCameraParamList () |
Get the original parameter list of camera calibration saved in the device. | |
OBDepthWorkMode | getCurrentDepthWorkMode () |
Get current depth work mode. | |
OBStatus | switchDepthWorkMode (const OBDepthWorkMode &workMode) |
Switch depth work mode by OBDepthWorkMode. Prefer invoke switchDepthWorkMode(const char *modeName) to switch depth mode when known the complete name of depth work mode. | |
OBStatus | switchDepthWorkMode (const char *modeName) |
Switch depth work mode by work mode name. | |
std::shared_ptr< OBDepthWorkModeList > | getDepthWorkModeList () |
Request support depth work mode list. | |
void | reboot () |
Device restart. | |
void | reboot (uint32_t delayMs) |
Device restart delay mode. | |
DEPRECATED uint64_t | syncDeviceTime () |
Synchronize the device time (synchronize local system time to device) | |
DEPRECATED OBDeviceSyncConfig | getSyncConfig () |
get the current device synchronization configuration | |
DEPRECATED void | setSyncConfig (const OBDeviceSyncConfig &deviceSyncConfig) |
Set the device synchronization configuration. | |
uint16_t | getSupportedMultiDeviceSyncModeBitmap () |
Get the supported multi device sync mode bitmap of the device. | |
void | setMultiDeviceSyncConfig (const OBMultiDeviceSyncConfig &config) |
set the multi device sync configuration of the device. | |
OBMultiDeviceSyncConfig | getMultiDeviceSyncConfig () |
get the multi device sync configuration of the device. | |
void | triggerCapture () |
send the capture command to the device. | |
void | setTimestampResetConfig (const OBDeviceTimestampResetConfig &config) |
set the timestamp reset configuration of the device. | |
OBDeviceTimestampResetConfig | getTimestampResetConfig () |
get the timestamp reset configuration of the device. | |
void | timestampReset () |
send the timestamp reset command to the device. | |
void | timerSyncWithHost () |
synchronize the timer of the device with the host. | |
void | loadDepthFilterConfig (const char *filePath) |
Load depth filter config from file. | |
void | resetDefaultDepthFilterConfig () |
Reset depth filter config to device default define. | |
const char * | getCurrentPresetName () |
Get current preset name. | |
const char * | getCurrentDepthModeName () |
Get current depth mode name. | |
void | loadPreset (const char *presetName) |
load the preset according to the preset name. | |
std::shared_ptr< DevicePresetList > | getAvailablePresetList () |
Get available preset list. | |
void | loadPresetFromJsonFile (const char *filePath) |
Load custom preset from file. | |
void | loadPresetFromJsonData (const char *presetName, const uint8_t *data, uint32_t size) |
Load custom preset from data. | |
void | exportSettingsAsPresetJsonFile (const char *filePath) |
Export current device settings as a preset json file. | |
void | exportSettingsAsPresetJsonData (const char *presetName, const uint8_t **data, uint32_t *dataSize) |
Export current device settings as a preset json data. | |
+Protected Member Functions | |
Device (Device &&device) | |
+Protected Attributes | |
std::unique_ptr< DeviceImpl > | impl_ |
+Friends | |
class | Pipeline |
class | Recorder |
class | CoordinateTransformHelper |
Definition at line 29 of file Device.hpp.
+
+
|
+ +protected | +
ob::Device::Device | +( | +std::unique_ptr< DeviceImpl > | +impl | ) | ++ |
Describe the entity of the RGBD camera, representing a specific model of RGBD camera.
+ +
+
|
+ +virtualnoexcept | +
std::shared_ptr< DeviceInfo > ob::Device::getDeviceInfo | +( | +) | ++ |
Get device information.
+std::shared_ptr< SensorList > ob::Device::getSensorList | +( | +) | ++ |
Get device sensor list.
+std::shared_ptr< Sensor > ob::Device::getSensor | +( | +OBSensorType | +type | ) | ++ |
Get specific type of sensor if device not open, SDK will automatically open the connected device and return to the instance.
+void ob::Device::setIntProperty | +( | +OBPropertyID | +propertyId, | +
+ | + | int32_t | +property | +
+ | ) | ++ |
Set int type of device property.
+propertyId | Property id |
property | Property to be set |
void ob::Device::setFloatProperty | +( | +OBPropertyID | +propertyId, | +
+ | + | float | +property | +
+ | ) | ++ |
Set float type of device property.
+propertyId | Property id |
property | Property to be set |
void ob::Device::setBoolProperty | +( | +OBPropertyID | +propertyId, | +
+ | + | bool | +property | +
+ | ) | ++ |
Set bool type of device property.
+propertyId | Property id |
property | Property to be set |
int32_t ob::Device::getIntProperty | +( | +OBPropertyID | +propertyId | ) | ++ |
Get int type of device property.
+propertyId | Property id |
float ob::Device::getFloatProperty | +( | +OBPropertyID | +propertyId | ) | ++ |
Get float type of device property.
+propertyId | Property id |
bool ob::Device::getBoolProperty | +( | +OBPropertyID | +propertyId | ) | ++ |
Get bool type of device property.
+propertyId | Property id |
OBIntPropertyRange ob::Device::getIntPropertyRange | +( | +OBPropertyID | +propertyId | ) | ++ |
Get int type device property range (including current value and default value)
+propertyId | Property id |
OBFloatPropertyRange ob::Device::getFloatPropertyRange | +( | +OBPropertyID | +propertyId | ) | ++ |
Get float type device property range((including current value and default value)
+propertyId | Property id |
OBBoolPropertyRange ob::Device::getBoolPropertyRange | +( | +OBPropertyID | +propertyId | ) | ++ |
Get bool type device property range (including current value and default value)
+propertyId | The ID of the property |
void ob::Device::writeAHB | +( | +uint32_t | +reg, | +
+ | + | uint32_t | +mask, | +
+ | + | uint32_t | +value | +
+ | ) | ++ |
Write to an AHB register.
+reg | The register to write to |
mask | The mask to apply |
value | The value to write |
void ob::Device::readAHB | +( | +uint32_t | +reg, | +
+ | + | uint32_t | +mask, | +
+ | + | uint32_t * | +value | +
+ | ) | ++ |
Read from an AHB register.
+reg | The register to read from |
mask | The mask to apply |
value | The value to return |
void ob::Device::writeI2C | +( | +uint32_t | +moduleId, | +
+ | + | uint32_t | +reg, | +
+ | + | uint32_t | +mask, | +
+ | + | uint32_t | +value | +
+ | ) | ++ |
Write to an I2C register.
+moduleId | The ID of the I2C module to write to |
reg | The register to write to |
mask | The mask to apply |
value | The value to write |
void ob::Device::readI2C | +( | +uint32_t | +moduleId, | +
+ | + | uint32_t | +reg, | +
+ | + | uint32_t | +mask, | +
+ | + | uint32_t * | +value | +
+ | ) | ++ |
Read from an I2C register.
+moduleId | The ID of the I2C module to read from |
reg | The register to read from |
mask | The mask to apply |
value | The value to return |
void ob::Device::writeFlash | +( | +uint32_t | +offset, | +
+ | + | const void * | +data, | +
+ | + | uint32_t | +dataSize, | +
+ | + | SetDataCallback | +callback, | +
+ | + | bool | +async = false |
+
+ | ) | ++ |
Set the properties for writing to Flash.
+offset | The offset address in Flash |
data | The data to write |
dataSize | The size of the data to write |
callback | The callback for write progress |
async | Whether to execute asynchronously |
void ob::Device::readFlash | +( | +uint32_t | +offset, | +
+ | + | uint32_t | +dataSize, | +
+ | + | GetDataCallback | +callback, | +
+ | + | bool | +async = false |
+
+ | ) | ++ |
Read a property from Flash.
+offset | The offset address in Flash |
dataSize | The size of the property to read |
callback | The callback for read progress and data |
async | Whether to execute asynchronously |
void ob::Device::writeCustomerData | +( | +const void * | +data, | +
+ | + | uint32_t | +dataSize | +
+ | ) | ++ |
Set the customer data type of a device property.
+data | The data to set |
dataSize | The size of the data to set,the maximum length cannot exceed 65532 bytes. |
void ob::Device::readCustomerData | +( | +void * | +data, | +
+ | + | uint32_t * | +dataSize | +
+ | ) | ++ |
Get the customer data type of a device property.
+data | The property data obtained |
dataSize | The size of the data obtained |
void ob::Device::setRawData | +( | +OBPropertyID | +propertyId, | +
+ | + | const void * | +data, | +
+ | + | uint32_t | +dataSize, | +
+ | + | SetDataCallback | +callback, | +
+ | + | bool | +async = false |
+
+ | ) | ++ |
Set the raw data type of a device property (with asynchronous callback)
+propertyId | The ID of the property |
data | The data to set |
dataSize | The size of the data to set |
callback | The callback for set progress |
async | Whether to execute asynchronously |
void ob::Device::getRawData | +( | +OBPropertyID | +propertyId, | +
+ | + | GetDataCallback | +callback, | +
+ | + | bool | +async = false |
+
+ | ) | ++ |
Get the raw data type of a device property (with asynchronous callback)
+propertyId | The ID of the property |
callback | The callback for getting the data and progress |
async | Whether to execute asynchronously |
void ob::Device::setStructuredData | +( | +OBPropertyID | +propertyId, | +
+ | + | const void * | +data, | +
+ | + | uint32_t | +dataSize | +
+ | ) | ++ |
Set the structured data type of a device property.
+propertyId | The ID of the property |
data | The data to set |
dataSize | The size of the data to set |
void ob::Device::getStructuredData | +( | +OBPropertyID | +propertyId, | +
+ | + | void * | +data, | +
+ | + | uint32_t * | +dataSize | +
+ | ) | ++ |
Get the structured data type of a device property.
+propertyId | The ID of the property |
data | The property data obtained |
dataSize | The size of the data obtained |
void ob::Device::setStructuredDataExt | +( | +OBPropertyID | +propertyId, | +
+ | + | std::shared_ptr< OBDataBundle > | +dataBundle, | +
+ | + | SetDataCallback | +callback | +
+ | ) | ++ |
Set the structured data type of a device property (with extended data bundle)
+propertyId | The ID of the property |
dataBundle | The target data bundle |
callback | The callback for setting |
std::shared_ptr< OBDataBundle > ob::Device::getStructuredDataExt | +( | +OBPropertyID | +propertyId | ) | ++ |
Get the structured data type of a device property (with extended data bundle)
+propertyId | The ID of the property |
OBProtocolVersion ob::Device::getProtocolVersion | +( | +) | ++ |
Get the property protocol version.
+OBCmdVersion ob::Device::getCmdVersion | +( | +OBPropertyID | +propertyId | ) | ++ |
Get the cmdVersion of a property.
+propertyId | The ID of the property |
uint32_t ob::Device::getSupportedPropertyCount | +( | +) | ++ |
Get the number of properties supported by the device.
+OBPropertyItem ob::Device::getSupportedProperty | +( | +uint32_t | +index | ) | ++ |
Get the supported properties of the device.
+index | The index of the property |
bool ob::Device::isPropertySupported | +( | +OBPropertyID | +propertyId, | +
+ | + | OBPermissionType | +permission | +
+ | ) | ++ |
Check if a property permission is supported.
+propertyId | The ID of the property |
permission | The read and write permissions to check |
bool ob::Device::isGlobalTimestampSupported | +( | +) | ++ |
Check if the global timestamp is supported for the device.
+void ob::Device::deviceUpgrade | +( | +const char * | +filePath, | +
+ | + | DeviceUpgradeCallback | +callback, | +
+ | + | bool | +async = true |
+
+ | ) | ++ |
Upgrade the device firmware.
+filePath | Firmware path |
callback | Firmware upgrade progress and status callback |
async | Whether to execute asynchronously |
void ob::Device::deviceUpgradeFromData | +( | +const char * | +fileData, | +
+ | + | uint32_t | +fileSize, | +
+ | + | DeviceUpgradeCallback | +callback, | +
+ | + | bool | +async = true |
+
+ | ) | ++ |
void ob::Device::sendFile | +( | +const char * | +filePath, | +
+ | + | const char * | +dstPath, | +
+ | + | SendFileCallback | +callback, | +
+ | + | bool | +async = true |
+
+ | ) | ++ |
Send files to the specified path on the device side [Asynchronouscallback].
+filePath | Original file path |
dstPath | Accept the save path on the device side |
callback | File transfer callback |
async | Whether to execute asynchronously |
OBDeviceState ob::Device::getDeviceState | +( | +) | ++ |
Get the current state.
+void ob::Device::setDeviceStateChangedCallback | +( | +DeviceStateChangedCallback | +callback | ) | ++ |
Set the device state changed callbacks.
+callback | The callback function that is triggered when the device status changes (for example, the frame rate is automatically reduced or the stream is closed due to high temperature, etc.) |
bool ob::Device::activateAuthorization | +( | +const char * | +authCode | ) | ++ |
Verify device authorization code.
+authCode | Authorization code |
void ob::Device::writeAuthorizationCode | +( | +const char * | +authCodeStr | ) | ++ |
Write authorization code.
+[in] | authCodeStr | Authorization code |
std::shared_ptr< CameraParamList > ob::Device::getCalibrationCameraParamList | +( | +) | ++ |
Get the original parameter list of camera calibration saved in the device.
+OBDepthWorkMode ob::Device::getCurrentDepthWorkMode | +( | +) | ++ |
Get current depth work mode.
+OBStatus ob::Device::switchDepthWorkMode | +( | +const OBDepthWorkMode & | +workMode | ) | ++ |
Switch depth work mode by OBDepthWorkMode. Prefer invoke switchDepthWorkMode(const char *modeName) to switch depth mode when known the complete name of depth work mode.
+[in] | workMode | Depth work mode come from ob_depth_work_mode_list which return by ob_device_get_depth_work_mode_list |
OBStatus ob::Device::switchDepthWorkMode | +( | +const char * | +modeName | ) | ++ |
Switch depth work mode by work mode name.
+[in] | modeName | Depth work mode name which equals to OBDepthWorkMode.name |
std::shared_ptr< OBDepthWorkModeList > ob::Device::getDepthWorkModeList | +( | +) | ++ |
Request support depth work mode list.
+void ob::Device::reboot | +( | +) | ++ |
void ob::Device::reboot | +( | +uint32_t | +delayMs | ) | ++ |
Device restart delay mode.
+[in] | delayMs | Time unit:ms。delayMs == 0:No delay;delayMs > 0, Delay millisecond connect to host device after reboot |
DEPRECATED uint64_t ob::Device::syncDeviceTime | +( | +) | ++ |
Synchronize the device time (synchronize local system time to device)
+DEPRECATED OBDeviceSyncConfig ob::Device::getSyncConfig | +( | +) | ++ |
get the current device synchronization configuration
+Device synchronization: including exposure synchronization function and multi-camera synchronization function of different sensors within a single machine
+DEPRECATED void ob::Device::setSyncConfig | +( | +const OBDeviceSyncConfig & | +deviceSyncConfig | ) | ++ |
Set the device synchronization configuration.
+Used to configure the exposure synchronization function and multi-camera synchronization function of different sensors in a single machine
+deviceSyncConfig | Device synchronization configuration |
uint16_t ob::Device::getSupportedMultiDeviceSyncModeBitmap | +( | +) | ++ |
Get the supported multi device sync mode bitmap of the device.
+For example, if the return value is 0b00001100, it means the device supports OB_MULTI_DEVICE_SYNC_MODE_PRIMARY and OB_MULTI_DEVICE_SYNC_MODE_SECONDARY. User can check the supported mode by the code:
void ob::Device::setMultiDeviceSyncConfig | +( | +const OBMultiDeviceSyncConfig & | +config | ) | ++ |
set the multi device sync configuration of the device.
+[in] | config | The multi device sync configuration. |
OBMultiDeviceSyncConfig ob::Device::getMultiDeviceSyncConfig | +( | +) | ++ |
get the multi device sync configuration of the device.
+void ob::Device::triggerCapture | +( | +) | ++ |
send the capture command to the device.
+The device will start one time image capture after receiving the capture command when it is in the OB_MULTI_DEVICE_SYNC_MODE_SOFTWARE_TRIGGERING
+void ob::Device::setTimestampResetConfig | +( | +const OBDeviceTimestampResetConfig & | +config | ) | ++ |
set the timestamp reset configuration of the device.
+ +OBDeviceTimestampResetConfig ob::Device::getTimestampResetConfig | +( | +) | ++ |
get the timestamp reset configuration of the device.
+void ob::Device::timestampReset | +( | +) | ++ |
send the timestamp reset command to the device.
+The device will reset the timer for calculating the timestamp for output frames to 0 after receiving the timestamp reset command when the timestamp reset function is enabled. The timestamp reset function can be enabled by call ob_device_set_timestamp_reset_config.
+Before calling this function, user should call ob_device_set_timestamp_reset_config to disable the timestamp reset function (It is not required for some models, but it is still recommended to do so for code compatibility).
+void ob::Device::timerSyncWithHost | +( | +) | ++ |
synchronize the timer of the device with the host.
+After calling this function, the timer of the device will be synchronized with the host. User can call this function to multiple devices to synchronize all timers of the devices.
+void ob::Device::loadDepthFilterConfig | +( | +const char * | +filePath | ) | ++ |
Load depth filter config from file.
+filePath | Path of the config file. |
void ob::Device::resetDefaultDepthFilterConfig | +( | +) | ++ |
Reset depth filter config to device default define.
+ +const char * ob::Device::getCurrentPresetName | +( | +) | ++ |
Get current preset name.
+The preset mean a set of parameters or configurations that can be applied to the device to achieve a specific effect or function.
const char * ob::Device::getCurrentDepthModeName | +( | +) | ++ |
Get current depth mode name.
+According the current preset name to return current depth mode name
void ob::Device::loadPreset | +( | +const char * | +presetName | ) | ++ |
load the preset according to the preset name.
+presetName | The preset name to set. The name should be one of the preset names returned by getAvailablePresetList. |
std::shared_ptr< DevicePresetList > ob::Device::getAvailablePresetList | +( | +) | ++ |
Get available preset list.
+The available preset list usually defined by the device manufacturer and restores on the device.
+User can load the custom preset by calling loadPresetFromJsonFile to append the available preset list.
+void ob::Device::loadPresetFromJsonFile | +( | +const char * | +filePath | ) | ++ |
Load custom preset from file.
+After loading the custom preset, the settings in the custom preset will set to the device immediately.
+After loading the custom preset, the available preset list will be appended with the custom preset and named as the file name.
+filePath | The path of the custom preset file. |
void ob::Device::loadPresetFromJsonData | +( | +const char * | +presetName, | +
+ | + | const uint8_t * | +data, | +
+ | + | uint32_t | +size | +
+ | ) | ++ |
Load custom preset from data.
+After loading the custom preset, the settings in the custom preset will set to the device immediately.
+After loading the custom preset, the available preset list will be appended with the custom preset and named as the presetName.
+data | The custom preset data. |
size | The size of the custom preset data. |
void ob::Device::exportSettingsAsPresetJsonFile | +( | +const char * | +filePath | ) | ++ |
Export current device settings as a preset json file.
+The exported preset file can be loaded by calling loadPresetFromJsonFile to restore the device setting.
+After exporting the preset, a new preset named as the filePath will be added to the available preset list.
+filePath | The path of the preset file to be exported. |
void ob::Device::exportSettingsAsPresetJsonData | +( | +const char * | +presetName, | +
+ | + | const uint8_t ** | +data, | +
+ | + | uint32_t * | +dataSize | +
+ | ) | ++ |
Export current device settings as a preset json data.
+After exporting the preset, a new preset named as the presetName will be added to the available preset list.
+[out] | data | return the preset json data. |
[out] | dataSize | return the size of the preset json data. |
+
|
+ +friend | +
Definition at line 632 of file Device.hpp.
+ +
+
|
+ +friend | +
Definition at line 633 of file Device.hpp.
+ +
+
|
+ +friend | +
Definition at line 634 of file Device.hpp.
+ +
+
|
+ +protected | +
Definition at line 31 of file Device.hpp.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::DeviceInfo, including all inherited members.
+asicName() | ob::DeviceInfo | |
connectionType() | ob::DeviceInfo | |
Context | ob::DeviceInfo | friend |
DeviceInfo(std::unique_ptr< DeviceInfoImpl > impl) | ob::DeviceInfo | |
DeviceList | ob::DeviceInfo | friend |
deviceType() | ob::DeviceInfo | |
extensionInfo() | ob::DeviceInfo | |
firmwareVersion() | ob::DeviceInfo | |
hardwareVersion() | ob::DeviceInfo | |
ipAddress() | ob::DeviceInfo | |
name() | ob::DeviceInfo | |
pid() | ob::DeviceInfo | |
Pipeline | ob::DeviceInfo | friend |
serialNumber() | ob::DeviceInfo | |
supportedMinSdkVersion() | ob::DeviceInfo | |
uid() | ob::DeviceInfo | |
usbType() | ob::DeviceInfo | |
vid() | ob::DeviceInfo | |
~DeviceInfo() noexcept | ob::DeviceInfo | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
A class describing device information, representing the name, id, serial number and other basic information of an RGBD camera. + More...
+ +#include <Device.hpp>
+Public Member Functions | |
DeviceInfo (std::unique_ptr< DeviceInfoImpl > impl) | |
virtual | ~DeviceInfo () noexcept |
const char * | name () |
Get device name. | |
int | pid () |
Get the pid of the device. | |
int | vid () |
Get the vid of the device. | |
const char * | uid () |
Get system assigned uid for distinguishing between different devices. | |
const char * | serialNumber () |
Get the serial number of the device. | |
const char * | firmwareVersion () |
Get the version number of the firmware. | |
DEPRECATED const char * | usbType () |
Get the USB connection type of the device (DEPRECATED) | |
const char * | connectionType () |
Get the connection type of the device. | |
const char * | ipAddress () |
Get the IP address of the device. | |
const char * | hardwareVersion () |
Get the version number of the hardware. | |
const char * | supportedMinSdkVersion () |
Get the minimum version number of the SDK supported by the device. | |
const char * | extensionInfo () |
Get information about extensions obtained from SDK supported by the device. | |
const char * | asicName () |
Get chip type name. | |
OBDeviceType | deviceType () |
Get the device type. | |
+Friends | |
class | Context |
class | DeviceList |
class | Pipeline |
A class describing device information, representing the name, id, serial number and other basic information of an RGBD camera.
+ +Definition at line 640 of file Device.hpp.
+ob::DeviceInfo::DeviceInfo | +( | +std::unique_ptr< DeviceInfoImpl > | +impl | ) | ++ |
+
|
+ +virtualnoexcept | +
const char * ob::DeviceInfo::name | +( | +) | ++ |
Get device name.
+int ob::DeviceInfo::pid | +( | +) | ++ |
Get the pid of the device.
+int ob::DeviceInfo::vid | +( | +) | ++ |
Get the vid of the device.
+const char * ob::DeviceInfo::uid | +( | +) | ++ |
Get system assigned uid for distinguishing between different devices.
+const char * ob::DeviceInfo::serialNumber | +( | +) | ++ |
Get the serial number of the device.
+const char * ob::DeviceInfo::firmwareVersion | +( | +) | ++ |
Get the version number of the firmware.
+DEPRECATED const char * ob::DeviceInfo::usbType | +( | +) | ++ |
Get the USB connection type of the device (DEPRECATED)
+const char * ob::DeviceInfo::connectionType | +( | +) | ++ |
Get the connection type of the device.
+const char * ob::DeviceInfo::ipAddress | +( | +) | ++ |
Get the IP address of the device.
+const char * ob::DeviceInfo::hardwareVersion | +( | +) | ++ |
Get the version number of the hardware.
+const char * ob::DeviceInfo::supportedMinSdkVersion | +( | +) | ++ |
Get the minimum version number of the SDK supported by the device.
+const char * ob::DeviceInfo::extensionInfo | +( | +) | ++ |
Get information about extensions obtained from SDK supported by the device.
+const char * ob::DeviceInfo::asicName | +( | +) | ++ |
Get chip type name.
+OBDeviceType ob::DeviceInfo::deviceType | +( | +) | ++ |
Get the device type.
+
+
|
+ +friend | +
Definition at line 749 of file Device.hpp.
+ +
+
|
+ +friend | +
Definition at line 750 of file Device.hpp.
+ +
+
|
+ +friend | +
Definition at line 751 of file Device.hpp.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::DeviceList, including all inherited members.
+connectionType(uint32_t index) | ob::DeviceList | |
deviceCount() | ob::DeviceList | |
DeviceList(std::unique_ptr< DeviceListImpl > impl) | ob::DeviceList | |
getDevice(uint32_t index) | ob::DeviceList | |
getDeviceBySN(const char *serialNumber) | ob::DeviceList | |
getDeviceByUid(const char *uid) | ob::DeviceList | |
ipAddress(uint32_t index) | ob::DeviceList | |
name(uint32_t index) | ob::DeviceList | |
pid(uint32_t index) | ob::DeviceList | |
serialNumber(uint32_t index) | ob::DeviceList | |
uid(uint32_t index) | ob::DeviceList | |
vid(uint32_t index) | ob::DeviceList | |
~DeviceList() noexcept | ob::DeviceList |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Class representing a list of devices. + More...
+ +#include <Device.hpp>
+Public Member Functions | |
DeviceList (std::unique_ptr< DeviceListImpl > impl) | |
~DeviceList () noexcept | |
uint32_t | deviceCount () |
Get the number of devices in the list. | |
DEPRECATED const char * | name (uint32_t index) |
Get the name of the device at the specified index (DEPRECATED) | |
int | pid (uint32_t index) |
Get the PID of the device at the specified index. | |
int | vid (uint32_t index) |
Get the VID of the device at the specified index. | |
const char * | uid (uint32_t index) |
Get the UID of the device at the specified index. | |
const char * | serialNumber (uint32_t index) |
Get the serial number of the device at the specified index. | |
const char * | connectionType (uint32_t index) |
Get device connection type. | |
const char * | ipAddress (uint32_t index) |
get the ip address of the device at the specified index | |
std::shared_ptr< Device > | getDevice (uint32_t index) |
Get the device object at the specified index. | |
std::shared_ptr< Device > | getDeviceBySN (const char *serialNumber) |
Get the device object with the specified serial number. | |
std::shared_ptr< Device > | getDeviceByUid (const char *uid) |
Get the specified device object from the device list by uid. | |
Class representing a list of devices.
+ +Definition at line 757 of file Device.hpp.
+ob::DeviceList::DeviceList | +( | +std::unique_ptr< DeviceListImpl > | +impl | ) | ++ |
+
|
+ +noexcept | +
uint32_t ob::DeviceList::deviceCount | +( | +) | ++ |
Get the number of devices in the list.
+DEPRECATED const char * ob::DeviceList::name | +( | +uint32_t | +index | ) | ++ |
Get the name of the device at the specified index (DEPRECATED)
+index | the index of the device |
int ob::DeviceList::pid | +( | +uint32_t | +index | ) | ++ |
Get the PID of the device at the specified index.
+index | the index of the device |
int ob::DeviceList::vid | +( | +uint32_t | +index | ) | ++ |
Get the VID of the device at the specified index.
+index | the index of the device |
const char * ob::DeviceList::uid | +( | +uint32_t | +index | ) | ++ |
Get the UID of the device at the specified index.
+index | the index of the device |
const char * ob::DeviceList::serialNumber | +( | +uint32_t | +index | ) | ++ |
Get the serial number of the device at the specified index.
+index | the index of the device |
const char * ob::DeviceList::connectionType | +( | +uint32_t | +index | ) | ++ |
Get device connection type.
+index | device index |
const char * ob::DeviceList::ipAddress | +( | +uint32_t | +index | ) | ++ |
get the ip address of the device at the specified index
+index | the index of the device |
std::shared_ptr< Device > ob::DeviceList::getDevice | +( | +uint32_t | +index | ) | ++ |
Get the device object at the specified index.
+index | the index of the device to create |
std::shared_ptr< Device > ob::DeviceList::getDeviceBySN | +( | +const char * | +serialNumber | ) | ++ |
Get the device object with the specified serial number.
+serialNumber | the serial number of the device to create |
std::shared_ptr< Device > ob::DeviceList::getDeviceByUid | +( | +const char * | +uid | ) | ++ |
Get the specified device object from the device list by uid.
+On Linux platform, the uid of the device is composed of bus-port-dev, for example 1-1.2-1. But the SDK will remove the dev number and only keep the bus-port as the uid to create the device, for example 1-1.2, so that we can create a device connected to the specified USB port. Similarly, users can also directly pass in bus-port as uid to create device.
+uid | The uid of the device to be created |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::DevicePresetList, including all inherited members.
+count() | ob::DevicePresetList | |
DevicePresetList(std::unique_ptr< DevicePresetListImpl > impl) | ob::DevicePresetList | |
getName(uint32_t index) | ob::DevicePresetList | |
hasPreset(const char *name) | ob::DevicePresetList | |
~DevicePresetList() noexcept | ob::DevicePresetList |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Class representing a list of device presets @breif A device preset is a set of parameters or configurations that can be applied to the device to achieve a specific effect or function. + More...
+ +#include <Device.hpp>
+Public Member Functions | |
DevicePresetList (std::unique_ptr< DevicePresetListImpl > impl) | |
~DevicePresetList () noexcept | |
uint32_t | count () |
Get the number of device presets in the list. | |
const char * | getName (uint32_t index) |
Get the name of the device preset at the specified index. | |
bool | hasPreset (const char *name) |
Class representing a list of device presets @breif A device preset is a set of parameters or configurations that can be applied to the device to achieve a specific effect or function.
+ +Definition at line 938 of file Device.hpp.
+ob::DevicePresetList::DevicePresetList | +( | +std::unique_ptr< DevicePresetListImpl > | +impl | ) | ++ |
+
|
+ +noexcept | +
uint32_t ob::DevicePresetList::count | +( | +) | ++ |
Get the number of device presets in the list.
+const char * ob::DevicePresetList::getName | +( | +uint32_t | +index | ) | ++ |
Get the name of the device preset at the specified index.
+index | the index of the device preset |
bool ob::DevicePresetList::hasPreset | +( | +const char * | +name | ) | ++ |
@breif check if the preset list contains the special name preset.
name | The name of the preset |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::DisparityTransform, including all inherited members.
+as() | ob::Filter | inline |
DisparityTransform(bool depth_to_disparity) | ob::DisparityTransform | |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Depth to disparity or disparity to depth. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
DisparityTransform (bool depth_to_disparity) | |
Create a disparity transform. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
Depth to disparity or disparity to depth.
+ +Definition at line 382 of file Filter.hpp.
+ob::DisparityTransform::DisparityTransform | +( | +bool | +depth_to_disparity | ) | ++ |
Create a disparity transform.
+depth_to_disparity | disparity to depth or depth to disparity Conversion. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::EdgeNoiseRemovalFilter, including all inherited members.
+as() | ob::Filter | inline |
EdgeNoiseRemovalFilter() | ob::EdgeNoiseRemovalFilter | |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getFilterParams() | ob::EdgeNoiseRemovalFilter | |
getMarginBottomThRange() | ob::EdgeNoiseRemovalFilter | |
getMarginLeftThRange() | ob::EdgeNoiseRemovalFilter | |
getMarginRightThRange() | ob::EdgeNoiseRemovalFilter | |
getMarginTopThRange() | ob::EdgeNoiseRemovalFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setFilterParams(OBEdgeNoiseRemovalFilterParams filterParams) | ob::EdgeNoiseRemovalFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The edge noise removal filter,removing scattering depth pixels. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
EdgeNoiseRemovalFilter () | |
void | setFilterParams (OBEdgeNoiseRemovalFilterParams filterParams) |
Set the edge noise removal filter params. | |
OBEdgeNoiseRemovalFilterParams | getFilterParams () |
Get the edge noise removal filter params. | |
OBUint16PropertyRange | getMarginLeftThRange () |
Get the edge noise removal filter margin left th range. | |
OBUint16PropertyRange | getMarginRightThRange () |
Get the edge noise removal filter margin right th range. | |
OBUint16PropertyRange | getMarginTopThRange () |
Get the edge noise removal filter margin top th range. | |
OBUint16PropertyRange | getMarginBottomThRange () |
Get the edge noise removal filter margin bottom th range. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
The edge noise removal filter,removing scattering depth pixels.
+ +Definition at line 547 of file Filter.hpp.
+ob::EdgeNoiseRemovalFilter::EdgeNoiseRemovalFilter | +( | +) | ++ |
void ob::EdgeNoiseRemovalFilter::setFilterParams | +( | +OBEdgeNoiseRemovalFilterParams | +filterParams | ) | ++ |
Set the edge noise removal filter params.
+[in] | params | ob_edge_noise_removal_filter_params. |
OBEdgeNoiseRemovalFilterParams ob::EdgeNoiseRemovalFilter::getFilterParams | +( | +) | ++ |
Get the edge noise removal filter params.
+OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getMarginLeftThRange | +( | +) | ++ |
Get the edge noise removal filter margin left th range.
+OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getMarginRightThRange | +( | +) | ++ |
Get the edge noise removal filter margin right th range.
+OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getMarginTopThRange | +( | +) | ++ |
Get the edge noise removal filter margin top th range.
+OBUint16PropertyRange ob::EdgeNoiseRemovalFilter::getMarginBottomThRange | +( | +) | ++ |
Get the edge noise removal filter margin bottom th range.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Error, including all inherited members.
+Error(std::unique_ptr< ErrorImpl > impl) noexcept | ob::Error | |
Error(const Error &error) noexcept | ob::Error | |
getArgs() const noexcept | ob::Error | |
getExceptionType() const noexcept | ob::Error | |
getMessage() const noexcept | ob::Error | |
getName() const noexcept | ob::Error | |
~Error() noexcept | ob::Error |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Error.hpp>
+Public Member Functions | |
Error (std::unique_ptr< ErrorImpl > impl) noexcept | |
Error (const Error &error) noexcept | |
~Error () noexcept | |
const char * | getMessage () const noexcept |
Get the detailed error logs of SDK internal exceptions. | |
OBExceptionType | getExceptionType () const noexcept |
Get the exception type of the error, which can be used to determine which module is abnormal. | |
const char * | getName () const noexcept |
Get the name of the error function. | |
const char * | getArgs () const noexcept |
Get the parameter passed to the error interface. | |
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
+
|
+ +noexcept | +
Get the detailed error logs of SDK internal exceptions.
+
+
|
+ +noexcept | +
Get the exception type of the error, which can be used to determine which module is abnormal.
+
+
|
+ +noexcept | +
Get the name of the error function.
+
+
|
+ +noexcept | +
Get the parameter passed to the error interface.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Filter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
OBFilterList | ob::Filter | friend |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The Filter class is the base class for all filters in the SDK. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Protected Attributes | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
+Friends | |
class | OBFilterList |
The Filter class is the base class for all filters in the SDK.
+ +Definition at line 27 of file Filter.hpp.
+ob::Filter::Filter | +( | +) | ++ |
ob::Filter::Filter | +( | +std::shared_ptr< FilterImpl > | +impl | ) | ++ |
+
|
+ +virtualdefault | +
+
|
+ +virtual | +
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used.
+ +void ob::Filter::enable | +( | +bool | +enable | ) | ++ |
enable the filter
+ +bool ob::Filter::isEnabled | +( | +) | ++ |
Return Enable State.
+ +
+
|
+ +virtual | +
Processes a frame synchronously.
+frame | The frame to be processed. |
+
|
+ +virtual | +
Pushes the pending frame into the cache for asynchronous processing.
+frame | The pending frame. The processing result is returned by the callback function. |
+
|
+ +virtual | +
Set the callback function for asynchronous processing.
+callback | The processing result callback. |
+
|
+ +virtual | +
bool ob::Filter::is | +
Check if the runtime type of the filter object is compatible with a given type.
+T | The given type. |
Definition at line 592 of file Filter.hpp.
+ +
+
|
+ +inline | +
Convert the filter object to a target type.
+T | The target type. |
Definition at line 94 of file Filter.hpp.
+ +
+
|
+ +friend | +
Definition at line 106 of file Filter.hpp.
+ +
+
|
+ +protected | +
Definition at line 103 of file Filter.hpp.
+ +
+
|
+ +protected | +
Definition at line 104 of file Filter.hpp.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::FormatConvertFilter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
FormatConvertFilter() | ob::FormatConvertFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setFormatConvertType(OBConvertFormat type) | ob::FormatConvertFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The FormatConvertFilter class is a subclass of Filter that performs format conversion. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
FormatConvertFilter () | |
void | setFormatConvertType (OBConvertFormat type) |
Set the format conversion type. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
The FormatConvertFilter class is a subclass of Filter that performs format conversion.
+ +Definition at line 165 of file Filter.hpp.
+ob::FormatConvertFilter::FormatConvertFilter | +( | +) | ++ |
void ob::FormatConvertFilter::setFormatConvertType | +( | +OBConvertFormat | +type | ) | ++ |
Set the format conversion type.
+type | The format conversion type. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Frame, including all inherited members.
+as() | ob::Frame | inline |
CoordinateTransformHelper | ob::Frame | friend |
data() | ob::Frame | virtual |
dataSize() | ob::Frame | virtual |
Filter | ob::Frame | friend |
format() | ob::Frame | virtual |
Frame(std::unique_ptr< FrameImpl > impl) | ob::Frame | explicit |
Frame(Frame &frame) | ob::Frame | |
FrameHelper | ob::Frame | friend |
getDevice() | ob::Frame | |
getMetadataValue(OBFrameMetadataType type) | ob::Frame | |
getSensor() | ob::Frame | |
getStreamProfile() | ob::Frame | |
globalTimeStampUs() | ob::Frame | |
hasMetadata(OBFrameMetadataType type) | ob::Frame | |
impl_ | ob::Frame | protected |
index() | ob::Frame | virtual |
is() | ob::Frame | |
metadata() | ob::Frame | |
metadataSize() | ob::Frame | |
Recorder | ob::Frame | friend |
systemTimeStamp() | ob::Frame | |
systemTimeStampUs() | ob::Frame | |
timeStamp() | ob::Frame | |
timeStampUs() | ob::Frame | |
type() | ob::Frame | virtual |
~Frame() noexcept | ob::Frame | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Frame.hpp>
+Public Member Functions | |
Frame (std::unique_ptr< FrameImpl > impl) | |
Frame (Frame &frame) | |
virtual | ~Frame () noexcept |
virtual OBFrameType | type () |
Get the type of frame. | |
virtual OBFormat | format () |
Get the format of the frame. | |
virtual uint64_t | index () |
Get the sequence number of the frame. | |
virtual void * | data () |
Get the frame data. | |
virtual uint32_t | dataSize () |
Get the size of the frame data. | |
uint64_t | timeStamp () |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | timeStampUs () |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | systemTimeStamp () |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | systemTimeStampUs () |
Get the system timestamp of the frame in microseconds. | |
uint64_t | globalTimeStampUs () |
Get the global timestamp of the frame in microseconds. | |
void * | metadata () |
Get the metadata of the frame. | |
uint32_t | metadataSize () |
Get the size of the metadata of the frame. | |
bool | hasMetadata (OBFrameMetadataType type) |
Check if the frame object has metadata of a given type. | |
int64_t | getMetadataValue (OBFrameMetadataType type) |
Get the metadata value. | |
std::shared_ptr< StreamProfile > | getStreamProfile () |
get StreamProfile of the frame | |
std::shared_ptr< Sensor > | getSensor () |
get owner sensor of the frame | |
std::shared_ptr< Device > | getDevice () |
get owner device of the frame | |
template<typename T > | |
bool | is () |
Check if the runtime type of the frame object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the frame object to a target type. | |
+Protected Attributes | |
std::unique_ptr< FrameImpl > | impl_ |
+Friends | |
class | Filter |
class | Recorder |
class | FrameHelper |
class | CoordinateTransformHelper |
+
|
+ +explicit | +
ob::Frame::Frame | +( | +Frame & | +frame | ) | ++ |
+
|
+ +virtualnoexcept | +
+
|
+ +virtual | +
Get the type of frame.
+
+
|
+ +virtual | +
Get the format of the frame.
+
+
|
+ +virtual | +
Get the sequence number of the frame.
+
+
|
+ +virtual | +
Get the frame data.
+
+
|
+ +virtual | +
Get the size of the frame data.
+uint64_t ob::Frame::timeStamp | +( | +) | ++ |
Get the hardware timestamp of the frame in milliseconds.
+The hardware timestamp is the time point when the frame was captured by the device, on device clock domain.
+uint64_t ob::Frame::timeStampUs | +( | +) | ++ |
Get the hardware timestamp of the frame in microseconds.
+The hardware timestamp is the time point when the frame was captured by the device, on device clock domain.
+uint64_t ob::Frame::systemTimeStamp | +( | +) | ++ |
Get the system timestamp of the frame in milliseconds.
+The system timestamp is the time point when the frame was received by the host, on host clock domain.
+uint64_t ob::Frame::systemTimeStampUs | +( | +) | ++ |
Get the system timestamp of the frame in microseconds.
+The system timestamp is the time point when the frame was received by the host, on host clock domain.
+uint64_t ob::Frame::globalTimeStampUs | +( | +) | ++ |
Get the global timestamp of the frame in microseconds.
+The global timestamp is the time point when the frame was was captured by the device, and has been converted to the host clock domain. The conversion process base on the device timestamp and can eliminate the timer drift of the device
+void * ob::Frame::metadata | +( | +) | ++ |
Get the metadata of the frame.
+uint32_t ob::Frame::metadataSize | +( | +) | ++ |
Get the size of the metadata of the frame.
+bool ob::Frame::hasMetadata | +( | +OBFrameMetadataType | +type | ) | ++ |
Check if the frame object has metadata of a given type.
+type | The metadata type. refer to OBFrameMetadataType |
int64_t ob::Frame::getMetadataValue | +( | +OBFrameMetadataType | +type | ) | ++ |
Get the metadata value.
+type | The metadata type. refer to OBFrameMetadataType |
std::shared_ptr< StreamProfile > ob::Frame::getStreamProfile | +( | +) | ++ |
get StreamProfile of the frame
+std::shared_ptr< Sensor > ob::Frame::getSensor | +( | +) | ++ |
get owner sensor of the frame
+std::shared_ptr< Device > ob::Frame::getDevice | +( | +) | ++ |
get owner device of the frame
+bool ob::Frame::is | +
+
|
+ +inline | +
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +protected | +
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::FrameHelper, including all inherited members.
+createFrame(OBFrameType type, OBFormat format, uint32_t width, uint32_t height, uint32_t strideBytes) | ob::FrameHelper | static |
createFrameFromBuffer(OBFormat format, uint32_t width, uint32_t height, uint8_t *buffer, uint32_t bufferSize, BufferDestroyCallback destroyCallback, void *destroyCallbackContext) | ob::FrameHelper | static |
createFrameSet() | ob::FrameHelper | static |
pushFrame(std::shared_ptr< Frame > frameSet, OBFrameType frameType, std::shared_ptr< Frame > frame) | ob::FrameHelper | static |
setFrameDeviceTimestamp(std::shared_ptr< Frame > frame, uint64_t deviceTimestamp) | ob::FrameHelper | static |
setFrameDeviceTimestampUs(std::shared_ptr< Frame > frame, uint64_t deviceTimestampUs) | ob::FrameHelper | static |
setFrameSystemTimestamp(std::shared_ptr< Frame > frame, uint64_t systemTimestamp) | ob::FrameHelper | static |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Define the FrameHelper class. + More...
+ +#include <Frame.hpp>
+Static Public Member Functions | |
static std::shared_ptr< Frame > | createFrame (OBFrameType type, OBFormat format, uint32_t width, uint32_t height, uint32_t strideBytes) |
Create a Frame object. | |
static std::shared_ptr< Frame > | createFrameFromBuffer (OBFormat format, uint32_t width, uint32_t height, uint8_t *buffer, uint32_t bufferSize, BufferDestroyCallback destroyCallback, void *destroyCallbackContext) |
Create a frame object based on an externally created buffer. | |
static std::shared_ptr< FrameSet > | createFrameSet () |
Create an empty FrameSet object. | |
static void | pushFrame (std::shared_ptr< Frame > frameSet, OBFrameType frameType, std::shared_ptr< Frame > frame) |
Add a frame of a specific type to the FrameSet. | |
static void | setFrameSystemTimestamp (std::shared_ptr< Frame > frame, uint64_t systemTimestamp) |
Set the system timestamp of the frame. | |
static void | setFrameDeviceTimestamp (std::shared_ptr< Frame > frame, uint64_t deviceTimestamp) |
Set the device timestamp of the frame. | |
static void | setFrameDeviceTimestampUs (std::shared_ptr< Frame > frame, uint64_t deviceTimestampUs) |
Set the device timestamp of the frame. | |
Define the FrameHelper class.
+ + +
+
|
+ +static | +
Create a Frame object.
+[in] | type | The type of frame. See OBFrameType. |
[in] | format | The format of the frame. See OBFormat. |
[in] | width | The width of the frame. |
[in] | height | The height of the frame. |
[in] | strideBytes | The stride of the frame in bytes. If strideBytes > 0, the frame data size = height * strideBytes. If strideBytes = 0, the frame datasize = height * width * pixelSize (pixelSize according to the format). |
+
|
+ +static | +
Create a frame object based on an externally created buffer.
+[in] | format | The format of the frame. See OBFormat. |
[in] | width | The width of the frame. |
[in] | height | The height of the frame. |
[in] | buffer | The frame object buffer |
[in] | bufferSize | The frame object buffer size |
[in] | destroyCallback | The frame object buffer destroy callback |
[in] | destroyCallbackContext | The frame object buffer destroy callback context |
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
Set the system timestamp of the frame.
+frame | The frame object. |
systemTimestamp | The system timestamp to set in milliseconds. |
+
|
+ +static | +
Set the device timestamp of the frame.
+frame | The frame object. |
deviceTimestamp | The device timestamp to set in milliseconds. |
+
|
+ +static | +
Set the device timestamp of the frame.
+frame | The frame object. |
deviceTimestampUs | The device timestamp to set in microseconds. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::FrameSet, including all inherited members.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Define the FrameSet class, which inherits from the Frame class. + More...
+ +#include <Frame.hpp>
+Public Member Functions | |
FrameSet (std::unique_ptr< FrameImpl > impl) | |
FrameSet (Frame &frame) | |
~FrameSet () noexcept override | |
uint32_t | frameCount () |
Get the number of frames in the FrameSet. | |
std::shared_ptr< DepthFrame > | depthFrame () |
Get the depth frame in the FrameSet. | |
std::shared_ptr< ColorFrame > | colorFrame () |
Get the color frame in the FrameSet. | |
std::shared_ptr< IRFrame > | irFrame () |
Get the infrared frame in the FrameSet. | |
std::shared_ptr< PointsFrame > | pointsFrame () |
Get the point cloud frame in the FrameSet. | |
std::shared_ptr< Frame > | getFrame (OBFrameType frameType) |
Get a frame of a specific type from the FrameSet. | |
std::shared_ptr< Frame > | getFrame (int index) |
Get a frame at a specific index from the FrameSet. | |
Public Member Functions inherited from ob::Frame | |
Frame (std::unique_ptr< FrameImpl > impl) | |
Frame (Frame &frame) | |
virtual | ~Frame () noexcept |
virtual OBFrameType | type () |
Get the type of frame. | |
virtual OBFormat | format () |
Get the format of the frame. | |
virtual uint64_t | index () |
Get the sequence number of the frame. | |
virtual void * | data () |
Get the frame data. | |
virtual uint32_t | dataSize () |
Get the size of the frame data. | |
uint64_t | timeStamp () |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | timeStampUs () |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | systemTimeStamp () |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | systemTimeStampUs () |
Get the system timestamp of the frame in microseconds. | |
uint64_t | globalTimeStampUs () |
Get the global timestamp of the frame in microseconds. | |
void * | metadata () |
Get the metadata of the frame. | |
uint32_t | metadataSize () |
Get the size of the metadata of the frame. | |
bool | hasMetadata (OBFrameMetadataType type) |
Check if the frame object has metadata of a given type. | |
int64_t | getMetadataValue (OBFrameMetadataType type) |
Get the metadata value. | |
std::shared_ptr< StreamProfile > | getStreamProfile () |
get StreamProfile of the frame | |
std::shared_ptr< Sensor > | getSensor () |
get owner sensor of the frame | |
std::shared_ptr< Device > | getDevice () |
get owner device of the frame | |
template<typename T > | |
bool | is () |
Check if the runtime type of the frame object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the frame object to a target type. | |
+Friends | |
class | Pipeline |
class | Filter |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Frame | |
std::unique_ptr< FrameImpl > | impl_ |
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridenoexcept | +
uint32_t ob::FrameSet::frameCount | +( | +) | ++ |
Get the number of frames in the FrameSet.
+std::shared_ptr< DepthFrame > ob::FrameSet::depthFrame | +( | +) | ++ |
Get the depth frame in the FrameSet.
+std::shared_ptr< ColorFrame > ob::FrameSet::colorFrame | +( | +) | ++ |
Get the color frame in the FrameSet.
+std::shared_ptr< IRFrame > ob::FrameSet::irFrame | +( | +) | ++ |
Get the infrared frame in the FrameSet.
+std::shared_ptr< PointsFrame > ob::FrameSet::pointsFrame | +( | +) | ++ |
Get the point cloud frame in the FrameSet.
+std::shared_ptr< Frame > ob::FrameSet::getFrame | +( | +OBFrameType | +frameType | ) | ++ |
Get a frame of a specific type from the FrameSet.
+frameType | The type of sensor |
std::shared_ptr< Frame > ob::FrameSet::getFrame | +( | +int | +index | ) | ++ |
Get a frame at a specific index from the FrameSet.
+index | The index of the frame |
+
|
+ +friend | +
+
|
+ +friend | +
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::GyroFrame, including all inherited members.
+as() | ob::Frame | inline |
data() | ob::Frame | virtual |
dataSize() | ob::Frame | virtual |
format() | ob::Frame | virtual |
Frame(std::unique_ptr< FrameImpl > impl) | ob::Frame | explicit |
Frame(Frame &frame) | ob::Frame | |
getDevice() | ob::Frame | |
getMetadataValue(OBFrameMetadataType type) | ob::Frame | |
getSensor() | ob::Frame | |
getStreamProfile() | ob::Frame | |
globalTimeStampUs() | ob::Frame | |
GyroFrame(Frame &frame) | ob::GyroFrame | explicit |
GyroFrame(std::unique_ptr< FrameImpl > impl) | ob::GyroFrame | explicit |
hasMetadata(OBFrameMetadataType type) | ob::Frame | |
impl_ | ob::Frame | protected |
index() | ob::Frame | virtual |
is() | ob::Frame | |
metadata() | ob::Frame | |
metadataSize() | ob::Frame | |
systemTimeStamp() | ob::Frame | |
systemTimeStampUs() | ob::Frame | |
temperature() | ob::GyroFrame | |
timeStamp() | ob::Frame | |
timeStampUs() | ob::Frame | |
type() | ob::Frame | virtual |
value() | ob::GyroFrame | |
~Frame() noexcept | ob::Frame | virtual |
~GyroFrame() noexcept override=default | ob::GyroFrame |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Define the GyroFrame class, which inherits from the Frame class. + More...
+ +#include <Frame.hpp>
+Public Member Functions | |
GyroFrame (Frame &frame) | |
GyroFrame (std::unique_ptr< FrameImpl > impl) | |
~GyroFrame () noexcept override=default | |
OBGyroValue | value () |
Get the gyro frame data. | |
float | temperature () |
Get the temperature when the frame was sampled. | |
Public Member Functions inherited from ob::Frame | |
Frame (std::unique_ptr< FrameImpl > impl) | |
Frame (Frame &frame) | |
virtual | ~Frame () noexcept |
virtual OBFrameType | type () |
Get the type of frame. | |
virtual OBFormat | format () |
Get the format of the frame. | |
virtual uint64_t | index () |
Get the sequence number of the frame. | |
virtual void * | data () |
Get the frame data. | |
virtual uint32_t | dataSize () |
Get the size of the frame data. | |
uint64_t | timeStamp () |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | timeStampUs () |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | systemTimeStamp () |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | systemTimeStampUs () |
Get the system timestamp of the frame in microseconds. | |
uint64_t | globalTimeStampUs () |
Get the global timestamp of the frame in microseconds. | |
void * | metadata () |
Get the metadata of the frame. | |
uint32_t | metadataSize () |
Get the size of the metadata of the frame. | |
bool | hasMetadata (OBFrameMetadataType type) |
Check if the frame object has metadata of a given type. | |
int64_t | getMetadataValue (OBFrameMetadataType type) |
Get the metadata value. | |
std::shared_ptr< StreamProfile > | getStreamProfile () |
get StreamProfile of the frame | |
std::shared_ptr< Sensor > | getSensor () |
get owner sensor of the frame | |
std::shared_ptr< Device > | getDevice () |
get owner device of the frame | |
template<typename T > | |
bool | is () |
Check if the runtime type of the frame object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the frame object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Frame | |
std::unique_ptr< FrameImpl > | impl_ |
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridedefaultnoexcept | +
OBGyroValue ob::GyroFrame::value | +( | +) | ++ |
Get the gyro frame data.
+float ob::GyroFrame::temperature | +( | +) | ++ |
Get the temperature when the frame was sampled.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::GyroStreamProfile, including all inherited members.
+as() | ob::StreamProfile | inline |
format() const | ob::StreamProfile | |
fullScaleRange() const | ob::GyroStreamProfile | |
getExtrinsicTo(std::shared_ptr< StreamProfile > target) | ob::StreamProfile | |
getIntrinsic() | ob::GyroStreamProfile | |
GyroStreamProfile(StreamProfile &profile) | ob::GyroStreamProfile | explicit |
GyroStreamProfile(std::unique_ptr< StreamProfileImpl > impl) | ob::GyroStreamProfile | explicit |
impl_ | ob::StreamProfile | protected |
is() | ob::StreamProfile | |
sampleRate() const | ob::GyroStreamProfile | |
StreamProfile(std::unique_ptr< StreamProfileImpl > impl) | ob::StreamProfile | |
StreamProfile(StreamProfile &streamProfile) | ob::StreamProfile | |
type() const | ob::StreamProfile | |
~GyroStreamProfile() noexcept override | ob::GyroStreamProfile | |
~StreamProfile() noexcept | ob::StreamProfile | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Class representing a gyroscope stream profile. + More...
+ +#include <StreamProfile.hpp>
+Public Member Functions | |
GyroStreamProfile (StreamProfile &profile) | |
GyroStreamProfile (std::unique_ptr< StreamProfileImpl > impl) | |
~GyroStreamProfile () noexcept override | |
OBGyroFullScaleRange | fullScaleRange () const |
Return the full scale range. | |
OBGyroSampleRate | sampleRate () const |
Return the sampling frequency. | |
OBGyroIntrinsic | getIntrinsic () |
get the intrinsic parameters of the stream. | |
Public Member Functions inherited from ob::StreamProfile | |
StreamProfile (std::unique_ptr< StreamProfileImpl > impl) | |
StreamProfile (StreamProfile &streamProfile) | |
virtual | ~StreamProfile () noexcept |
OBFormat | format () const |
Get the format of the stream. | |
OBStreamType | type () const |
Get the type of stream. | |
OBExtrinsic | getExtrinsicTo (std::shared_ptr< StreamProfile > target) |
Get the extrinsic parameters from current stream profile to the given target stream profile. | |
template<typename T > | |
bool | is () |
Check if frame object is compatible with the given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Converts object type to target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::StreamProfile | |
std::unique_ptr< StreamProfileImpl > | impl_ |
Class representing a gyroscope stream profile.
+ +Definition at line 163 of file StreamProfile.hpp.
+
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridenoexcept | +
OBGyroFullScaleRange ob::GyroStreamProfile::fullScaleRange | +( | +) | +const | +
Return the full scale range.
+OBGyroSampleRate ob::GyroStreamProfile::sampleRate | +( | +) | +const | +
Return the sampling frequency.
+OBGyroIntrinsic ob::GyroStreamProfile::getIntrinsic | +( | +) | ++ |
get the intrinsic parameters of the stream.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::HdrMerge, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
HdrMerge() | ob::HdrMerge | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
HdrMerge processing block, the processing merges between depth frames with different sub-preset sequence ids. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
HdrMerge () | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
HdrMerge processing block, the processing merges between depth frames with different sub-preset sequence ids.
+ +Definition at line 397 of file Filter.hpp.
+ob::HdrMerge::HdrMerge | +( | +) | ++ |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::HoleFillingFilter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getFilterMode() | ob::HoleFillingFilter | |
HoleFillingFilter() | ob::HoleFillingFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setFilterMode(OBHoleFillingMode mode) | ob::HoleFillingFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Hole filling filter,the processing performed depends on the selected hole filling mode. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
HoleFillingFilter () | |
void | setFilterMode (OBHoleFillingMode mode) |
Set the HoleFillingFilter mode. | |
OBHoleFillingMode | getFilterMode () |
Get the HoleFillingFilter mode. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
Hole filling filter,the processing performed depends on the selected hole filling mode.
+ +Definition at line 204 of file Filter.hpp.
+ob::HoleFillingFilter::HoleFillingFilter | +( | +) | ++ |
void ob::HoleFillingFilter::setFilterMode | +( | +OBHoleFillingMode | +mode | ) | ++ |
Set the HoleFillingFilter mode.
+[in] | filter | A holefilling_filter object. |
mode | OBHoleFillingMode, OB_HOLE_FILL_TOP,OB_HOLE_FILL_NEAREST or OB_HOLE_FILL_FAREST. |
OBHoleFillingMode ob::HoleFillingFilter::getFilterMode | +( | +) | ++ |
Get the HoleFillingFilter mode.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::IRFrame, including all inherited members.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Frame.hpp>
+Public Member Functions | |
IRFrame (Frame &frame) | |
IRFrame (std::unique_ptr< FrameImpl > impl) | |
~IRFrame () noexcept override=default | |
OBSensorType | getDataSource () |
Public Member Functions inherited from ob::VideoFrame | |
VideoFrame (Frame &frame) | |
VideoFrame (std::unique_ptr< FrameImpl > impl) | |
~VideoFrame () noexcept override=default | |
uint32_t | width () |
Get the width of the frame. | |
uint32_t | height () |
Get the height of the frame. | |
uint8_t | pixelAvailableBitSize () |
Get the effective number of pixels in the frame. | |
Public Member Functions inherited from ob::Frame | |
Frame (std::unique_ptr< FrameImpl > impl) | |
Frame (Frame &frame) | |
virtual | ~Frame () noexcept |
virtual OBFrameType | type () |
Get the type of frame. | |
virtual OBFormat | format () |
Get the format of the frame. | |
virtual uint64_t | index () |
Get the sequence number of the frame. | |
virtual void * | data () |
Get the frame data. | |
virtual uint32_t | dataSize () |
Get the size of the frame data. | |
uint64_t | timeStamp () |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | timeStampUs () |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | systemTimeStamp () |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | systemTimeStampUs () |
Get the system timestamp of the frame in microseconds. | |
uint64_t | globalTimeStampUs () |
Get the global timestamp of the frame in microseconds. | |
void * | metadata () |
Get the metadata of the frame. | |
uint32_t | metadataSize () |
Get the size of the metadata of the frame. | |
bool | hasMetadata (OBFrameMetadataType type) |
Check if the frame object has metadata of a given type. | |
int64_t | getMetadataValue (OBFrameMetadataType type) |
Get the metadata value. | |
std::shared_ptr< StreamProfile > | getStreamProfile () |
get StreamProfile of the frame | |
std::shared_ptr< Sensor > | getSensor () |
get owner sensor of the frame | |
std::shared_ptr< Device > | getDevice () |
get owner device of the frame | |
template<typename T > | |
bool | is () |
Check if the runtime type of the frame object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the frame object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Frame | |
std::unique_ptr< FrameImpl > | impl_ |
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridedefaultnoexcept | +
OBSensorType ob::IRFrame::getDataSource | +( | +) | ++ |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::NoiseRemovalFilter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getDispDiffRange() | ob::NoiseRemovalFilter | |
getFilterParams() | ob::NoiseRemovalFilter | |
getMaxSizeRange() | ob::NoiseRemovalFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
NoiseRemovalFilter() | ob::NoiseRemovalFilter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setFilterParams(OBNoiseRemovalFilterParams filterParams) | ob::NoiseRemovalFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The noise removal filter,removing scattering depth pixels. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
NoiseRemovalFilter () | |
void | setFilterParams (OBNoiseRemovalFilterParams filterParams) |
Set the noise removal filter params. | |
OBNoiseRemovalFilterParams | getFilterParams () |
Get the noise removal filter params. | |
OBUint16PropertyRange | getDispDiffRange () |
Get the noise removal filter disp diff range. | |
OBUint16PropertyRange | getMaxSizeRange () |
Get the noise removal filter max size range. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
The noise removal filter,removing scattering depth pixels.
+ +Definition at line 488 of file Filter.hpp.
+ob::NoiseRemovalFilter::NoiseRemovalFilter | +( | +) | ++ |
void ob::NoiseRemovalFilter::setFilterParams | +( | +OBNoiseRemovalFilterParams | +filterParams | ) | ++ |
Set the noise removal filter params.
+[in] | params | ob_noise_removal_filter_params. |
OBNoiseRemovalFilterParams ob::NoiseRemovalFilter::getFilterParams | +( | +) | ++ |
Get the noise removal filter params.
+OBUint16PropertyRange ob::NoiseRemovalFilter::getDispDiffRange | +( | +) | ++ |
Get the noise removal filter disp diff range.
+OBUint16PropertyRange ob::NoiseRemovalFilter::getMaxSizeRange | +( | +) | ++ |
Get the noise removal filter max size range.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::OBDepthWorkModeList, including all inherited members.
+count() | ob::OBDepthWorkModeList | |
getName(uint32_t index) | ob::OBDepthWorkModeList | |
getOBDepthWorkMode(uint32_t index) | ob::OBDepthWorkModeList | |
OBDepthWorkModeList(std::unique_ptr< OBDepthWorkModeListImpl > impl_) | ob::OBDepthWorkModeList | |
operator[](uint32_t index) | ob::OBDepthWorkModeList | |
~OBDepthWorkModeList() | ob::OBDepthWorkModeList |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Class representing a list of OBDepthWorkMode. + More...
+ +#include <Device.hpp>
+Public Member Functions | |
OBDepthWorkModeList (std::unique_ptr< OBDepthWorkModeListImpl > impl_) | |
~OBDepthWorkModeList () | |
uint32_t | count () |
Get the number of OBDepthWorkMode objects in the list. | |
OBDepthWorkMode | getOBDepthWorkMode (uint32_t index) |
Get the OBDepthWorkMode object at the specified index. | |
const char * | getName (uint32_t index) |
Get the name of the depth work mode at the specified index. | |
OBDepthWorkMode | operator[] (uint32_t index) |
Get the OBDepthWorkMode object at the specified index. | |
Class representing a list of OBDepthWorkMode.
+ +Definition at line 894 of file Device.hpp.
+ob::OBDepthWorkModeList::OBDepthWorkModeList | +( | +std::unique_ptr< OBDepthWorkModeListImpl > | +impl_ | ) | ++ |
ob::OBDepthWorkModeList::~OBDepthWorkModeList | +( | +) | ++ |
uint32_t ob::OBDepthWorkModeList::count | +( | +) | ++ |
Get the number of OBDepthWorkMode objects in the list.
+OBDepthWorkMode ob::OBDepthWorkModeList::getOBDepthWorkMode | +( | +uint32_t | +index | ) | ++ |
Get the OBDepthWorkMode object at the specified index.
+index | the index of the target OBDepthWorkMode object |
const char * ob::OBDepthWorkModeList::getName | +( | +uint32_t | +index | ) | ++ |
Get the name of the depth work mode at the specified index.
+index | the index of the depth work mode |
OBDepthWorkMode ob::OBDepthWorkModeList::operator[] | +( | +uint32_t | +index | ) | ++ |
Get the OBDepthWorkMode object at the specified index.
+index | the index of the target OBDepthWorkMode object |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::OBFilterList, including all inherited members.
+count() | ob::OBFilterList | |
getFilter(uint32_t index) | ob::OBFilterList | |
OBFilterList(std::unique_ptr< OBFilterListImpl > impl_) | ob::OBFilterList | |
~OBFilterList() noexcept | ob::OBFilterList |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Class representing a list of FrameProcessingBlock. + More...
+ +#include <Sensor.hpp>
+Public Member Functions | |
OBFilterList (std::unique_ptr< OBFilterListImpl > impl_) | |
~OBFilterList () noexcept | |
uint32_t | count () |
Get the number of OBDepthWorkMode FrameProcessingBlock in the list. | |
std::shared_ptr< Filter > | getFilter (uint32_t index) |
Get the Filter object at the specified index. | |
Class representing a list of FrameProcessingBlock.
+ +Definition at line 125 of file Sensor.hpp.
+ob::OBFilterList::OBFilterList | +( | +std::unique_ptr< OBFilterListImpl > | +impl_ | ) | ++ |
+
|
+ +noexcept | +
uint32_t ob::OBFilterList::count | +( | +) | ++ |
Get the number of OBDepthWorkMode FrameProcessingBlock in the list.
+std::shared_ptr< Filter > ob::OBFilterList::getFilter | +( | +uint32_t | +index | ) | ++ |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Pipeline, including all inherited members.
+disableFrameSync() | ob::Pipeline | |
enableFrameSync() | ob::Pipeline | |
getCalibrationParam(std::shared_ptr< Config > config) | ob::Pipeline | |
getCameraParam() | ob::Pipeline | |
getCameraParamWithProfile(uint32_t colorWidth, uint32_t colorHeight, uint32_t depthWidth, uint32_t depthHeight) | ob::Pipeline | |
getConfig() | ob::Pipeline | |
getD2CDepthProfileList(std::shared_ptr< StreamProfile > colorProfile, OBAlignMode alignMode) | ob::Pipeline | |
getD2CValidArea(uint32_t minimumDistance, uint32_t maximumDistance=0) | ob::Pipeline | |
getDevice() | ob::Pipeline | |
getEnabledStreamProfileList() | ob::Pipeline | |
getPlayback() | ob::Pipeline | |
getStreamProfileList(OBSensorType sensorType) | ob::Pipeline | |
Pipeline() | ob::Pipeline | |
Pipeline(std::shared_ptr< Device > device) | ob::Pipeline | |
Pipeline(const char *filename) | ob::Pipeline | |
start(std::shared_ptr< Config > config) | ob::Pipeline | |
start() | ob::Pipeline | |
start(std::shared_ptr< Config > config, FrameSetCallback callback) | ob::Pipeline | |
startRecord(const char *filename) | ob::Pipeline | |
stop() | ob::Pipeline | |
stopRecord() | ob::Pipeline | |
switchConfig(std::shared_ptr< Config > config) | ob::Pipeline | |
waitForFrames(uint32_t timeout_ms=1000) | ob::Pipeline | |
~Pipeline() noexcept | ob::Pipeline |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Pipeline.hpp>
+Public Member Functions | |
Pipeline () | |
Pipeline is a high-level interface for applications, algorithms related RGBD data streams. Pipeline can provide alignment inside and synchronized FrameSet. Pipeline() no parameter version, which opens the first device in the list of devices connected to the OS by default. If the application has obtained the device through the DeviceList, opening the Pipeline() at this time will throw an exception that the device has been created. | |
Pipeline (std::shared_ptr< Device > device) | |
Pipeline(std::shared_ptr< Device > device ) Function for multi-device operations. Multiple devices need to be obtained through DeviceList, and the device and pipeline are bound through this interface. | |
Pipeline (const char *filename) | |
Construct a pipeline for playback of recorded stream files. | |
~Pipeline () noexcept | |
Destroy the pipeline object. | |
void | start (std::shared_ptr< Config > config) |
Start the pipeline with configuration parameters. | |
void | start () |
Start the pipeline with default configuration parameters. | |
void | start (std::shared_ptr< Config > config, FrameSetCallback callback) |
Start the pipeline and set the frameset data callback. | |
void | stop () |
Stop the pipeline. | |
std::shared_ptr< StreamProfileList > | getEnabledStreamProfileList () |
get Enabled Stream Profile List,It must be called after the pipeline is started, otherwise it will return an empty list | |
std::shared_ptr< Config > | getConfig () |
Get the pipeline configuration parameters. | |
std::shared_ptr< FrameSet > | waitForFrames (uint32_t timeout_ms=1000) |
Wait for frameset data. | |
std::shared_ptr< Device > | getDevice () |
Get the device object. | |
std::shared_ptr< Playback > | getPlayback () |
Get the playback object. | |
std::shared_ptr< StreamProfileList > | getStreamProfileList (OBSensorType sensorType) |
Get the stream profile of the specified sensor. | |
void | enableFrameSync () |
Turn on frame synchronization. | |
void | disableFrameSync () |
Turn off frame synchronization. | |
OBCameraParam | getCameraParam () |
Get the camera parameters. | |
OBCameraParam | getCameraParamWithProfile (uint32_t colorWidth, uint32_t colorHeight, uint32_t depthWidth, uint32_t depthHeight) |
Get camera parameters by entering color and depth resolution. | |
OBCalibrationParam | getCalibrationParam (std::shared_ptr< Config > config) |
Get the calibration parameters. | |
std::shared_ptr< StreamProfileList > | getD2CDepthProfileList (std::shared_ptr< StreamProfile > colorProfile, OBAlignMode alignMode) |
Return a list of D2C-enabled depth sensor resolutions corresponding to the input color sensor resolution. | |
OBRect | getD2CValidArea (uint32_t minimumDistance, uint32_t maximumDistance=0) |
Get the valid area between the minimum distance and maximum distance after D2C. | |
void | switchConfig (std::shared_ptr< Config > config) |
Dynamically switch the corresponding config configuration. | |
void | startRecord (const char *filename) |
Start recording. | |
void | stopRecord () |
Stop recording. | |
Definition at line 28 of file Pipeline.hpp.
+ob::Pipeline::Pipeline | +( | +) | ++ |
Pipeline is a high-level interface for applications, algorithms related RGBD data streams. Pipeline can provide alignment inside and synchronized FrameSet. Pipeline() no parameter version, which opens the first device in the list of devices connected to the OS by default. If the application has obtained the device through the DeviceList, opening the Pipeline() at this time will throw an exception that the device has been created.
+ +ob::Pipeline::Pipeline | +( | +std::shared_ptr< Device > | +device | ) | ++ |
Pipeline(std::shared_ptr< Device > device ) Function for multi-device operations. Multiple devices need to be obtained through DeviceList, and the device and pipeline are bound through this interface.
+ +ob::Pipeline::Pipeline | +( | +const char * | +filename | ) | ++ |
Construct a pipeline for playback of recorded stream files.
+filename | The file path of the recorded stream file to be played back |
+
|
+ +noexcept | +
Destroy the pipeline object.
+ +void ob::Pipeline::start | +( | +std::shared_ptr< Config > | +config | ) | ++ |
Start the pipeline with configuration parameters.
+config | The parameter configuration of the pipeline |
void ob::Pipeline::start | +( | +) | ++ |
Start the pipeline with default configuration parameters.
+ +void ob::Pipeline::start | +( | +std::shared_ptr< Config > | +config, | +
+ | + | FrameSetCallback | +callback | +
+ | ) | ++ |
Start the pipeline and set the frameset data callback.
+config | The configuration of the pipeline |
callback | The callback to be triggered when all frame data in the frameset arrives |
void ob::Pipeline::stop | +( | +) | ++ |
Stop the pipeline.
+ +std::shared_ptr< StreamProfileList > ob::Pipeline::getEnabledStreamProfileList | +( | +) | ++ |
get Enabled Stream Profile List,It must be called after the pipeline is started, otherwise it will return an empty list
+ +std::shared_ptr< Config > ob::Pipeline::getConfig | +( | +) | ++ |
Get the pipeline configuration parameters.
+Returns the default configuration if the user has not configured it
+std::shared_ptr< FrameSet > ob::Pipeline::waitForFrames | +( | +uint32_t | +timeout_ms = 1000 | ) | ++ |
Wait for frameset data.
+timeout_ms | The waiting timeout in milliseconds |
std::shared_ptr< Device > ob::Pipeline::getDevice | +( | +) | ++ |
Get the device object.
+std::shared_ptr< Playback > ob::Pipeline::getPlayback | +( | +) | ++ |
Get the playback object.
+std::shared_ptr< StreamProfileList > ob::Pipeline::getStreamProfileList | +( | +OBSensorType | +sensorType | ) | ++ |
Get the stream profile of the specified sensor.
+sensorType | The type of sensor |
void ob::Pipeline::enableFrameSync | +( | +) | ++ |
Turn on frame synchronization.
+ +void ob::Pipeline::disableFrameSync | +( | +) | ++ |
Turn off frame synchronization.
+ +OBCameraParam ob::Pipeline::getCameraParam | +( | +) | ++ |
Get the camera parameters.
+OBCameraParam ob::Pipeline::getCameraParamWithProfile | +( | +uint32_t | +colorWidth, | +
+ | + | uint32_t | +colorHeight, | +
+ | + | uint32_t | +depthWidth, | +
+ | + | uint32_t | +depthHeight | +
+ | ) | ++ |
Get camera parameters by entering color and depth resolution.
+colorWidth | Width of color resolution |
colorHeight | High of color resolution |
depthWidth | Width of depth resolution |
depthHeight | High of depth resolution |
OBCalibrationParam ob::Pipeline::getCalibrationParam | +( | +std::shared_ptr< Config > | +config | ) | ++ |
Get the calibration parameters.
+config | The configured parameters |
std::shared_ptr< StreamProfileList > ob::Pipeline::getD2CDepthProfileList | +( | +std::shared_ptr< StreamProfile > | +colorProfile, | +
+ | + | OBAlignMode | +alignMode | +
+ | ) | ++ |
Return a list of D2C-enabled depth sensor resolutions corresponding to the input color sensor resolution.
+colorProfile | The input color sensor resolution |
alignMode | The input align mode |
OBRect ob::Pipeline::getD2CValidArea | +( | +uint32_t | +minimumDistance, | +
+ | + | uint32_t | +maximumDistance = 0 |
+
+ | ) | ++ |
Get the valid area between the minimum distance and maximum distance after D2C.
+minimumDistance | The minimum working distance |
maximumDistance | The maximum working distance (optional) |
void ob::Pipeline::switchConfig | +( | +std::shared_ptr< Config > | +config | ) | ++ |
Dynamically switch the corresponding config configuration.
+config | The updated config configuration |
void ob::Pipeline::startRecord | +( | +const char * | +filename | ) | ++ |
Start recording.
+filename | The name of the record file |
void ob::Pipeline::stopRecord | +( | +) | ++ |
Stop recording.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Playback, including all inherited members.
+getCameraParam() | ob::Playback | |
getDeviceInfo() | ob::Playback | |
Playback(const char *filename) | ob::Playback | |
Playback(std::unique_ptr< PlaybackImpl > impl) | ob::Playback | |
setPlaybackStateCallback(MediaStateCallback state) | ob::Playback | |
start(PlaybackCallback callback, OBMediaType type=OB_MEDIA_ALL) | ob::Playback | |
stop() | ob::Playback | |
~Playback() noexcept | ob::Playback | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <RecordPlayback.hpp>
+Public Member Functions | |
Playback (const char *filename) | |
Create a playback object. | |
Playback (std::unique_ptr< PlaybackImpl > impl) | |
virtual | ~Playback () noexcept |
void | start (PlaybackCallback callback, OBMediaType type=OB_MEDIA_ALL) |
Start playback. The playback data is returned from the callback. Throws an exception on failure. | |
void | stop () |
Stop playback. Throws an exception on failure. | |
void | setPlaybackStateCallback (MediaStateCallback state) |
Set the playback state. | |
std::shared_ptr< DeviceInfo > | getDeviceInfo () |
Get the device information in the recording file. | |
OBCameraParam | getCameraParam () |
Get the intrinsic and extrinsic parameter in the recording file. | |
Definition at line 63 of file RecordPlayback.hpp.
+ob::Playback::Playback | +( | +const char * | +filename | ) | ++ |
Create a playback object.
+filename | The name of the playback file. |
ob::Playback::Playback | +( | +std::unique_ptr< PlaybackImpl > | +impl | ) | ++ |
+
|
+ +virtualnoexcept | +
void ob::Playback::start | +( | +PlaybackCallback | +callback, | +
+ | + | OBMediaType | +type = OB_MEDIA_ALL |
+
+ | ) | ++ |
Start playback. The playback data is returned from the callback. Throws an exception on failure.
+callback | The callback for playback data. |
type | The type of playback data. |
void ob::Playback::stop | +( | +) | ++ |
Stop playback. Throws an exception on failure.
+ +void ob::Playback::setPlaybackStateCallback | +( | +MediaStateCallback | +state | ) | ++ |
Set the playback state.
+state | The playback status callback. |
std::shared_ptr< DeviceInfo > ob::Playback::getDeviceInfo | +( | +) | ++ |
Get the device information in the recording file.
+OBCameraParam ob::Playback::getCameraParam | +( | +) | ++ |
Get the intrinsic and extrinsic parameter in the recording file.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::PointCloudFilter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
PointCloudFilter() | ob::PointCloudFilter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setCameraParam(OBCameraParam param) | ob::PointCloudFilter | |
setColorDataNormalization(bool state) | ob::PointCloudFilter | |
setCoordinateSystem(OBCoordinateSystemType type) | ob::PointCloudFilter | |
setCreatePointFormat(OBFormat type) | ob::PointCloudFilter | |
setFrameAlignState(bool state) | ob::PointCloudFilter | |
setPositionDataScaled(float scale) | ob::PointCloudFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
The PointCloudFilter class is a subclass of Filter that generates point clouds. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
PointCloudFilter () | |
void | setCreatePointFormat (OBFormat type) |
Set the point cloud type parameters. | |
void | setCameraParam (OBCameraParam param) |
Set the camera parameters. | |
void | setFrameAlignState (bool state) |
Set the frame alignment state that will be input to generate point cloud. | |
void | setPositionDataScaled (float scale) |
Set the point cloud coordinate data zoom factor. | |
void | setColorDataNormalization (bool state) |
Set point cloud color data normalization. | |
void | setCoordinateSystem (OBCoordinateSystemType type) |
Set the point cloud coordinate system. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
The PointCloudFilter class is a subclass of Filter that generates point clouds.
+ +Definition at line 112 of file Filter.hpp.
+ob::PointCloudFilter::PointCloudFilter | +( | +) | ++ |
void ob::PointCloudFilter::setCreatePointFormat | +( | +OBFormat | +type | ) | ++ |
Set the point cloud type parameters.
+type | The point cloud type: depth point cloud or RGBD point cloud. |
void ob::PointCloudFilter::setCameraParam | +( | +OBCameraParam | +param | ) | ++ |
Set the camera parameters.
+param | The camera internal and external parameters. |
void ob::PointCloudFilter::setFrameAlignState | +( | +bool | +state | ) | ++ |
Set the frame alignment state that will be input to generate point cloud.
+state | The alignment status. True: enable alignment; False: disable alignment. |
void ob::PointCloudFilter::setPositionDataScaled | +( | +float | +scale | ) | ++ |
Set the point cloud coordinate data zoom factor.
+scale | The zoom factor. |
void ob::PointCloudFilter::setColorDataNormalization | +( | +bool | +state | ) | ++ |
Set point cloud color data normalization.
+state | Whether normalization is required. |
void ob::PointCloudFilter::setCoordinateSystem | +( | +OBCoordinateSystemType | +type | ) | ++ |
Set the point cloud coordinate system.
+type | The coordinate system type. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::PointsFrame, including all inherited members.
+as() | ob::Frame | inline |
data() | ob::Frame | virtual |
dataSize() | ob::Frame | virtual |
format() | ob::Frame | virtual |
Frame(std::unique_ptr< FrameImpl > impl) | ob::Frame | explicit |
Frame(Frame &frame) | ob::Frame | |
getDevice() | ob::Frame | |
getMetadataValue(OBFrameMetadataType type) | ob::Frame | |
getPositionValueScale() | ob::PointsFrame | |
getSensor() | ob::Frame | |
getStreamProfile() | ob::Frame | |
globalTimeStampUs() | ob::Frame | |
hasMetadata(OBFrameMetadataType type) | ob::Frame | |
impl_ | ob::Frame | protected |
index() | ob::Frame | virtual |
is() | ob::Frame | |
metadata() | ob::Frame | |
metadataSize() | ob::Frame | |
PointsFrame(Frame &frame) | ob::PointsFrame | explicit |
PointsFrame(std::unique_ptr< FrameImpl > impl) | ob::PointsFrame | explicit |
systemTimeStamp() | ob::Frame | |
systemTimeStampUs() | ob::Frame | |
timeStamp() | ob::Frame | |
timeStampUs() | ob::Frame | |
type() | ob::Frame | virtual |
~Frame() noexcept | ob::Frame | virtual |
~PointsFrame() noexcept override=default | ob::PointsFrame |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Frame.hpp>
+Public Member Functions | |
PointsFrame (Frame &frame) | |
PointsFrame (std::unique_ptr< FrameImpl > impl) | |
~PointsFrame () noexcept override=default | |
float | getPositionValueScale () |
Get the point position value scale of the points frame. The point position value of the points frame is multiplied by the scale to give a position value in millimeters. For example, if scale=0.1, the x-coordinate value of a point is x = 10000, which means that the actual x-coordinate value = x*scale = 10000*0.1 = 1000mm. | |
Public Member Functions inherited from ob::Frame | |
Frame (std::unique_ptr< FrameImpl > impl) | |
Frame (Frame &frame) | |
virtual | ~Frame () noexcept |
virtual OBFrameType | type () |
Get the type of frame. | |
virtual OBFormat | format () |
Get the format of the frame. | |
virtual uint64_t | index () |
Get the sequence number of the frame. | |
virtual void * | data () |
Get the frame data. | |
virtual uint32_t | dataSize () |
Get the size of the frame data. | |
uint64_t | timeStamp () |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | timeStampUs () |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | systemTimeStamp () |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | systemTimeStampUs () |
Get the system timestamp of the frame in microseconds. | |
uint64_t | globalTimeStampUs () |
Get the global timestamp of the frame in microseconds. | |
void * | metadata () |
Get the metadata of the frame. | |
uint32_t | metadataSize () |
Get the size of the metadata of the frame. | |
bool | hasMetadata (OBFrameMetadataType type) |
Check if the frame object has metadata of a given type. | |
int64_t | getMetadataValue (OBFrameMetadataType type) |
Get the metadata value. | |
std::shared_ptr< StreamProfile > | getStreamProfile () |
get StreamProfile of the frame | |
std::shared_ptr< Sensor > | getSensor () |
get owner sensor of the frame | |
std::shared_ptr< Device > | getDevice () |
get owner device of the frame | |
template<typename T > | |
bool | is () |
Check if the runtime type of the frame object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the frame object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Frame | |
std::unique_ptr< FrameImpl > | impl_ |
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridedefaultnoexcept | +
float ob::PointsFrame::getPositionValueScale | +( | +) | ++ |
Get the point position value scale of the points frame. The point position value of the points frame is multiplied by the scale to give a position value in millimeters. For example, if scale=0.1, the x-coordinate value of a point is x = 10000, which means that the actual x-coordinate value = x*scale = 10000*0.1 = 1000mm.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::RawPhaseFrame, including all inherited members.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Define the RawPhaseFrame class, which inherits from the VideoFrame class. + More...
+ +#include <Frame.hpp>
+Public Member Functions | |
RawPhaseFrame (Frame &frame) | |
RawPhaseFrame (std::unique_ptr< FrameImpl > impl) | |
~RawPhaseFrame () noexcept override=default | |
Public Member Functions inherited from ob::VideoFrame | |
VideoFrame (Frame &frame) | |
VideoFrame (std::unique_ptr< FrameImpl > impl) | |
~VideoFrame () noexcept override=default | |
uint32_t | width () |
Get the width of the frame. | |
uint32_t | height () |
Get the height of the frame. | |
uint8_t | pixelAvailableBitSize () |
Get the effective number of pixels in the frame. | |
Public Member Functions inherited from ob::Frame | |
Frame (std::unique_ptr< FrameImpl > impl) | |
Frame (Frame &frame) | |
virtual | ~Frame () noexcept |
virtual OBFrameType | type () |
Get the type of frame. | |
virtual OBFormat | format () |
Get the format of the frame. | |
virtual uint64_t | index () |
Get the sequence number of the frame. | |
virtual void * | data () |
Get the frame data. | |
virtual uint32_t | dataSize () |
Get the size of the frame data. | |
uint64_t | timeStamp () |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | timeStampUs () |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | systemTimeStamp () |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | systemTimeStampUs () |
Get the system timestamp of the frame in microseconds. | |
uint64_t | globalTimeStampUs () |
Get the global timestamp of the frame in microseconds. | |
void * | metadata () |
Get the metadata of the frame. | |
uint32_t | metadataSize () |
Get the size of the metadata of the frame. | |
bool | hasMetadata (OBFrameMetadataType type) |
Check if the frame object has metadata of a given type. | |
int64_t | getMetadataValue (OBFrameMetadataType type) |
Get the metadata value. | |
std::shared_ptr< StreamProfile > | getStreamProfile () |
get StreamProfile of the frame | |
std::shared_ptr< Sensor > | getSensor () |
get owner sensor of the frame | |
std::shared_ptr< Device > | getDevice () |
get owner device of the frame | |
template<typename T > | |
bool | is () |
Check if the runtime type of the frame object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the frame object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Frame | |
std::unique_ptr< FrameImpl > | impl_ |
Define the RawPhaseFrame class, which inherits from the VideoFrame class.
+ + +
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridedefaultnoexcept | +
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Recorder, including all inherited members.
+Recorder() | ob::Recorder | |
Recorder(std::unique_ptr< RecorderImpl > impl) | ob::Recorder | |
Recorder(std::shared_ptr< Device > device) | ob::Recorder | |
start(const char *filename, bool async=false) | ob::Recorder | |
stop() | ob::Recorder | |
write(std::shared_ptr< Frame > frame) | ob::Recorder | |
~Recorder() noexcept | ob::Recorder | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <RecordPlayback.hpp>
+Public Member Functions | |
Recorder () | |
Create a recorder for data recording. | |
Recorder (std::unique_ptr< RecorderImpl > impl) | |
Recorder (std::shared_ptr< Device > device) | |
Create a recorder for data recording. | |
virtual | ~Recorder () noexcept |
void | start (const char *filename, bool async=false) |
Enable the recorder. Throws an exception on failure. | |
void | stop () |
Stop the recorder. Throws an exception on failure. | |
void | write (std::shared_ptr< Frame > frame) |
Write frame data to the recorder. | |
Definition at line 23 of file RecordPlayback.hpp.
+ob::Recorder::Recorder | +( | +) | ++ |
Create a recorder for data recording.
+ +ob::Recorder::Recorder | +( | +std::unique_ptr< RecorderImpl > | +impl | ) | ++ |
ob::Recorder::Recorder | +( | +std::shared_ptr< Device > | +device | ) | ++ |
Create a recorder for data recording.
+device | The device for which to record device information. |
+
|
+ +virtualnoexcept | +
void ob::Recorder::start | +( | +const char * | +filename, | +
+ | + | bool | +async = false |
+
+ | ) | ++ |
Enable the recorder. Throws an exception on failure.
+filename | The name of the recorded file. |
async | Whether to execute asynchronously. |
void ob::Recorder::stop | +( | +) | ++ |
Stop the recorder. Throws an exception on failure.
+ +void ob::Recorder::write | +( | +std::shared_ptr< Frame > | +frame | ) | ++ |
Write frame data to the recorder.
+frame | The frame data to write. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Sensor, including all inherited members.
+getRecommendedFilters() | ob::Sensor | |
getStreamProfileList() | ob::Sensor | |
impl_ | ob::Sensor | protected |
Sensor(std::unique_ptr< SensorImpl > impl) | ob::Sensor | |
start(std::shared_ptr< StreamProfile > streamProfile, FrameCallback callback) | ob::Sensor | |
stop() | ob::Sensor | |
switchProfile(std::shared_ptr< StreamProfile > streamProfile) | ob::Sensor | |
type() | ob::Sensor | |
~Sensor() noexcept | ob::Sensor | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Sensor.hpp>
+Public Member Functions | |
Sensor (std::unique_ptr< SensorImpl > impl) | |
virtual | ~Sensor () noexcept |
OBSensorType | type () |
Get the sensor type. | |
const std::shared_ptr< StreamProfileList > | getStreamProfileList () |
Get the list of stream profiles. | |
const std::shared_ptr< OBFilterList > | getRecommendedFilters () |
Request recommended filters. | |
void | start (std::shared_ptr< StreamProfile > streamProfile, FrameCallback callback) |
Open a frame data stream and set up a callback. | |
void | stop () |
Stop the stream. | |
void | switchProfile (std::shared_ptr< StreamProfile > streamProfile) |
Dynamically switch resolutions. | |
+Protected Attributes | |
std::unique_ptr< SensorImpl > | impl_ |
Definition at line 31 of file Sensor.hpp.
+ob::Sensor::Sensor | +( | +std::unique_ptr< SensorImpl > | +impl | ) | ++ |
+
|
+ +virtualnoexcept | +
OBSensorType ob::Sensor::type | +( | +) | ++ |
Get the sensor type.
+const std::shared_ptr< StreamProfileList > ob::Sensor::getStreamProfileList | +( | +) | ++ |
Get the list of stream profiles.
+const std::shared_ptr< OBFilterList > ob::Sensor::getRecommendedFilters | +( | +) | ++ |
Request recommended filters.
+void ob::Sensor::start | +( | +std::shared_ptr< StreamProfile > | +streamProfile, | +
+ | + | FrameCallback | +callback | +
+ | ) | ++ |
Open a frame data stream and set up a callback.
+streamProfile | The stream configuration. |
callback | The callback to set when frame data arrives. |
void ob::Sensor::stop | +( | +) | ++ |
Stop the stream.
+ +void ob::Sensor::switchProfile | +( | +std::shared_ptr< StreamProfile > | +streamProfile | ) | ++ |
Dynamically switch resolutions.
+streamProfile | The resolution to switch to. |
+
|
+ +protected | +
Definition at line 33 of file Sensor.hpp.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::SensorList, including all inherited members.
+count() | ob::SensorList | |
getSensor(uint32_t index) | ob::SensorList | |
getSensor(OBSensorType sensorType) | ob::SensorList | |
SensorList(std::unique_ptr< SensorListImpl > impl) | ob::SensorList | |
type(uint32_t index) | ob::SensorList | |
~SensorList() noexcept | ob::SensorList | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Sensor.hpp>
+Public Member Functions | |
SensorList (std::unique_ptr< SensorListImpl > impl) | |
virtual | ~SensorList () noexcept |
uint32_t | count () |
Get the number of sensors. | |
OBSensorType | type (uint32_t index) |
Get the type of the specified sensor. | |
std::shared_ptr< Sensor > | getSensor (uint32_t index) |
Get a sensor by index number. | |
std::shared_ptr< Sensor > | getSensor (OBSensorType sensorType) |
Get a sensor by sensor type. | |
Definition at line 80 of file Sensor.hpp.
+ob::SensorList::SensorList | +( | +std::unique_ptr< SensorListImpl > | +impl | ) | ++ |
+
|
+ +virtualnoexcept | +
uint32_t ob::SensorList::count | +( | +) | ++ |
Get the number of sensors.
+OBSensorType ob::SensorList::type | +( | +uint32_t | +index | ) | ++ |
Get the type of the specified sensor.
+index | The sensor index. |
std::shared_ptr< Sensor > ob::SensorList::getSensor | +( | +uint32_t | +index | ) | ++ |
Get a sensor by index number.
+index | The sensor index. The range is [0, count-1]. If the index exceeds the range, an exception will be thrown. |
std::shared_ptr< Sensor > ob::SensorList::getSensor | +( | +OBSensorType | +sensorType | ) | ++ |
Get a sensor by sensor type.
+sensorType | The sensor type to obtain. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::SequenceIdFilter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getSelectSequenceId() | ob::SequenceIdFilter | |
getSequenceIdList() | ob::SequenceIdFilter | |
getSequenceIdListSize() | ob::SequenceIdFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
selectSequenceId(int sequence_id) | ob::SequenceIdFilter | |
SequenceIdFilter() | ob::SequenceIdFilter | |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Create SequenceIdFilter processing block. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
SequenceIdFilter () | |
void | selectSequenceId (int sequence_id) |
Set the sequenceId filter params. | |
int | getSelectSequenceId () |
Get the current sequence id. | |
OBSequenceIdItem * | getSequenceIdList () |
Get the current sequence id list. | |
int | getSequenceIdListSize () |
Get the sequenceId list size. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
Create SequenceIdFilter processing block.
+ +Definition at line 452 of file Filter.hpp.
+ob::SequenceIdFilter::SequenceIdFilter | +( | +) | ++ |
void ob::SequenceIdFilter::selectSequenceId | +( | +int | +sequence_id | ) | ++ |
Set the sequenceId filter params.
+sequence | id to pass the filter. |
int ob::SequenceIdFilter::getSelectSequenceId | +( | +) | ++ |
Get the current sequence id.
+OBSequenceIdItem * ob::SequenceIdFilter::getSequenceIdList | +( | +) | ++ |
Get the current sequence id list.
+int ob::SequenceIdFilter::getSequenceIdListSize | +( | +) | ++ |
Get the sequenceId list size.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::SpatialAdvancedFilter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getAlphaRange() | ob::SpatialAdvancedFilter | |
getDispDiffRange() | ob::SpatialAdvancedFilter | |
getFilterParams() | ob::SpatialAdvancedFilter | |
getMagnitudeRange() | ob::SpatialAdvancedFilter | |
getRadiusRange() | ob::SpatialAdvancedFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setFilterParams(OBSpatialAdvancedFilterParams params) | ob::SpatialAdvancedFilter | |
SpatialAdvancedFilter() | ob::SpatialAdvancedFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Spatial advanced filter smooths the image by calculating frame with alpha and delta settings alpha defines the weight of the current pixel for smoothing, delta defines the depth gradient below which the smoothing will occur as number of depth levels. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
SpatialAdvancedFilter () | |
OBFloatPropertyRange | getAlphaRange () |
Get the spatial advanced filter alpha range. | |
OBUint16PropertyRange | getDispDiffRange () |
Get the spatial advanced filter dispdiff range. | |
OBUint16PropertyRange | getRadiusRange () |
Get the spatial advanced filter radius range. | |
OBIntPropertyRange | getMagnitudeRange () |
Get the spatial advanced filter magnitude range. | |
OBSpatialAdvancedFilterParams | getFilterParams () |
Get the spatial advanced filter params. | |
void | setFilterParams (OBSpatialAdvancedFilterParams params) |
Set the spatial advanced filter params. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
Spatial advanced filter smooths the image by calculating frame with alpha and delta settings alpha defines the weight of the current pixel for smoothing, delta defines the depth gradient below which the smoothing will occur as number of depth levels.
+ +Definition at line 265 of file Filter.hpp.
+ob::SpatialAdvancedFilter::SpatialAdvancedFilter | +( | +) | ++ |
OBFloatPropertyRange ob::SpatialAdvancedFilter::getAlphaRange | +( | +) | ++ |
Get the spatial advanced filter alpha range.
+OBUint16PropertyRange ob::SpatialAdvancedFilter::getDispDiffRange | +( | +) | ++ |
Get the spatial advanced filter dispdiff range.
+OBUint16PropertyRange ob::SpatialAdvancedFilter::getRadiusRange | +( | +) | ++ |
Get the spatial advanced filter radius range.
+OBIntPropertyRange ob::SpatialAdvancedFilter::getMagnitudeRange | +( | +) | ++ |
Get the spatial advanced filter magnitude range.
+OBSpatialAdvancedFilterParams ob::SpatialAdvancedFilter::getFilterParams | +( | +) | ++ |
Get the spatial advanced filter params.
+ + +void ob::SpatialAdvancedFilter::setFilterParams | +( | +OBSpatialAdvancedFilterParams | +params | ) | ++ |
Set the spatial advanced filter params.
+params | OBSpatialAdvancedFilterParams. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::SpatialFastFilter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getFilterParams() | ob::SpatialFastFilter | |
getSizeRange() | ob::SpatialFastFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setFilterParams(OBSpatialFastFilterParams params) | ob::SpatialFastFilter | |
SpatialFastFilter() | ob::SpatialFastFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Spatial fast filter smooths the image by calculating frame with filter window size settings. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
SpatialFastFilter () | |
OBUint8PropertyRange | getSizeRange () |
Get the spatial fast filter window size range. | |
OBSpatialFastFilterParams | getFilterParams () |
Get the spatial fast filter params. | |
void | setFilterParams (OBSpatialFastFilterParams params) |
Set the spatial fast filter params. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
Spatial fast filter smooths the image by calculating frame with filter window size settings.
+ +Definition at line 315 of file Filter.hpp.
+ob::SpatialFastFilter::SpatialFastFilter | +( | +) | ++ |
OBUint8PropertyRange ob::SpatialFastFilter::getSizeRange | +( | +) | ++ |
Get the spatial fast filter window size range.
+OBSpatialFastFilterParams ob::SpatialFastFilter::getFilterParams | +( | +) | ++ |
Get the spatial fast filter params.
+void ob::SpatialFastFilter::setFilterParams | +( | +OBSpatialFastFilterParams | +params | ) | ++ |
Set the spatial fast filter params.
+params | OBSpatialFastFilterParams. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::SpatialModerateFilter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getDispDiffRange() | ob::SpatialModerateFilter | |
getFilterParams() | ob::SpatialModerateFilter | |
getMagnitudeRange() | ob::SpatialModerateFilter | |
getSizeRange() | ob::SpatialModerateFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setFilterParams(OBSpatialModerateFilterParams params) | ob::SpatialModerateFilter | |
SpatialModerateFilter() | ob::SpatialModerateFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Spatial moderate filter smooths the image by calculating frame with filter window size,magnitude and disp diff settings. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
SpatialModerateFilter () | |
OBUint8PropertyRange | getSizeRange () |
Get the spatial moderate filter window size range. | |
OBUint8PropertyRange | getMagnitudeRange () |
Get the spatial moderate filter magnitude range. | |
OBUint16PropertyRange | getDispDiffRange () |
Get the spatial moderate filter dispdiff range. | |
OBSpatialModerateFilterParams | getFilterParams () |
Get the spatial moderate filter params. | |
void | setFilterParams (OBSpatialModerateFilterParams params) |
Set the spatial moderate filter params. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
Spatial moderate filter smooths the image by calculating frame with filter window size,magnitude and disp diff settings.
+ +Definition at line 342 of file Filter.hpp.
+ob::SpatialModerateFilter::SpatialModerateFilter | +( | +) | ++ |
OBUint8PropertyRange ob::SpatialModerateFilter::getSizeRange | +( | +) | ++ |
Get the spatial moderate filter window size range.
+OBUint8PropertyRange ob::SpatialModerateFilter::getMagnitudeRange | +( | +) | ++ |
Get the spatial moderate filter magnitude range.
+OBUint16PropertyRange ob::SpatialModerateFilter::getDispDiffRange | +( | +) | ++ |
Get the spatial moderate filter dispdiff range.
+OBSpatialModerateFilterParams ob::SpatialModerateFilter::getFilterParams | +( | +) | ++ |
Get the spatial moderate filter params.
+ + +void ob::SpatialModerateFilter::setFilterParams | +( | +OBSpatialModerateFilterParams | +params | ) | ++ |
Set the spatial moderate filter params.
+params | OBSpatialModerateFilterParams. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::StreamProfile, including all inherited members.
+as() | ob::StreamProfile | inline |
Config | ob::StreamProfile | friend |
format() const | ob::StreamProfile | |
getExtrinsicTo(std::shared_ptr< StreamProfile > target) | ob::StreamProfile | |
impl_ | ob::StreamProfile | protected |
is() | ob::StreamProfile | |
Pipeline | ob::StreamProfile | friend |
Sensor | ob::StreamProfile | friend |
StreamProfile(std::unique_ptr< StreamProfileImpl > impl) | ob::StreamProfile | |
StreamProfile(StreamProfile &streamProfile) | ob::StreamProfile | |
type() const | ob::StreamProfile | |
~StreamProfile() noexcept | ob::StreamProfile | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <StreamProfile.hpp>
+Public Member Functions | |
StreamProfile (std::unique_ptr< StreamProfileImpl > impl) | |
StreamProfile (StreamProfile &streamProfile) | |
virtual | ~StreamProfile () noexcept |
OBFormat | format () const |
Get the format of the stream. | |
OBStreamType | type () const |
Get the type of stream. | |
OBExtrinsic | getExtrinsicTo (std::shared_ptr< StreamProfile > target) |
Get the extrinsic parameters from current stream profile to the given target stream profile. | |
template<typename T > | |
bool | is () |
Check if frame object is compatible with the given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Converts object type to target type. | |
+Protected Attributes | |
std::unique_ptr< StreamProfileImpl > | impl_ |
+Friends | |
class | Sensor |
class | Config |
class | Pipeline |
Definition at line 22 of file StreamProfile.hpp.
+ob::StreamProfile::StreamProfile | +( | +std::unique_ptr< StreamProfileImpl > | +impl | ) | ++ |
ob::StreamProfile::StreamProfile | +( | +StreamProfile & | +streamProfile | ) | ++ |
+
|
+ +virtualnoexcept | +
OBFormat ob::StreamProfile::format | +( | +) | +const | +
Get the format of the stream.
+OBStreamType ob::StreamProfile::type | +( | +) | +const | +
Get the type of stream.
+OBExtrinsic ob::StreamProfile::getExtrinsicTo | +( | +std::shared_ptr< StreamProfile > | +target | ) | ++ |
Get the extrinsic parameters from current stream profile to the given target stream profile.
+bool ob::StreamProfile::is | +
Check if frame object is compatible with the given type.
+T | Given type |
Definition at line 192 of file StreamProfile.hpp.
+ +
+
|
+ +inline | +
Converts object type to target type.
+T | Target type |
Definition at line 66 of file StreamProfile.hpp.
+ +
+
|
+ +friend | +
Definition at line 74 of file StreamProfile.hpp.
+ +
+
|
+ +friend | +
Definition at line 75 of file StreamProfile.hpp.
+ +
+
|
+ +friend | +
Definition at line 76 of file StreamProfile.hpp.
+ +
+
|
+ +protected | +
Definition at line 24 of file StreamProfile.hpp.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::StreamProfileList, including all inherited members.
+count() const | ob::StreamProfileList | |
getAccelStreamProfile(OBAccelFullScaleRange fullScaleRange, OBAccelSampleRate sampleRate) | ob::StreamProfileList | |
getGyroStreamProfile(OBGyroFullScaleRange fullScaleRange, OBGyroSampleRate sampleRate) | ob::StreamProfileList | |
getProfile(uint32_t index) | ob::StreamProfileList | |
getVideoStreamProfile(int width=OB_WIDTH_ANY, int height=OB_HEIGHT_ANY, OBFormat format=OB_FORMAT_ANY, int fps=OB_FPS_ANY) | ob::StreamProfileList | |
impl_ | ob::StreamProfileList | protected |
StreamProfileList(std::unique_ptr< StreamProfileListImpl > impl) | ob::StreamProfileList | explicit |
~StreamProfileList() noexcept | ob::StreamProfileList |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <StreamProfile.hpp>
+Public Member Functions | |
StreamProfileList (std::unique_ptr< StreamProfileListImpl > impl) | |
~StreamProfileList () noexcept | |
uint32_t | count () const |
Return the number of StreamProfile objects. | |
const std::shared_ptr< StreamProfile > | getProfile (uint32_t index) |
Return the StreamProfile object at the specified index. | |
const std::shared_ptr< VideoStreamProfile > | getVideoStreamProfile (int width=OB_WIDTH_ANY, int height=OB_HEIGHT_ANY, OBFormat format=OB_FORMAT_ANY, int fps=OB_FPS_ANY) |
Match the corresponding video stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found. | |
const std::shared_ptr< AccelStreamProfile > | getAccelStreamProfile (OBAccelFullScaleRange fullScaleRange, OBAccelSampleRate sampleRate) |
Match the corresponding accelerometer stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found. | |
const std::shared_ptr< GyroStreamProfile > | getGyroStreamProfile (OBGyroFullScaleRange fullScaleRange, OBGyroSampleRate sampleRate) |
Match the corresponding gyroscope stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found. | |
+Protected Attributes | |
std::unique_ptr< StreamProfileListImpl > | impl_ |
Definition at line 212 of file StreamProfile.hpp.
+
+
|
+ +explicit | +
+
|
+ +noexcept | +
uint32_t ob::StreamProfileList::count | +( | +) | +const | +
Return the number of StreamProfile objects.
+const std::shared_ptr< StreamProfile > ob::StreamProfileList::getProfile | +( | +uint32_t | +index | ) | ++ |
Return the StreamProfile object at the specified index.
+index | The index of the StreamProfile object to be retrieved. Must be in the range [0, count-1]. Throws an exception if the index is out of range. |
const std::shared_ptr< VideoStreamProfile > ob::StreamProfileList::getVideoStreamProfile | +( | +int | +width = OB_WIDTH_ANY , |
+
+ | + | int | +height = OB_HEIGHT_ANY , |
+
+ | + | OBFormat | +format = OB_FORMAT_ANY , |
+
+ | + | int | +fps = OB_FPS_ANY |
+
+ | ) | ++ |
Match the corresponding video stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found.
+width | The width of the stream. Pass OB_WIDTH_ANY if no matching condition is required. |
height | The height of the stream. Pass OB_HEIGHT_ANY if no matching condition is required. |
format | The type of the stream. Pass OB_FORMAT_ANY if no matching condition is required. |
fps | The frame rate of the stream. Pass OB_FPS_ANY if no matching condition is required. |
const std::shared_ptr< AccelStreamProfile > ob::StreamProfileList::getAccelStreamProfile | +( | +OBAccelFullScaleRange | +fullScaleRange, | +
+ | + | OBAccelSampleRate | +sampleRate | +
+ | ) | ++ |
Match the corresponding accelerometer stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found.
+fullScaleRange | The full scale range. Pass 0 if no matching condition is required. |
sampleRate | The sampling frequency. Pass 0 if no matching condition is required. |
const std::shared_ptr< GyroStreamProfile > ob::StreamProfileList::getGyroStreamProfile | +( | +OBGyroFullScaleRange | +fullScaleRange, | +
+ | + | OBGyroSampleRate | +sampleRate | +
+ | ) | ++ |
Match the corresponding gyroscope stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found.
+fullScaleRange | The full scale range. Pass 0 if no matching condition is required. |
sampleRate | The sampling frequency. Pass 0 if no matching condition is required. |
+
|
+ +protected | +
Definition at line 214 of file StreamProfile.hpp.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::TemporalFilter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getDiffScaleRange() | ob::TemporalFilter | |
getWeightRange() | ob::TemporalFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setDiffScale(float value) | ob::TemporalFilter | |
setWeight(float value) | ob::TemporalFilter | |
TemporalFilter() | ob::TemporalFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Temporal filter. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
TemporalFilter () | |
OBFloatPropertyRange | getDiffScaleRange () |
Get the TemporalFilter diffscale range. | |
void | setDiffScale (float value) |
Set the TemporalFilter diffscale value. | |
OBFloatPropertyRange | getWeightRange () |
Get the TemporalFilter weight range. | |
void | setWeight (float value) |
Set the TemporalFilter weight value. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
Temporal filter.
+ +Definition at line 227 of file Filter.hpp.
+ob::TemporalFilter::TemporalFilter | +( | +) | ++ |
OBFloatPropertyRange ob::TemporalFilter::getDiffScaleRange | +( | +) | ++ |
Get the TemporalFilter diffscale range.
+void ob::TemporalFilter::setDiffScale | +( | +float | +value | ) | ++ |
Set the TemporalFilter diffscale value.
+value | diffscale value. |
OBFloatPropertyRange ob::TemporalFilter::getWeightRange | +( | +) | ++ |
Get the TemporalFilter weight range.
+void ob::TemporalFilter::setWeight | +( | +float | +value | ) | ++ |
Set the TemporalFilter weight value.
+value | weight value. |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::ThresholdFilter, including all inherited members.
+as() | ob::Filter | inline |
enable(bool enable) | ob::Filter | |
Filter() | ob::Filter | |
Filter(std::shared_ptr< FilterImpl > impl) | ob::Filter | |
getMaxRange() | ob::ThresholdFilter | |
getMinRange() | ob::ThresholdFilter | |
impl_ | ob::Filter | protected |
is() | ob::Filter | |
isEnabled() | ob::Filter | |
process(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
pushFrame(std::shared_ptr< Frame > frame) | ob::Filter | virtual |
reset() | ob::Filter | virtual |
setCallBack(FilterCallback callback) | ob::Filter | virtual |
setValueRange(uint16_t min, uint16_t max) | ob::ThresholdFilter | |
ThresholdFilter() | ob::ThresholdFilter | |
type() | ob::Filter | virtual |
type_ | ob::Filter | protected |
~Filter()=default | ob::Filter | virtual |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Creates depth Thresholding filter By controlling min and max options on the block. + More...
+ +#include <Filter.hpp>
+Public Member Functions | |
ThresholdFilter () | |
OBIntPropertyRange | getMinRange () |
Get the threshold filter min range. | |
OBIntPropertyRange | getMaxRange () |
Get the threshold filter max range. | |
bool | setValueRange (uint16_t min, uint16_t max) |
Get the threshold filter max and min range. | |
Public Member Functions inherited from ob::Filter | |
Filter () | |
Filter (std::shared_ptr< FilterImpl > impl) | |
virtual | ~Filter ()=default |
virtual void | reset () |
ReSet the filter, freeing the internal cache, stopping the processing thread, and clearing the pending buffer frame when asynchronous processing is used. | |
void | enable (bool enable) |
enable the filter | |
bool | isEnabled () |
Return Enable State. | |
virtual std::shared_ptr< Frame > | process (std::shared_ptr< Frame > frame) |
Processes a frame synchronously. | |
virtual void | pushFrame (std::shared_ptr< Frame > frame) |
Pushes the pending frame into the cache for asynchronous processing. | |
virtual void | setCallBack (FilterCallback callback) |
Set the callback function for asynchronous processing. | |
virtual const char * | type () |
Get the type of filter. | |
template<typename T > | |
bool | is () |
Check if the runtime type of the filter object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the filter object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Filter | |
std::shared_ptr< FilterImpl > | impl_ |
std::string | type_ |
Creates depth Thresholding filter By controlling min and max options on the block.
+ +Definition at line 425 of file Filter.hpp.
+ob::ThresholdFilter::ThresholdFilter | +( | +) | ++ |
OBIntPropertyRange ob::ThresholdFilter::getMinRange | +( | +) | ++ |
Get the threshold filter min range.
+OBIntPropertyRange ob::ThresholdFilter::getMaxRange | +( | +) | ++ |
Get the threshold filter max range.
+bool ob::ThresholdFilter::setValueRange | +( | +uint16_t | +min, | +
+ | + | uint16_t | +max | +
+ | ) | ++ |
Get the threshold filter max and min range.
+ ++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::Version, including all inherited members.
+getMajor() | ob::Version | static |
getMinor() | ob::Version | static |
getPatch() | ob::Version | static |
getStageVersion() | ob::Version | static |
getVersion() | ob::Version | static |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Version.hpp>
+Static Public Member Functions | |
static int | getMajor () |
Get the major version number of the SDK. | |
static int | getMinor () |
Get the minor version number of the SDK. | |
static int | getPatch () |
Get the patch version number of the SDK. | |
static int | getVersion () |
Get the full version number of the SDK. | |
static char * | getStageVersion () |
Get the stage version of the SDK. | |
Definition at line 8 of file Version.hpp.
+
+
|
+ +static | +
Get the major version number of the SDK.
+
+
|
+ +static | +
Get the minor version number of the SDK.
+
+
|
+ +static | +
Get the patch version number of the SDK.
+
+
|
+ +static | +
Get the full version number of the SDK.
+
+
|
+ +static | +
Get the stage version of the SDK.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::VideoFrame, including all inherited members.
+as() | ob::Frame | inline |
data() | ob::Frame | virtual |
dataSize() | ob::Frame | virtual |
format() | ob::Frame | virtual |
Frame(std::unique_ptr< FrameImpl > impl) | ob::Frame | explicit |
Frame(Frame &frame) | ob::Frame | |
getDevice() | ob::Frame | |
getMetadataValue(OBFrameMetadataType type) | ob::Frame | |
getSensor() | ob::Frame | |
getStreamProfile() | ob::Frame | |
globalTimeStampUs() | ob::Frame | |
hasMetadata(OBFrameMetadataType type) | ob::Frame | |
height() | ob::VideoFrame | |
impl_ | ob::Frame | protected |
index() | ob::Frame | virtual |
is() | ob::Frame | |
metadata() | ob::Frame | |
metadataSize() | ob::Frame | |
pixelAvailableBitSize() | ob::VideoFrame | |
systemTimeStamp() | ob::Frame | |
systemTimeStampUs() | ob::Frame | |
timeStamp() | ob::Frame | |
timeStampUs() | ob::Frame | |
type() | ob::Frame | virtual |
VideoFrame(Frame &frame) | ob::VideoFrame | explicit |
VideoFrame(std::unique_ptr< FrameImpl > impl) | ob::VideoFrame | explicit |
width() | ob::VideoFrame | |
~Frame() noexcept | ob::Frame | virtual |
~VideoFrame() noexcept override=default | ob::VideoFrame |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
#include <Frame.hpp>
+Public Member Functions | |
VideoFrame (Frame &frame) | |
VideoFrame (std::unique_ptr< FrameImpl > impl) | |
~VideoFrame () noexcept override=default | |
uint32_t | width () |
Get the width of the frame. | |
uint32_t | height () |
Get the height of the frame. | |
uint8_t | pixelAvailableBitSize () |
Get the effective number of pixels in the frame. | |
Public Member Functions inherited from ob::Frame | |
Frame (std::unique_ptr< FrameImpl > impl) | |
Frame (Frame &frame) | |
virtual | ~Frame () noexcept |
virtual OBFrameType | type () |
Get the type of frame. | |
virtual OBFormat | format () |
Get the format of the frame. | |
virtual uint64_t | index () |
Get the sequence number of the frame. | |
virtual void * | data () |
Get the frame data. | |
virtual uint32_t | dataSize () |
Get the size of the frame data. | |
uint64_t | timeStamp () |
Get the hardware timestamp of the frame in milliseconds. | |
uint64_t | timeStampUs () |
Get the hardware timestamp of the frame in microseconds. | |
uint64_t | systemTimeStamp () |
Get the system timestamp of the frame in milliseconds. | |
uint64_t | systemTimeStampUs () |
Get the system timestamp of the frame in microseconds. | |
uint64_t | globalTimeStampUs () |
Get the global timestamp of the frame in microseconds. | |
void * | metadata () |
Get the metadata of the frame. | |
uint32_t | metadataSize () |
Get the size of the metadata of the frame. | |
bool | hasMetadata (OBFrameMetadataType type) |
Check if the frame object has metadata of a given type. | |
int64_t | getMetadataValue (OBFrameMetadataType type) |
Get the metadata value. | |
std::shared_ptr< StreamProfile > | getStreamProfile () |
get StreamProfile of the frame | |
std::shared_ptr< Sensor > | getSensor () |
get owner sensor of the frame | |
std::shared_ptr< Device > | getDevice () |
get owner device of the frame | |
template<typename T > | |
bool | is () |
Check if the runtime type of the frame object is compatible with a given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Convert the frame object to a target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::Frame | |
std::unique_ptr< FrameImpl > | impl_ |
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridedefaultnoexcept | +
uint32_t ob::VideoFrame::width | +( | +) | ++ |
Get the width of the frame.
+uint32_t ob::VideoFrame::height | +( | +) | ++ |
Get the height of the frame.
+uint8_t ob::VideoFrame::pixelAvailableBitSize | +( | +) | ++ |
Get the effective number of pixels in the frame.
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
This is the complete list of members for ob::VideoStreamProfile, including all inherited members.
+as() | ob::StreamProfile | inline |
format() const | ob::StreamProfile | |
fps() const | ob::VideoStreamProfile | |
getDistortion() | ob::VideoStreamProfile | |
getExtrinsicTo(std::shared_ptr< StreamProfile > target) | ob::StreamProfile | |
getIntrinsic() | ob::VideoStreamProfile | |
height() const | ob::VideoStreamProfile | |
impl_ | ob::StreamProfile | protected |
is() | ob::StreamProfile | |
StreamProfile(std::unique_ptr< StreamProfileImpl > impl) | ob::StreamProfile | |
StreamProfile(StreamProfile &streamProfile) | ob::StreamProfile | |
type() const | ob::StreamProfile | |
VideoStreamProfile(StreamProfile &profile) | ob::VideoStreamProfile | explicit |
VideoStreamProfile(std::unique_ptr< StreamProfileImpl > impl) | ob::VideoStreamProfile | explicit |
width() const | ob::VideoStreamProfile | |
~StreamProfile() noexcept | ob::StreamProfile | virtual |
~VideoStreamProfile() noexcept override | ob::VideoStreamProfile |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
Class representing a video stream profile. + More...
+ +#include <StreamProfile.hpp>
+Public Member Functions | |
VideoStreamProfile (StreamProfile &profile) | |
VideoStreamProfile (std::unique_ptr< StreamProfileImpl > impl) | |
~VideoStreamProfile () noexcept override | |
uint32_t | fps () const |
Return the frame rate of the stream. | |
uint32_t | width () const |
Return the width of the stream. | |
uint32_t | height () const |
Return the height of the stream. | |
OBCameraIntrinsic | getIntrinsic () |
Get the intrinsic parameters of the stream. | |
OBCameraDistortion | getDistortion () |
Get the distortion parameters of the stream. | |
Public Member Functions inherited from ob::StreamProfile | |
StreamProfile (std::unique_ptr< StreamProfileImpl > impl) | |
StreamProfile (StreamProfile &streamProfile) | |
virtual | ~StreamProfile () noexcept |
OBFormat | format () const |
Get the format of the stream. | |
OBStreamType | type () const |
Get the type of stream. | |
OBExtrinsic | getExtrinsicTo (std::shared_ptr< StreamProfile > target) |
Get the extrinsic parameters from current stream profile to the given target stream profile. | |
template<typename T > | |
bool | is () |
Check if frame object is compatible with the given type. | |
template<typename T > | |
std::shared_ptr< T > | as () |
Converts object type to target type. | |
+Additional Inherited Members | |
Protected Attributes inherited from ob::StreamProfile | |
std::unique_ptr< StreamProfileImpl > | impl_ |
Class representing a video stream profile.
+ +Definition at line 82 of file StreamProfile.hpp.
+
+
|
+ +explicit | +
+
|
+ +explicit | +
+
|
+ +overridenoexcept | +
uint32_t ob::VideoStreamProfile::fps | +( | +) | +const | +
Return the frame rate of the stream.
+uint32_t ob::VideoStreamProfile::width | +( | +) | +const | +
Return the width of the stream.
+uint32_t ob::VideoStreamProfile::height | +( | +) | +const | +
Return the height of the stream.
+OBCameraIntrinsic ob::VideoStreamProfile::getIntrinsic | +( | +) | ++ |
Get the intrinsic parameters of the stream.
+OBCameraDistortion ob::VideoStreamProfile::getDistortion | +( | +) | ++ |
Get the distortion parameters of the stream.
+Brown distortion model
++ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+Files | |
Context.hpp | |
The SDK context class, which serves as the entry point to the underlying SDK. It is used to query device lists, handle device callbacks, and set the log level. | |
Device.hpp | |
Device related types, including operations such as getting and creating a device, setting and obtaining device attributes, and obtaining sensors. | |
Error.hpp | |
This file defines the Error class, which describes abnormal errors within the SDK. Detailed information about the exception can be obtained through this class. | |
Filter.hpp | |
This file contains the Filter class, which is the processing unit of the SDK that can perform point cloud generation, format conversion, and other functions. | |
Frame.hpp | |
Frame related type, which is mainly used to obtain frame data and frame information. | |
Pipeline.hpp | |
The SDK's advanced API type can quickly implement switching streaming and frame synchronization operations. | |
RecordPlayback.hpp | |
Header file for recording and playback functions. | |
Sensor.hpp | |
Defines types related to sensors, which are used to obtain stream configurations, open and close streams, and set and get sensor properties. | |
StreamProfile.hpp | |
The stream profile related type is used to get information such as the width, height, frame rate, and format of the stream. | |
Types.hpp | |
Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes.h). | |
Utils.hpp | |
The SDK utils class. | |
Version.hpp | |
Provides functions to retrieve version information of the SDK. | |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+Directories | |
h | |
hpp | |
+Files | |
ObSensor.h | |
This file serves as the C entrance for the OrbbecSDK library. It includes all necessary header files for OrbbecSDK usage. | |
ObSensor.hpp | |
This is the main entry point for the OrbbecSDK C++ library. It includes all necessary header files for using the library. | |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+Files | |
Context.h | |
Context is a management class that describes the runtime of the SDK and is responsible for resource allocation and release of the SDK. Context has the ability to manage multiple devices. It is responsible for enumerating devices, monitoring device callbacks, and enabling multi-device synchronization. | |
Device.h | |
Device-related functions, including operations such as obtaining and creating a device, setting and obtaining device property, and obtaining sensors. | |
Error.h | |
Functions for handling errors, mainly used for obtaining error messages. | |
Filter.h | |
The processing unit of the SDK can perform point cloud generation, format conversion and other functions. | |
Frame.h | |
Frame related function is mainly used to obtain frame data and frame information. | |
MultipleDevices.h | |
This file contains the multiple devices related API witch is used to control the synchronization between multiple devices and the synchronization between different sensor within single device. | |
ObTypes.h | |
Provide structs commonly used in the SDK, enumerating constant definitions. | |
Pipeline.h | |
The SDK's advanced API can quickly implement functions such as switching streaming, frame synchronization, software filtering, etc., suitable for applications, and the algorithm focuses on rgbd data stream scenarios. If you are on real-time or need to handle synchronization separately, align the scene. Please use the interface of Device's Lower API. | |
Property.h | |
Control command property list maintenance. | |
RecordPlayback.h | |
Header file for recording and playback functions. | |
Sensor.h | |
Defines types related to sensors, used for obtaining stream configurations, opening and closing streams, and setting and getting sensor properties. | |
StreamProfile.h | |
The stream profile related type is used to get information such as the width, height, frame rate, and format of the stream. | |
Utils.h | |
Version.h | |
Functions for retrieving the SDK version number information. | |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+Directories | |
libobsensor | |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
▼ include | |
▼ libobsensor | |
▼ h | |
Context.h | Context is a management class that describes the runtime of the SDK and is responsible for resource allocation and release of the SDK. Context has the ability to manage multiple devices. It is responsible for enumerating devices, monitoring device callbacks, and enabling multi-device synchronization |
Device.h | Device-related functions, including operations such as obtaining and creating a device, setting and obtaining device property, and obtaining sensors |
Error.h | Functions for handling errors, mainly used for obtaining error messages |
Filter.h | The processing unit of the SDK can perform point cloud generation, format conversion and other functions |
Frame.h | Frame related function is mainly used to obtain frame data and frame information |
MultipleDevices.h | This file contains the multiple devices related API witch is used to control the synchronization between multiple devices and the synchronization between different sensor within single device |
ObTypes.h | Provide structs commonly used in the SDK, enumerating constant definitions |
Pipeline.h | The SDK's advanced API can quickly implement functions such as switching streaming, frame synchronization, software filtering, etc., suitable for applications, and the algorithm focuses on rgbd data stream scenarios. If you are on real-time or need to handle synchronization separately, align the scene. Please use the interface of Device's Lower API |
Property.h | Control command property list maintenance |
RecordPlayback.h | Header file for recording and playback functions |
Sensor.h | Defines types related to sensors, used for obtaining stream configurations, opening and closing streams, and setting and getting sensor properties |
StreamProfile.h | The stream profile related type is used to get information such as the width, height, frame rate, and format of the stream |
Utils.h | |
Version.h | Functions for retrieving the SDK version number information |
▼ hpp | |
Context.hpp | The SDK context class, which serves as the entry point to the underlying SDK. It is used to query device lists, handle device callbacks, and set the log level |
Device.hpp | Device related types, including operations such as getting and creating a device, setting and obtaining device attributes, and obtaining sensors |
Error.hpp | This file defines the Error class, which describes abnormal errors within the SDK. Detailed information about the exception can be obtained through this class |
Filter.hpp | This file contains the Filter class, which is the processing unit of the SDK that can perform point cloud generation, format conversion, and other functions |
Frame.hpp | Frame related type, which is mainly used to obtain frame data and frame information |
Pipeline.hpp | The SDK's advanced API type can quickly implement switching streaming and frame synchronization operations |
RecordPlayback.hpp | Header file for recording and playback functions |
Sensor.hpp | Defines types related to sensors, which are used to obtain stream configurations, open and close streams, and set and get sensor properties |
StreamProfile.hpp | The stream profile related type is used to get information such as the width, height, frame rate, and format of the stream |
Types.hpp | Provides SDK structure and enumeration constant definitions (depending on libobsensor/h/ObTypes.h) |
Utils.hpp | The SDK utils class |
Version.hpp | Provides functions to retrieve version information of the SDK |
ObSensor.h | This file serves as the C entrance for the OrbbecSDK library. It includes all necessary header files for OrbbecSDK usage |
ObSensor.hpp | This is the main entry point for the OrbbecSDK C++ library. It includes all necessary header files for using the library |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+
CAE_ROI | The rect of the region of interest |
CBASELINE_CALIBRATION_PARAM | Baseline calibration parameters |
Cob::CameraParamList | Class representing a list of camera parameters |
Cob::Config | Config class for configuring pipeline parameters |
Cob::Context | |
Cob::CoordinateTransformHelper | |
Cob::Device | |
Cob::DeviceInfo | A class describing device information, representing the name, id, serial number and other basic information of an RGBD camera |
Cob::DeviceList | Class representing a list of devices |
Cob::DevicePresetList | Class representing a list of device presets @breif A device preset is a set of parameters or configurations that can be applied to the device to achieve a specific effect or function |
CDISP_OFFSET_CONFIG | |
▼Cstd::enable_shared_from_this | |
▼Cob::Filter | Base class for all filters in the SDK |
Cob::Align | Align for depth to other or other to depth |
Cob::CompressionFilter | Subclass of Filter that performs compression |
Cob::DecimationFilter | Decimation filter,reducing complexity by subsampling depth maps and losing depth details |
Cob::DecompressionFilter | Subclass of Filter that performs decompression |
Cob::DisparityTransform | Depth to disparity or disparity to depth |
Cob::EdgeNoiseRemovalFilter | The edge noise removal filter,removing scattering depth pixels |
Cob::FormatConvertFilter | Subclass of Filter that performs format conversion |
Cob::HdrMerge | HdrMerge processing block, the processing merges between depth frames with different sub-preset sequence ids |
Cob::HoleFillingFilter | Hole filling filter,the processing performed depends on the selected hole filling mode |
Cob::NoiseRemovalFilter | The noise removal filter,removing scattering depth pixels |
Cob::PointCloudFilter | Subclass of Filter that generates point clouds |
Cob::SequenceIdFilter | Create SequenceIdFilter processing block |
Cob::SpatialAdvancedFilter | Spatial advanced filter smooths the image by calculating frame with alpha and delta settings alpha defines the weight of the current pixel for smoothing, delta defines the depth gradient below which the smoothing will occur as number of depth levels |
Cob::SpatialFastFilter | Spatial fast filter smooths the image by calculating frame with filter window size settings |
Cob::SpatialModerateFilter | Spatial moderate filter smooths the image by calculating frame with filter window size,magnitude and disp diff settings |
Cob::TemporalFilter | Temporal filter |
Cob::ThresholdFilter | Creates depth Thresholding filter By controlling min and max options on the block |
▼Cob::Frame | |
Cob::AccelFrame | Define the AccelFrame class, which inherits from the Frame class |
Cob::FrameSet | Define the FrameSet class, which inherits from the Frame class |
Cob::GyroFrame | Define the GyroFrame class, which inherits from the Frame class |
Cob::PointsFrame | |
▼Cob::VideoFrame | |
Cob::ColorFrame | |
Cob::DepthFrame | |
Cob::IRFrame | |
Cob::RawPhaseFrame | Define the RawPhaseFrame class, which inherits from the VideoFrame class |
▼Cob::StreamProfile | |
Cob::AccelStreamProfile | Class representing an accelerometer stream profile |
Cob::GyroStreamProfile | Class representing a gyroscope stream profile |
Cob::VideoStreamProfile | Class representing a video stream profile |
Cob::Error | |
Cob::FrameHelper | Define the FrameHelper class |
CHDR_CONFIG | HDR Configuration |
Cob_device_timestamp_reset_config | The timestamp reset configuration of the device |
Cob_error | The error class exposed by the SDK, users can get detailed error information according to the error |
Cob_margin_filter_config | Configuration for depth margin filter |
Cob_multi_device_sync_config | The synchronization configuration of the device |
COBAccelIntrinsic | Structure for accelerometer intrinsic parameters |
COBAccelValue | Data structures for accelerometers and gyroscopes |
COBBoolPropertyRange | Structure for boolean range |
COBCalibrationParam | Calibration parameters |
COBCameraAlignIntrinsic | Video stream intrinsics |
COBCameraDistortion | Structure for distortion parameters |
COBCameraIntrinsic | Structure for camera intrinsic parameters |
COBCameraParam | Structure for camera parameters |
COBCameraParam_V0 | Camera parameters |
COBColorPoint | 3D point structure with color information |
COBCompressionParams | |
COBD2CTransform | Structure for rotation/transformation |
COBDataBundle | Internal API for future publication |
COBDataChunk | Structure for transmitting data blocks |
COBDepthWorkMode | Depth work mode |
Cob::OBDepthWorkModeList | Class representing a list of OBDepthWorkMode |
COBDeviceSyncConfig | Device synchronization configuration |
COBDeviceTemperature | Temperature parameters of the device (unit: Celsius) |
COBEdgeNoiseRemovalFilterParams | |
Cob::OBFilterList | Class representing a list of FrameProcessingBlock |
COBFloatPropertyRange | Structure for float range |
COBGyroIntrinsic | Structure for gyroscope intrinsic parameters |
COBIntPropertyRange | Structure for integer range |
COBMGCFilterConfig | Configuration for mgc filter |
COBNetIpConfig | IP address configuration for network devices (IPv4) |
COBNoiseRemovalFilterParams | |
COBPoint | 3D point structure in the SDK |
COBPoint2f | 2D point structure in the SDK |
COBPropertyItem | Used to describe the characteristics of each property |
COBProtocolVersion | Control command protocol version number |
COBRect | Rectangle |
COBSequenceIdItem | SequenceId fliter list item |
COBSpatialAdvancedFilterParams | |
COBSpatialFastFilterParams | |
COBSpatialModerateFilterParams | |
COBTofExposureThresholdControl | TOF Exposure Threshold |
COBUint16PropertyRange | Structure for float range |
COBUint8PropertyRange | Structure for float range |
COBXYTables | |
Cob::Pipeline | |
Cob::Playback | |
Cob::Recorder | |
Cob::Sensor | |
Cob::SensorList | |
Cob::StreamProfileList | |
Cob::Version |
+ |
+ OrbbecSDK 1.10.16
+
+ OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
+ |
+