ScanbotSDKOcrTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/OCRTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_OCRTYPES_H
#define SCANBOTSDK_OCRTYPES_H
 
 
#include <ScanbotSDKTypes.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <ScanbotSDKErrorCode.h>
#include <ScanbotSDKDefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 

typedef struct scanbotsdk_ocr_element_t scanbotsdk_ocr_element_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_free(scanbotsdk_ocr_element_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_get_text(scanbotsdk_ocr_element_t* self, const char** text);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_get_confidence(scanbotsdk_ocr_element_t* self, double* confidence);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_get_roi(scanbotsdk_ocr_element_t* self, scanbotsdk_pointf_t** roi);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_get_roi_size(scanbotsdk_ocr_element_t* self, size_t* size);
 

typedef struct scanbotsdk_glyph_t scanbotsdk_glyph_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glyph_create(
    const char* text,
    double confidence,
    scanbotsdk_pointf_t* roi,
    size_t roi_size,
    scanbotsdk_glyph_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glyph_free(scanbotsdk_glyph_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_is_scanbotsdk_glyph(scanbotsdk_ocr_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_as_scanbotsdk_glyph(scanbotsdk_ocr_element_t* object, scanbotsdk_glyph_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_glyph_as_scanbotsdk_ocr_element(scanbotsdk_glyph_t* object, scanbotsdk_ocr_element_t** result);
 

typedef struct scanbotsdk_word_t scanbotsdk_word_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_create(
    const char* text,
    double confidence,
    scanbotsdk_pointf_t* roi,
    size_t roi_size,
    scanbotsdk_glyph_t** glyphs,
    size_t glyphs_size,
    scanbotsdk_word_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_free(scanbotsdk_word_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_is_scanbotsdk_word(scanbotsdk_ocr_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_as_scanbotsdk_word(scanbotsdk_ocr_element_t* object, scanbotsdk_word_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_as_scanbotsdk_ocr_element(scanbotsdk_word_t* object, scanbotsdk_ocr_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_get_glyphs(scanbotsdk_word_t* self, scanbotsdk_glyph_t** glyphs, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_word_get_glyphs_size(scanbotsdk_word_t* self, size_t* size);
 

typedef struct scanbotsdk_line_t scanbotsdk_line_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_line_create(
    const char* text,
    double confidence,
    scanbotsdk_pointf_t* roi,
    size_t roi_size,
    scanbotsdk_word_t** words,
    size_t words_size,
    scanbotsdk_line_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_line_free(scanbotsdk_line_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_is_scanbotsdk_line(scanbotsdk_ocr_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_as_scanbotsdk_line(scanbotsdk_ocr_element_t* object, scanbotsdk_line_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_line_as_scanbotsdk_ocr_element(scanbotsdk_line_t* object, scanbotsdk_ocr_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_line_get_words(scanbotsdk_line_t* self, scanbotsdk_word_t** words, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_line_get_words_size(scanbotsdk_line_t* self, size_t* size);
 

typedef struct scanbotsdk_block_t scanbotsdk_block_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_block_create(
    const char* text,
    double confidence,
    scanbotsdk_pointf_t* roi,
    size_t roi_size,
    scanbotsdk_line_t** lines,
    size_t lines_size,
    scanbotsdk_block_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_block_free(scanbotsdk_block_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_is_scanbotsdk_block(scanbotsdk_ocr_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_as_scanbotsdk_block(scanbotsdk_ocr_element_t* object, scanbotsdk_block_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_block_as_scanbotsdk_ocr_element(scanbotsdk_block_t* object, scanbotsdk_ocr_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_block_get_lines(scanbotsdk_block_t* self, scanbotsdk_line_t** lines, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_block_get_lines_size(scanbotsdk_block_t* self, size_t* size);
 

typedef struct scanbotsdk_page_t scanbotsdk_page_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_page_create(
    const char* text,
    double confidence,
    scanbotsdk_pointf_t* roi,
    size_t roi_size,
    scanbotsdk_block_t** blocks,
    size_t blocks_size,
    scanbotsdk_page_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_page_free(scanbotsdk_page_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_is_scanbotsdk_page(scanbotsdk_ocr_element_t* object, bool* result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_ocr_element_as_scanbotsdk_page(scanbotsdk_ocr_element_t* object, scanbotsdk_page_t** result);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_page_as_scanbotsdk_ocr_element(scanbotsdk_page_t* object, scanbotsdk_ocr_element_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_page_get_blocks(scanbotsdk_page_t* self, scanbotsdk_block_t** blocks, size_t size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_page_get_blocks_size(scanbotsdk_page_t* self, size_t* size);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_OCRTYPES_H */