Filter.h

Go to the documentation of this file.

// Copyright (c) Orbbec Inc. All Rights Reserved.
// Licensed under the MIT License.

#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ObTypes.h"

OB_EXPORT ob_filter *ob_create_filter(const char *name, ob_error **error);

OB_EXPORT const char *ob_filter_get_name(const ob_filter *filter, ob_error **error);

OB_EXPORT const char *ob_filter_get_vendor_specific_code(const char *name, ob_error **error);

OB_EXPORT ob_filter *ob_create_private_filter(const char *name, const char *activation_key, ob_error **error);

OB_EXPORT void ob_delete_filter(ob_filter *filter, ob_error **error);

OB_EXPORT const char *ob_filter_get_config_schema(const ob_filter *filter, ob_error **error);

OB_EXPORT ob_filter_config_schema_list *ob_filter_get_config_schema_list(const ob_filter *filter, ob_error **error);

OB_EXPORT void ob_delete_filter_config_schema_list(ob_filter_config_schema_list *config_schema_list, ob_error **error);

OB_EXPORT void ob_filter_update_config(ob_filter *filter, uint8_t argc, const char **argv, ob_error **error);

OB_EXPORT double ob_filter_get_config_value(const ob_filter *filter, const char *config_name, ob_error **error);

OB_EXPORT void ob_filter_set_config_value(ob_filter *filter, const char *config_name, double value, ob_error **error);

OB_EXPORT void ob_filter_reset(ob_filter *filter, ob_error **error);

OB_EXPORT void ob_filter_enable(ob_filter *filter, bool enable, ob_error **error);

OB_EXPORT bool ob_filter_is_enabled(const ob_filter *filter, ob_error **error);

OB_EXPORT ob_frame *ob_filter_process(ob_filter *filter, const ob_frame *frame, ob_error **error);

OB_EXPORT void ob_filter_set_callback(ob_filter *filter, ob_filter_callback callback, void *user_data, ob_error **error);

OB_EXPORT void ob_filter_push_frame(ob_filter *filter, const ob_frame *frame, ob_error **error);

OB_EXPORT uint32_t ob_filter_list_get_count(const ob_filter_list *filter_list, ob_error **error);

OB_EXPORT ob_filter *ob_filter_list_get_filter(const ob_filter_list *filter_list, uint32_t index, ob_error **error);

OB_EXPORT void ob_delete_filter_list(ob_filter_list *filter_list, ob_error **error);

OB_EXPORT uint32_t ob_filter_config_schema_list_get_count(const ob_filter_config_schema_list *config_schema_list, ob_error **error);

OB_EXPORT ob_filter_config_schema_item ob_filter_config_schema_list_get_item(const ob_filter_config_schema_list *config_schema_list, uint32_t index,
                                                                             ob_error **error);

OB_EXPORT void ob_align_filter_set_align_to_stream_profile(ob_filter *filter, const ob_stream_profile *align_to_stream_profile, ob_error **error);
 
// The following interfaces are deprecated and are retained here for compatibility purposes.
#define ob_get_filter ob_filter_list_get_filter
#define ob_get_filter_name ob_filter_get_name
 
#ifdef __cplusplus
}
#endif