ApplicationConfig.h

Go to the documentation of this file.

// Copyright (c) Orbbec Inc. All Rights Reserved.
// Licensed under the MIT License.
 
#pragma once
 
#include "ObTypes.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    OB_APP_CONFIG_SENSORS              = 0, 
    OB_APP_CONFIG_SENSOR_TYPE          = 1, 
    OB_APP_CONFIG_STREAM_ENABLED       = 2, 
    OB_APP_CONFIG_STREAM_PROFILE       = 3, 
    OB_APP_CONFIG_UNDISTORTION_ENABLED = 4, 
 
    OB_APP_CONFIG_DEVICE_DECIMATION_ENABLED = 5, 
    OB_APP_CONFIG_DEVICE_DECIMATION         = 6, 
    // Point cloud
    OB_APP_CONFIG_POINTCLOUD_ENABLED                 = 100, 
    OB_APP_CONFIG_POINTCLOUD_FORMAT                  = 101, 
    OB_APP_CONFIG_POINTCLOUD_DECIMATION_FACTOR       = 102, 
    OB_APP_CONFIG_POINTCLOUD_ALIGN_MODE              = 103, 
    OB_APP_CONFIG_POINTCLOUD_FRAME_SYNC              = 104, 
    OB_APP_CONFIG_POINTCLOUD_ALL_FRAME_TYPE_REQUIRED = 105, 
    OB_APP_CONFIG_POINTCLOUD_MATCH_TARGET_RESOLUTION = 106, 
    // HDR Merge
    OB_APP_CONFIG_HDR_MERGE_ENABLED    = 200, 
    OB_APP_CONFIG_HDR_MERGE_IR_ENABLED = 201, 
} OBAppConfigKey,
    ob_app_config_key;

typedef uint64_t OBAppConfigItem, ob_app_config_item;
 
#define OB_APP_CONFIG_INDEX_NONE (0u)
#define OB_APP_CONFIG_ITEM(key) ((OBAppConfigItem)(uint32_t)(key))
#define OB_APP_CONFIG_ARRAY_ITEM(key, index) ((((OBAppConfigItem)(uint32_t)(index)) << 32) | (OBAppConfigItem)(uint32_t)(key))
#define OB_APP_CONFIG_ITEM_KEY(item) ((OBAppConfigKey)((uint32_t)((item) & 0xFFFFFFFFu)))
#define OB_APP_CONFIG_ITEM_INDEX(item) ((uint32_t)(((item) >> 32) & 0xFFFFFFFFu))

typedef enum {
    OB_APP_CONFIG_VALUE_BOOL,   
    OB_APP_CONFIG_VALUE_INT,    
    OB_APP_CONFIG_VALUE_FLOAT,  
    OB_APP_CONFIG_VALUE_STRING, 
    OB_APP_CONFIG_VALUE_STRUCT, 
} OBAppConfigValueType,
    ob_app_config_value_type;

OB_EXPORT ob_application_config *ob_device_get_application_config(ob_device *device, ob_error **error);

OB_EXPORT ob_application_config *ob_device_get_application_config_by_preset(ob_device *device, const char *preset_name, ob_error **error);

OB_EXPORT void ob_delete_application_config(ob_application_config *config, ob_error **error);

OB_EXPORT bool ob_device_is_application_config_supported(ob_device *device, ob_error **error);

OB_EXPORT void ob_application_config_reset(ob_application_config *config, ob_error **error);

OB_EXPORT void ob_application_config_set_bool(ob_application_config *config, OBAppConfigItem item, bool value, ob_error **error);

OB_EXPORT bool ob_application_config_get_bool(const ob_application_config *config, OBAppConfigItem item, ob_error **error);

OB_EXPORT void ob_application_config_set_int(ob_application_config *config, OBAppConfigItem item, int32_t value, ob_error **error);

OB_EXPORT int32_t ob_application_config_get_int(const ob_application_config *config, OBAppConfigItem item, ob_error **error);

OB_EXPORT void ob_application_config_set_float(ob_application_config *config, OBAppConfigItem item, float value, ob_error **error);

OB_EXPORT float ob_application_config_get_float(const ob_application_config *config, OBAppConfigItem item, ob_error **error);

OB_EXPORT void ob_application_config_set_string(ob_application_config *config, OBAppConfigItem item, const char *value, ob_error **error);

OB_EXPORT const char *ob_application_config_get_string(const ob_application_config *config, OBAppConfigItem item, ob_error **error);

OB_EXPORT void ob_application_config_set_struct(ob_application_config *config, OBAppConfigItem item, const void *value, uint32_t valueSize, ob_error **error);

OB_EXPORT void ob_application_config_get_struct(const ob_application_config *config, OBAppConfigItem item, void *value, uint32_t valueSize, ob_error **error);

OB_EXPORT void ob_application_config_set_profile(ob_application_config *config, OBAppConfigItem item, const ob_stream_profile *profile, ob_error **error);

OB_EXPORT ob_stream_profile *ob_application_config_get_profile(const ob_application_config *config, OBAppConfigItem item, ob_error **error);

OB_EXPORT uint32_t ob_application_config_get_count(const ob_application_config *config, OBAppConfigKey key, ob_error **error);
 
#ifdef __cplusplus
}
#endif