ScanbotSDKPdfConfigurationTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/PDFConfigurationTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_PDFCONFIGURATIONTYPES_H
#define SCANBOTSDK_PDFCONFIGURATIONTYPES_H
 
 
#include <image_processing/ScanbotSDKParametricFilters.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_pdf_attributes_t scanbotsdk_pdf_attributes_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_create(
    const char* author,
    const char* creator,
    const char* title,
    const char* subject,
    const char* keywords,
    scanbotsdk_pdf_attributes_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_create_with_defaults(
    scanbotsdk_pdf_attributes_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_free(scanbotsdk_pdf_attributes_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_get_author(scanbotsdk_pdf_attributes_t* self, const char** author);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_set_author(scanbotsdk_pdf_attributes_t* self, const char* author);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_get_creator(scanbotsdk_pdf_attributes_t* self, const char** creator);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_set_creator(scanbotsdk_pdf_attributes_t* self, const char* creator);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_get_title(scanbotsdk_pdf_attributes_t* self, const char** title);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_set_title(scanbotsdk_pdf_attributes_t* self, const char* title);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_get_subject(scanbotsdk_pdf_attributes_t* self, const char** subject);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_set_subject(scanbotsdk_pdf_attributes_t* self, const char* subject);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_get_keywords(scanbotsdk_pdf_attributes_t* self, const char** keywords);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_attributes_set_keywords(scanbotsdk_pdf_attributes_t* self, const char* keywords);
 

typedef enum scanbotsdk_page_size_t {

    SCANBOTSDK_PAGE_SIZE_LETTER = 0,

    SCANBOTSDK_PAGE_SIZE_LEGAL = 1,

    SCANBOTSDK_PAGE_SIZE_A3 = 2,

    SCANBOTSDK_PAGE_SIZE_A4 = 3,

    SCANBOTSDK_PAGE_SIZE_A5 = 4,

    SCANBOTSDK_PAGE_SIZE_B4 = 5,

    SCANBOTSDK_PAGE_SIZE_B5 = 6,

    SCANBOTSDK_PAGE_SIZE_EXECUTIVE = 7,

    SCANBOTSDK_PAGE_SIZE_US4x6 = 8,

    SCANBOTSDK_PAGE_SIZE_US4x8 = 9,

    SCANBOTSDK_PAGE_SIZE_US5x7 = 10,

    SCANBOTSDK_PAGE_SIZE_COMM10 = 11,

    SCANBOTSDK_PAGE_SIZE_CUSTOM = 12,
 
} scanbotsdk_page_size_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_page_size_t_to_string(scanbotsdk_page_size_t value, const char** result);

typedef enum scanbotsdk_page_direction_t {

    SCANBOTSDK_PAGE_DIRECTION_PORTRAIT = 0,

    SCANBOTSDK_PAGE_DIRECTION_LANDSCAPE = 1,

    SCANBOTSDK_PAGE_DIRECTION_AUTO = 2,
 
} scanbotsdk_page_direction_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_page_direction_t_to_string(scanbotsdk_page_direction_t value, const char** result);

typedef enum scanbotsdk_page_fit_t {

    SCANBOTSDK_PAGE_FIT_FIT_IN = 0,

    SCANBOTSDK_PAGE_FIT_FILL_IN = 1,

    SCANBOTSDK_PAGE_FIT_STRETCH = 2,

    SCANBOTSDK_PAGE_FIT_NONE = 3,
 
} scanbotsdk_page_fit_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_page_fit_t_to_string(scanbotsdk_page_fit_t value, const char** result);

typedef enum scanbotsdk_resampling_method_t {

    SCANBOTSDK_RESAMPLING_METHOD_NONE = 0,

    SCANBOTSDK_RESAMPLING_METHOD_NEAREST = 1,

    SCANBOTSDK_RESAMPLING_METHOD_LINEAR = 2,

    SCANBOTSDK_RESAMPLING_METHOD_CUBIC = 3,

    SCANBOTSDK_RESAMPLING_METHOD_LANCZOS4 = 4,

    SCANBOTSDK_RESAMPLING_METHOD_AREA = 5,
 
} scanbotsdk_resampling_method_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_resampling_method_t_to_string(scanbotsdk_resampling_method_t value, const char** result);

typedef struct scanbotsdk_pdf_configuration_t scanbotsdk_pdf_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_create(
    scanbotsdk_pdf_attributes_t* attributes,
    scanbotsdk_page_size_t page_size,
    scanbotsdk_page_direction_t page_direction,
    scanbotsdk_page_fit_t page_fit,
    int dpi,
    int jpeg_quality,
    scanbotsdk_resampling_method_t resampling_method,
    scanbotsdk_parametric_filter_t* binarization_filter,
    scanbotsdk_pdf_configuration_t** result);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_create_with_defaults(
    scanbotsdk_pdf_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_free(scanbotsdk_pdf_configuration_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_get_attributes(scanbotsdk_pdf_configuration_t* self, scanbotsdk_pdf_attributes_t** attributes);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_set_attributes(scanbotsdk_pdf_configuration_t* self, scanbotsdk_pdf_attributes_t* attributes);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_get_page_size(scanbotsdk_pdf_configuration_t* self, scanbotsdk_page_size_t* page_size);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_set_page_size(scanbotsdk_pdf_configuration_t* self, scanbotsdk_page_size_t page_size);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_get_page_direction(scanbotsdk_pdf_configuration_t* self, scanbotsdk_page_direction_t* page_direction);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_set_page_direction(scanbotsdk_pdf_configuration_t* self, scanbotsdk_page_direction_t page_direction);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_get_page_fit(scanbotsdk_pdf_configuration_t* self, scanbotsdk_page_fit_t* page_fit);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_set_page_fit(scanbotsdk_pdf_configuration_t* self, scanbotsdk_page_fit_t page_fit);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_get_dpi(scanbotsdk_pdf_configuration_t* self, int* dpi);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_set_dpi(scanbotsdk_pdf_configuration_t* self, int dpi);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_get_jpeg_quality(scanbotsdk_pdf_configuration_t* self, int* jpeg_quality);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_set_jpeg_quality(scanbotsdk_pdf_configuration_t* self, int jpeg_quality);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_get_resampling_method(scanbotsdk_pdf_configuration_t* self, scanbotsdk_resampling_method_t* resampling_method);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_set_resampling_method(scanbotsdk_pdf_configuration_t* self, scanbotsdk_resampling_method_t resampling_method);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_get_binarization_filter(scanbotsdk_pdf_configuration_t* self, scanbotsdk_parametric_filter_t** binarization_filter);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_pdf_configuration_set_binarization_filter(scanbotsdk_pdf_configuration_t* self, scanbotsdk_parametric_filter_t* binarization_filter);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_PDFCONFIGURATIONTYPES_H */