Layer

APDFL Plugins

4 components109 items

42 Functions 46 Definitions 2 Typedefs 5 Structures 14 Enums

ocrengine

61 items

Functions(27)

OCREngineInitialize

ASBool OCREngineInitialize(void)

OCREngineProcs.h:8

Initializes the OCREngine Plug-in.

Parameters

: void

Returns

ASBool

An ASBool value.

OCREngineTerminate

void OCREngineTerminate(void)

OCREngineProcs.h:14

Terminates the OCREngine Plug-in.

Parameters

: void

Returns

void

void.

PDOCRCreateEngine

OCREngine PDOCRCreateEngine(OCRParams params)

OCREngineProcs.h:33

Create an opaque OCREngine from the supplied parameters.

Parameters

params: OCRParams: IN OCRParams object used to configure the engine.

Returns

OCREngine

An OCREngine that must be released with PDOCRReleaseEngine.

Recognizes Text in a PDEImage, at a specified resolution, creating a PDEForm with the Image and Text underneath it. Knowing the image's resolution can enhance recognition. NOTE: Determining the resolution of the image is the caller's responsibility. Creates a PDEForm element containing the image, and additional text underneath. The PDEForm element has a transformation matrix which makes it directly substitutable for the image in a Content stream. The PDEForm will be created in the specified document, sharing fonts with the results of recognizing text in other images. If a font that will represent all the characters in a word can't be found, the missingFontStrategy will determine the behavior to employ.

Parameters

engine: OCREngine: IN OCREngine object
doc: PDDoc: IN PDDoc object
image: PDEImage
resolution: ASInt32: IN image resolution for PDEImage object, in DPI
strategy: OCRMissingFontStrategy: IN specifies the behavior to take if a Font isn't available to represent the Text

Returns

PDEForm

a PDEForm composing the supplied image with the recognized text underneath

PDOCRDefaultParams

OCRParams PDOCRDefaultParams(void)

OCREngineProcs.h:20

Return a reference to a set of OCRParams, already configured with defaults.

Parameters

: void

Returns

OCRParams

A fresh copy of the OCRParams.

PDOCRGetLanguagesInstalled

OCRLanguage * PDOCRGetLanguagesInstalled(void)

OCREngineProcs.h:73

Get the Languages installed as an array of OCRLanguage elements. This array isn't modifiable. The length is given by PDOCRGetNumLanguagesInstalled().

Parameters

: void

Returns

OCRLanguage *

an array of OCRLanguage elements.

PDOCRGetNumLanguagesInstalled

ASInt32 PDOCRGetNumLanguagesInstalled(void)

OCREngineProcs.h:65

Get the number of Languages installed.

Parameters

: void

Returns

ASInt32

number of languages installed.

PDOCRParamsGetCandidateFonts

ASAtom * PDOCRParamsGetCandidateFonts(OCRParams params)

OCREngineProcs.h:210

Get the Candidate Fonts used to try to match recognized text, as an array of ASAtoms. Each ASAtom represents a name for a font to try to use for text recognition. The default list should work well in most cases. If you're using text that isn't represented by Latin fonts, or by Chinese, Japanese, or Korean fonts, then retrieve this list, add the font that can represent that text, then set that new list on OCRParams. Enough font names must be supplied to cover the expected languages/scripts in use. The code selects a font to represent each word. If a word code-switches between different scripts, for instance, if it contains non-Latin text and Arabic numerals, then make sure to supply the name of a font family that can handle both the text and the numerals. The quality of the results depends on the font choice. The list is searched in order until a font works for a particular word. To make the text fit better, it's recommended to list proportional fonts before fixed-width fonts. Decorative fonts with flourishes, like Zapf Chancery, deliver poor results. Generally, supply a font that would be used in block text, such as in a newspaper or work of literature, such as Times Roman, or a font already in the list, like MinionPro. If the PDOCRCreateForm() function can't identify a font that covers the whole text of a word, it will follow the policy set by the OCRMissingFontStrategy parameter. Each element is an ASAtom corresponding to a string representing a candidate font. This array can only be modified by calling PDOCRParamsSetCandidateFonts(). The length is given by PDOCRParamsGetNumCandidateFonts().

Parameters

params: OCRParams: IN OCRParams object

Returns

ASAtom *

an array of ASAtoms

PDOCRParamsGetConfigParameterCount

ASInt32 PDOCRParamsGetConfigParameterCount(OCRParams params)

OCREngineProcs.h:278

Get the number of engine-specific configuration parameters currently set.

Parameters

params: OCRParams: IN OCRParams object to query.

Returns

ASInt32

Number of key-value pairs, or 0 if params is NULL.

PDOCRParamsGetConfigParameterKey

const char * PDOCRParamsGetConfigParameterKey(OCRParams params, ASInt32 index)

OCREngineProcs.h:287

Get an engine-specific configuration parameter key by index.

Parameters

params: OCRParams: IN OCRParams object to query.
index: ASInt32: IN Index of the parameter (0 to count-1).

Returns

const char *

The key string, or NULL if params is NULL or index is out of range.

PDOCRParamsGetConfigParameterValue

const char * PDOCRParamsGetConfigParameterValue(OCRParams params, ASInt32 index)

OCREngineProcs.h:296

Get an engine-specific configuration parameter value by index.

Parameters

params: OCRParams: IN OCRParams object to query.
index: ASInt32: IN Index of the parameter (0 to count-1).

Returns

const char *

The value string, or NULL if params is NULL or index is out of range.

PDOCRParamsGetLanguagesConfigured

OCRLanguage * PDOCRParamsGetLanguagesConfigured(OCRParams params)

OCREngineProcs.h:142

Get the Languages configured to be recognized, as an array of OCRLanguage elements. This array can only be modified by calling PDOCRParamsSetLanguagesConfigured(). The length is given by PDOCRParamsGetNumLanguagesConfigured().

Parameters

params: OCRParams: IN OCRParams object

Returns

OCRLanguage *

an array of OCRLanguage elements.

PDOCRParamsGetNumCandidateFonts

ASInt32 PDOCRParamsGetNumCandidateFonts(OCRParams params)

OCREngineProcs.h:177

Get the Number of Candidate Fonts to try to match recognized text. The default list should work well in most cases. If you're using text that isn't represented by Latin fonts, or by Chinese, Japanese, or Korean fonts, then retrieve this list, add the font that can represent that text, then set that new list on OCRParams. Enough font names must be supplied to cover the expected languages/scripts in use. The code selects a font to represent each word. If a word code-switches between different scripts, for instance, if it contains non-Latin text and Arabic numerals, then make sure to supply the name of a font family that can handle both the text and the numerals. The quality of the results depends on the font choice. The list is searched in order until a font works for a particular word. To make the text fit better, it's recommended to list proportional fonts before fixed-width fonts. Decorative fonts with flourishes, like Zapf Chancery, deliver poor results. Generally, supply a font that would be used in block text, such as in a newspaper or work of literature, such as Times Roman, or a font already in the list, like MinionPro. If the PDOCRCreateForm() function can't identify a font that covers the whole text of a word, it will follow the policy set by the OCRMissingFontStrategy parameter.

Parameters

params: OCRParams: IN OCRParams object

Returns

ASInt32

the number of candidate font members in the OCRParams

PDOCRParamsGetNumLanguagesConfigured

ASInt32 PDOCRParamsGetNumLanguagesConfigured(OCRParams params)

OCREngineProcs.h:132

Get the Number of Languages configured to be recognized.

Parameters

params: OCRParams: IN OCRParams object

Returns

ASInt32

the number of languages currently configured in the OCRParams object

PDOCRParamsGetPageSegmentationMode

OCRPageSegmentationMode PDOCRParamsGetPageSegmentationMode(OCRParams params)

OCREngineProcs.h:116

Get the page segmentation mode parameter for an OCRParams object. Specifies how the OCR engine will view the page, and how it detects text segments.

Parameters

params: OCRParams: IN OCRParams object

Returns

OCRPageSegmentationMode

the OCRPageSegmentationMode value set in the OCRParams object.

PDOCRParamsGetPerformance

OCRPerformance PDOCRParamsGetPerformance(OCRParams params)

OCREngineProcs.h:80

Get the performance parameter from an OCRParams object.

Parameters

params: OCRParams: IN OCRParams object

Returns

OCRPerformance

the OCRPerformance value set in the OCRParams object.

PDOCRParamsGetPreprocessing

ASBool PDOCRParamsGetPreprocessing(OCRParams params)

OCREngineProcs.h:97

Get the Preprocessing setting. Indicates if image preprocessing (including rescaling, denoising, and deskewing) is enabled before OCR to improve character recognition.

Parameters

params: OCRParams: IN OCRParams object

Returns

ASBool

the state of the preprocess flag

PDOCRParamsResetConfigParameters

void PDOCRParamsResetConfigParameters(OCRParams params)

OCREngineProcs.h:270

Clear all previously set engine-specific configuration parameters.

Parameters

params: OCRParams: IN OCRParams object to be modified.

Returns

void

PDOCRParamsSetCandidateFonts

void PDOCRParamsSetCandidateFonts(OCRParams params, ASAtom *fonts, ASInt32 numFonts)

OCREngineProcs.h:240

Set the Candidate Fonts used to try to match recognized text. The default list should work well in most cases. If you're using text that isn't represented by Latin fonts, or by Chinese, Japanese, or Korean fonts, then retrieve this list, add the font that can represent that text, then set that new list on OCRParams. Enough font names must be supplied to cover the expected languages/scripts in use. The code selects a font to represent each word. If a word code-switches between different scripts, for instance, if it contains non-Latin text and Arabic numerals, then make sure to supply the name of a font family that can handle both the text and the numerals. The quality of the results depends on the font choice. The list is searched in order until a font works for a particular word. To make the text fit better, it's recommended to list proportional fonts before fixed-width fonts. Decorative fonts with flourishes, like Zapf Chancery, deliver poor results. Generally, supply a font that would be used in block text, such as in a newspaper or work of literature, such as Times Roman, or a font already in the list, like MinionPro. If the PDOCRCreateForm() function can't identify a font that covers the whole text of a word, it will follow the policy set by the OCRMissingFontStrategy parameter. Each element is an ASAtom corresponding to a string representing a candidate font.

Parameters

params: OCRParams: IN OCRParams object
fonts: ASAtom *: IN an array of ASAtoms to set as candidate fonts
numFonts: ASInt32: the size of the fonts array

Returns

void

PDOCRParamsSetConfigParameter

ASBool PDOCRParamsSetConfigParameter(OCRParams params, const char *key, const char *value)

OCREngineProcs.h:263

Set an engine-specific configuration parameter. Multiple calls accumulate parameters. Calling with the same key replaces the previous value. These parameters are passed through to the underlying OCR engine (e.g., Tesseract) as engine-specific settings. See the OCR engine documentation for valid parameter names and values.

Parameters

params: OCRParams: IN OCRParams object to be modified.
key: const char *: IN Parameter name (will be copied). Must not be NULL.
value: const char *: IN Parameter value (will be copied). Must not be NULL.

Returns

ASBool

true on success, false on failure (e.g., NULL params/key/value or memory allocation failure).

PDOCRParamsSetLanguagesConfigured

void PDOCRParamsSetLanguagesConfigured(OCRParams params, OCRLanguage *languages, ASInt32 numLanguages)

OCREngineProcs.h:150

Set the Languages configured to be recognized, as an array of OCRLanguage elements.

Parameters

params: OCRParams: IN OCRParams object
languages: OCRLanguage *: IN languages to configure OCREngine with
numLanguages: ASInt32: the size of the languages array

Returns

void

PDOCRParamsSetPageSegmentationMode

void PDOCRParamsSetPageSegmentationMode(OCRParams params, OCRPageSegmentationMode pageSegmentationMode)

OCREngineProcs.h:125

Set the page segementation mode parameter for an OCRParams object. Specifies how the OCR engine will view the page, and how it detects text segments.

Parameters

params: OCRParams: IN OCRParams object to be modified.
pageSegmentationMode: OCRPageSegmentationMode

Returns

void

PDOCRParamsSetPerformance

void PDOCRParamsSetPerformance(OCRParams params, OCRPerformance performance)

OCREngineProcs.h:87

Set the performance parameter for an OCRParams object.

Parameters

params: OCRParams: IN OCRParams object to be modified.
performance: OCRPerformance: IN the OCRPerformance value to set on the OCRParams object.

Returns

void

PDOCRParamsSetPreprocessing

void PDOCRParamsSetPreprocessing(OCRParams params, ASBool preprocessing)

OCREngineProcs.h:107

Set the Preprocessing setting. Indicates if image preprocessing (including rescaling, denoising, and deskewing) is enabled before OCR to improve character recognition.

Parameters

params: OCRParams: IN OCRParams object
preprocessing: ASBool: IN whether to preprocess before OCR

Returns

void

PDOCRRecognizePage

void PDOCRRecognizePage(PDPage page, OCREngine engine, OCRMissingFontStrategy strategy)

OCREngineProcs.h:249

Run optical character recognition (OCR) on a page.

Parameters

page: PDPage: IN The page being OCR'd
engine: OCREngine: IN Configured OCREngine object
strategy: OCRMissingFontStrategy: IN specifies the behavior to take if a Font isn't available to represent the Text

Returns

void

PDOCRReleaseEngine

void PDOCRReleaseEngine(OCREngine engine)

OCREngineProcs.h:39

Release an OCREngine created with PDOCRCreateEngine.

Parameters

engine: OCREngine: IN OCREngine to be released.

Returns

void

PDOCRReleaseParams

void PDOCRReleaseParams(OCRParams params)

OCREngineProcs.h:26

Release an OCRParams obtained with PDOCRDefaultParams.

Parameters

params: OCRParams: IN OCRParams object to be released.

Returns

void

Structures(2)

OCREngine

typedef struct _t_OCREngineRec* OCREngine

OCREngineExpT.h:205

OCRParams

typedef struct _t_OCRParamsRec* OCRParams

OCREngineExpT.h:203

Enums(4)

OCRLanguage

OCREngineExpT.h:70

Enumeration to specify the language.

Values

OCRLanguage_English
OCRLanguage_Dutch
OCRLanguage_French
OCRLanguage_German
OCRLanguage_Italian
OCRLanguage_Portuguese
OCRLanguage_Spanish
OCRLanguage_Arabic
OCRLanguage_Armenian
OCRLanguage_ChineseTraditional
OCRLanguage_ChineseTraditionalVertical
OCRLanguage_ChineseSimplified
OCRLanguage_ChineseSimplifiedVertical
OCRLanguage_Japanese
OCRLanguage_JapaneseVertical
OCRLanguage_Korean
OCRLanguage_KoreanVertical
OCRLanguage_Afrikaans
OCRLanguage_Amharic
OCRLanguage_Assamese
OCRLanguage_Azerbaijani
OCRLanguage_AzerbaijaniCyrillic
OCRLanguage_Belarusian
OCRLanguage_Bengali
OCRLanguage_Tibetan
OCRLanguage_Bosnian
OCRLanguage_Breton
OCRLanguage_Bulgarian
OCRLanguage_Catalan
OCRLanguage_Corsican
OCRLanguage_Cebuano
OCRLanguage_Czech
OCRLanguage_Cherokee
OCRLanguage_Welsh
OCRLanguage_Danish
OCRLanguage_DanishFraktur
OCRLanguage_Dhivehi
OCRLanguage_Dzongkha
OCRLanguage_Greek
OCRLanguage_EnglishMiddle
OCRLanguage_Esperanto
OCRLanguage_MathEquationDetection
OCRLanguage_Estonian
OCRLanguage_Faroese
OCRLanguage_Basque
OCRLanguage_Persian
OCRLanguage_Finnish
OCRLanguage_Filipino
OCRLanguage_GermanFraktur
OCRLanguage_FrenchMiddle
OCRLanguage_Frisian
OCRLanguage_Irish
OCRLanguage_Galician
OCRLanguage_ScotsGaelic
OCRLanguage_GreekAncient
OCRLanguage_Gujarati
OCRLanguage_Haitian
OCRLanguage_Hebrew
OCRLanguage_Hindi
OCRLanguage_Croatian
OCRLanguage_Hungarian
OCRLanguage_Inuktitut
OCRLanguage_Indonesian
OCRLanguage_Icelandic
OCRLanguage_ItalianOld
OCRLanguage_Javanese
OCRLanguage_Kannada
OCRLanguage_Georgian
OCRLanguage_GeorgianOld
OCRLanguage_Kazakh
OCRLanguage_CentralKhmer
OCRLanguage_Kyrgyz
OCRLanguage_Kurmanji
OCRLanguage_KurdishArabicScript
OCRLanguage_Lao
OCRLanguage_Latin
OCRLanguage_Latvian
OCRLanguage_Lithuanian
OCRLanguage_Luxembourgish
OCRLanguage_Malayalam
OCRLanguage_Marathi
OCRLanguage_Macedonian
OCRLanguage_Maltese
OCRLanguage_Mongolian
OCRLanguage_Maori
OCRLanguage_Malay
OCRLanguage_Burmese
OCRLanguage_Nepali
OCRLanguage_Norwegian
OCRLanguage_Occitan
OCRLanguage_Oriya
OCRLanguage_OrientationAndScriptDetection
OCRLanguage_Panjabi
OCRLanguage_Polish
OCRLanguage_Pashto
OCRLanguage_Quechua
OCRLanguage_Romanian
OCRLanguage_Russian
OCRLanguage_Sanskrit
OCRLanguage_Sinhala
OCRLanguage_Slovak
OCRLanguage_SlovakFraktur
OCRLanguage_Slovenian
OCRLanguage_Sindhi
OCRLanguage_SpanishOld
OCRLanguage_Albanian
OCRLanguage_Serbian
OCRLanguage_SerbianLatin
OCRLanguage_Sundanese
OCRLanguage_Swahili
OCRLanguage_Swedish
OCRLanguage_Syriac
OCRLanguage_Tamil
OCRLanguage_Tatar
OCRLanguage_Telugu
OCRLanguage_Tajik
OCRLanguage_Tagalog
OCRLanguage_Thai
OCRLanguage_Tigrinya
OCRLanguage_Tonga
OCRLanguage_Turkish
OCRLanguage_Uyghur
OCRLanguage_Ukrainian
OCRLanguage_Urdu
OCRLanguage_Uzbek
OCRLanguage_UzbekCyrillic
OCRLanguage_Vietnamese
OCRLanguage_Yiddish
OCRLanguage_Yoruba
OCRLanguage_None

OCRMissingFontStrategy

OCREngineExpT.h:12

Enumeration to specify how to handle missing fonts during OCR.

Values

OCRMissingFontStrategy_Raise: Raise an exception.
OCRMissingFontStrategy_Ignore: Ignore the missing font and continue recognizing the next word of text.
OCRMissingFontStrategy_ReplacementText: Replace the characters of text with the Unicode replacement Character. NOTE: the CandidateFontsNames member of the OCRParams instance must include a Font that can represent this character or an exception will be raised.

OCRPageSegmentationMode

OCREngineExpT.h:40

Enumeration to specify how the OCR engine will view the page, and how it detects text segments.

Values

OCRPageSegmentationMode_OSDOnly: Orientation and script detection (OSD).
OCRPageSegmentationMode_AutomaticOSD: Automatic page segmentation with OSD.
OCRPageSegmentationMode_Automatic: Automatic without OSD.
OCRPageSegmentationMode_SingleColumn: Assume a single column of text.
OCRPageSegmentationMode_SingleBlockVertical: Assume a single block of vertically aligned text.
OCRPageSegmentationMode_SingleBlock: Assume a single block of text.
OCRPageSegmentationMode_SingleLine: Assume a single line of text.
OCRPageSegmentationMode_SingleWord: Assume a single word.
OCRPageSegmentationMode_CircleWord: Assume a single word in a circle.
OCRPageSegmentationMode_SingleChar: Assume a single char.
OCRPageSegmentationMode_SparseText: Find all text in no particular order.
OCRPageSegmentationMode_SparseTextOSD: Sparse text with OSD.
OCRPageSegmentationMode_RawLine: Treat as a raw line with no input processing.

OCRPerformance

OCREngineExpT.h:24

Enumeration to specify OCR performance.

Values

OCRPerformance_Default: Default performance.
The default performance is useful for most scenarios and is a reasonable tradeoff of speed vs. accuracy, thus suitable for most languages.
OCRPerformance_Accuracy: Blend accuracy with speed.
OCRPerformance_MoreAccuracy: Favor accuracy over speed.
OCRPerformance_BestAccuracy: Best possible accuracy.

Definitions(28)

OCREngineHFT_NAME

OCREngineCalls.h:9

Value:"DLGS:OCREngine"

OCREngineInitialize

OCREngineCalls.h:56

Value:(*((OCREngineInitializeSELPROTO)(gOCREngineHFT[OCREngineInitializeSEL])))

OCREngineTerminate

OCREngineCalls.h:59

Value:(*((OCREngineTerminateSELPROTO)(gOCREngineHFT[OCREngineTerminateSEL])))

PDOCRCreateEngine

OCREngineCalls.h:65

Value:(*((PDOCRCreateEngineSELPROTO)(gOCREngineHFT[PDOCRCreateEngineSEL])))

PDOCRCreateForm

OCREngineCalls.h:69

Value:(*((PDOCRCreateFormSELPROTO)(gOCREngineHFT[PDOCRCreateFormSEL])))

PDOCRDefaultParams

OCREngineCalls.h:61

Value:(*((PDOCRDefaultParamsSELPROTO)(gOCREngineHFT[PDOCRDefaultParamsSEL])))

PDOCRGetLanguagesInstalled

OCREngineCalls.h:74

Value:(*((PDOCRGetLanguagesInstalledSELPROTO)(gOCREngineHFT[PDOCRGetLanguagesInstalledSEL])))

PDOCRGetNumLanguagesInstalled

OCREngineCalls.h:71

Value:(*((PDOCRGetNumLanguagesInstalledSELPROTO)(gOCREngineHFT[PDOCRGetNumLanguagesInstalledSEL])))

PDOCRParamsGetCandidateFonts

OCREngineCalls.h:107

Value:(*((PDOCRParamsGetCandidateFontsSELPROTO)(gOCREngineHFT[PDOCRParamsGetCandidateFontsSEL])))

PDOCRParamsGetConfigParameterCount

OCREngineCalls.h:121

Value:(*((PDOCRParamsGetConfigParameterCountSELPROTO)(gOCREngineHFT[PDOCRParamsGetConfigParameterCountSEL])))

PDOCRParamsGetConfigParameterKey

OCREngineCalls.h:124

Value:(*((PDOCRParamsGetConfigParameterKeySELPROTO)(gOCREngineHFT[PDOCRParamsGetConfigParameterKeySEL])))

PDOCRParamsGetConfigParameterValue

OCREngineCalls.h:127

Value:(*((PDOCRParamsGetConfigParameterValueSELPROTO)(gOCREngineHFT[PDOCRParamsGetConfigParameterValueSEL])))

PDOCRParamsGetLanguagesConfigured

OCREngineCalls.h:98

Value:(*((PDOCRParamsGetLanguagesConfiguredSELPROTO)(gOCREngineHFT[PDOCRParamsGetLanguagesConfiguredSEL])))

PDOCRParamsGetNumCandidateFonts

OCREngineCalls.h:104

Value:(*((PDOCRParamsGetNumCandidateFontsSELPROTO)(gOCREngineHFT[PDOCRParamsGetNumCandidateFontsSEL])))

PDOCRParamsGetNumLanguagesConfigured

OCREngineCalls.h:95

Value:(*((PDOCRParamsGetNumLanguagesConfiguredSELPROTO)(gOCREngineHFT[PDOCRParamsGetNumLanguagesConfiguredSEL])))

PDOCRParamsGetPageSegmentationMode

OCREngineCalls.h:83

Value:(*((PDOCRParamsGetPageSegmentationModeSELPROTO)(gOCREngineHFT[PDOCRParamsGetPageSegmentationModeSEL])))

PDOCRParamsGetPerformance

OCREngineCalls.h:77

Value:(*((PDOCRParamsGetPerformanceSELPROTO)(gOCREngineHFT[PDOCRParamsGetPerformanceSEL])))

PDOCRParamsGetPreprocessing

OCREngineCalls.h:89

Value:(*((PDOCRParamsGetPreprocessingSELPROTO)(gOCREngineHFT[PDOCRParamsGetPreprocessingSEL])))

PDOCRParamsResetConfigParameters

OCREngineCalls.h:118

Value:(*((PDOCRParamsResetConfigParametersSELPROTO)(gOCREngineHFT[PDOCRParamsResetConfigParametersSEL])))

PDOCRParamsSetCandidateFonts

OCREngineCalls.h:110

Value:(*((PDOCRParamsSetCandidateFontsSELPROTO)(gOCREngineHFT[PDOCRParamsSetCandidateFontsSEL])))

PDOCRParamsSetConfigParameter

OCREngineCalls.h:115

Value:(*((PDOCRParamsSetConfigParameterSELPROTO)(gOCREngineHFT[PDOCRParamsSetConfigParameterSEL])))

PDOCRParamsSetLanguagesConfigured

OCREngineCalls.h:101

Value:(*((PDOCRParamsSetLanguagesConfiguredSELPROTO)(gOCREngineHFT[PDOCRParamsSetLanguagesConfiguredSEL])))

PDOCRParamsSetPageSegmentationMode

OCREngineCalls.h:86

Value:(*((PDOCRParamsSetPageSegmentationModeSELPROTO)(gOCREngineHFT[PDOCRParamsSetPageSegmentationModeSEL])))

PDOCRParamsSetPerformance

OCREngineCalls.h:80

Value:(*((PDOCRParamsSetPerformanceSELPROTO)(gOCREngineHFT[PDOCRParamsSetPerformanceSEL])))

PDOCRParamsSetPreprocessing

OCREngineCalls.h:92

Value:(*((PDOCRParamsSetPreprocessingSELPROTO)(gOCREngineHFT[PDOCRParamsSetPreprocessingSEL])))

PDOCRRecognizePage

OCREngineCalls.h:113

Value:(*((PDOCRRecognizePageSELPROTO)(gOCREngineHFT[PDOCRRecognizePageSEL])))

PDOCRReleaseEngine

OCREngineCalls.h:67

Value:(*((PDOCRReleaseEngineSELPROTO)(gOCREngineHFT[PDOCRReleaseEngineSEL])))

PDOCRReleaseParams

OCREngineCalls.h:63

Value:(*((PDOCRReleaseParamsSELPROTO)(gOCREngineHFT[PDOCRReleaseParamsSEL])))

pdflattener

20 items

Functions(6)

PDFlattenerConvert

ASBool PDFlattenerConvert(PDDoc aPDDoc, PDFlatten flattenParams, float transQuality, ASUns32 firstPage, ASUns32 lastPage, ASUns32 *numFlattenedPages, ASUns32 flags)

PDFlattenerProcs.h:37

Flatten a PDF file.

Parameters

aPDDoc: PDDoc: The input PDDoc which we want to Flatten. The output will be in the same PDDoc.
flattenParams: PDFlatten: Input parameters for flattening.
transQuality: float
firstPage: ASUns32: The first page of aPDDoc which we want to Flatten.
lastPage: ASUns32: The last page of aPDDoc which we want to Flatten.
numFlattenedPages: ASUns32 *: set to the number of pages that are flattened.
flags: ASUns32: Kept for future use. Default to 0.

Returns

ASBool

1 on success.

PDFlattenerConvertEx

ASBool PDFlattenerConvertEx(PDDoc aPDDoc, PDFlatten flattenParams, float transQuality, ASUns32 firstPage, ASUns32 lastPage, ASUns32 *numFlattenedPages, ASUns32 flags, FlattenProgressMonitor FlattenProgress, void *progressClientData)

PDFlattenerProcs.h:58

Flatten a PDF file.

Parameters

aPDDoc: PDDoc: The input PDDoc which we want to Flatten. The output will be in the same PDDoc.
flattenParams: PDFlatten: Input parameters for flattening.
transQuality: float
firstPage: ASUns32: The first page of aPDDoc which we want to Flatten.
lastPage: ASUns32: The last page of aPDDoc which we want to Flatten.
numFlattenedPages: ASUns32 *: set to the number of pages that are flattened.
flags: ASUns32: Kept for future use. Default to 0.
FlattenProgress: FlattenProgressMonitor: the callback which we want to register with the plug-in.
progressClientData: void *: any client data which client wants to get back with the callback for its own reference.

Returns

ASBool

1 on success.

PDFlattenerConvertEx2

ASBool PDFlattenerConvertEx2(PDDoc aPDDoc, ASUns32 firstPage, ASUns32 lastPage, ASUns32 *numFlattenedPages, PDFlattenerUserParams userParams)

PDFlattenerProcs.h:69

Flatten a PDF file.

Parameters

aPDDoc: PDDoc: The input PDDoc which we want to Flatten. The output will be in the same PDDoc.
firstPage: ASUns32: The first page of aPDDoc which we want to Flatten.
lastPage: ASUns32: The last page of aPDDoc which we want to Flatten.
numFlattenedPages: ASUns32 *: set to the number of pages that are flattened.
userParams: PDFlattenerUserParams: A structure object defined for user set parameters e.g flattenParams, transquality, Blending Colorspace profile, progress monitor and Compression Settings.

Returns

ASBool

1 on success.

PDFlattenerConvertEx3

ASBool PDFlattenerConvertEx3(PDDoc aPDDoc, ASUns32 firstPage, ASUns32 lastPage, ASUns32 *numFlattenedPages, PDFlattenerUserParams userParams, ASBool embedFlattenerProfiles)

PDFlattenerProcs.h:81

Flatten a PDF file.

Parameters

aPDDoc: PDDoc: The input PDDoc which we want to Flatten. The output will be in the same PDDoc.
firstPage: ASUns32: The first page of aPDDoc which we want to Flatten.
lastPage: ASUns32: The last page of aPDDoc which we want to Flatten.
numFlattenedPages: ASUns32 *: set to the number of pages that are flattened.
userParams: PDFlattenerUserParams: A structure object defined for user set parameters e.g flattenParams, transquality, Blending Colorspace profile, progress monitor and Compression Settings.
embedFlattenerProfiles: ASBool: embed Flattener color profiles.

Returns

ASBool

1 on success.

PDFlattenerInitialize

ASBool PDFlattenerInitialize(void)

PDFlattenerProcs.h:25

Initialises the PDFlattener Plug-in.

Parameters

: void

Returns

ASBool

An ASBool value.

PDFlattenerTerminate

void PDFlattenerTerminate(void)

PDFlattenerProcs.h:44

Terminates the PDFlattener Plug-in.

Parameters

: void

Returns

void

void.

Typedefs(1)

FlattenProgressMonitor

typedef ASBool(* FlattenProgressMonitor) (ASInt32 pageNum, ASInt32 totalPages, float current, ASInt32 reserved, void *clientData))(ASInt32 pageNum, ASInt32 totalPages, float current, ASInt32 reserved, void *clientData)

PDFlattenerExpT.h:91

Prototype of the callback which is registered by the client with the plug-in

Structures(1)

PDFlattenerUserParams

typedef struct PDFlattenerUserParamsRec * PDFlattenerUserParams

PDFlattenerExpT.h:154

Enums(5)

PDFlattenerColorCompSet

PDFlattenerExpT.h:27

Enumeration for setting compression scheme for flattened color images.

Values

kPDFlattenerJpegCompression
kPDFlattenerZipCompression
kPDFlattenerJpeg2000Compression

PDFlattenerGrayscaleCompSet

PDFlattenerExpT.h:36

Enumeration for setting the compression scheme for the Flattened Grayscale images.

Values

kPDFlattenerGrayJpegCompression
kPDFlattenerGrayZipCompression
kPDFlattenerGrayJpeg2000Compression

PDFlattenerMonochromeCompSet

PDFlattenerExpT.h:45

Enumeration for setting the compression scheme for the Flattened Monochrome images.

Values

kPDFlattenerMonoCCITTGroup3Compression
kPDFlattenerMonoCCITTGroup4Compression
kPDFlattenerMonoZipCompression
kPDFlattenerMonoRunLengthCompression

PDFlattenerQualitySetting

PDFlattenerExpT.h:55

Enumeration for setting the Quality setting for the JPEG or JPEG2000 images.

Values

kPDFlattenerMinimum
kPDFlattenerLow
kPDFlattenerMedium
kPDFlattenerHigh
kPDFlattenerMaximum
kPDFlattenerJpeg2000Lossless

kPDFlattenerFlags

PDFlattenerExpT.h:184

Values

kPDFlattenerCompressColorImagesZIP: Setting this flag will choose the ZIP compression scheme (Flate encoding) for compressing the color images. Otherwise we will stick to the current default behavior and try to use JPEG compression wherever possible.

Definitions(7)

PDFlattenerConvert

PDFlattenerCalls.h:139

Value:(*((PDFlattenerConvertSELPROTO)(gPDFlattenerHFT[PDFlattenerConvertSEL])))

PDFlattenerConvertEx

PDFlattenerCalls.h:144

Value:(*((PDFlattenerConvertExSELPROTO)(gPDFlattenerHFT[PDFlattenerConvertExSEL])))

PDFlattenerConvertEx2

PDFlattenerCalls.h:147

Value:(*((PDFlattenerConvertEx2SELPROTO)(gPDFlattenerHFT[PDFlattenerConvertEx2SEL])))

PDFlattenerConvertEx3

PDFlattenerCalls.h:150

Value:(*((PDFlattenerConvertEx3SELPROTO)(gPDFlattenerHFT[PDFlattenerConvertEx3SEL])))

PDFlattenerHFT_NAME

PDFlattenerCalls.h:82

Value:"ADBE:PDFlattener"

PDFlattenerInitialize

PDFlattenerCalls.h:136

Value:(*((PDFlattenerInitializeSELPROTO)(gPDFlattenerHFT[PDFlattenerInitializeSEL])))

PDFlattenerTerminate

PDFlattenerCalls.h:141

Value:(*((PDFlattenerTerminateSELPROTO)(gPDFlattenerHFT[PDFlattenerTerminateSEL])))

pdfprocessor

21 items

Functions(6)

PDFProcessorConvertAndSaveToPDFA

ASBool PDFProcessorConvertAndSaveToPDFA(PDDoc srcPDDoc, ASPathName outputFilePath, ASFileSys outputFileSystem, PDFProcessorPDFAConversionOption option, PDFProcessorPDFAConvertParams userParams)

PDFProcessorProcs.h:36

Processes a PDF file, converts it to a PDF/A standard, and saves the output document to disk .

Parameters

srcPDDoc: PDDoc: Input PDDoc to be converted.
outputFilePath: ASPathName: Output file path complete with the name of the PDF file we want to save the output to.
outputFileSystem: ASFileSys
option: PDFProcessorPDFAConversionOption: Define the PDF/A conversion option.
userParams: PDFProcessorPDFAConvertParams: Parameters to control the conversion. @Return True if conversion is successful. Will throw an exception in case of errors.

Returns

ASBool

PDFProcessorConvertAndSaveToPDFX

ASBool PDFProcessorConvertAndSaveToPDFX(PDDoc srcPDDoc, ASPathName outputFilePath, ASFileSys outputFileSystem, PDFProcessorPDFXConversionOption option, PDFProcessorPDFXConvertParams userParams)

PDFProcessorProcs.h:66

Processes a PDF file, converts it to a PDF/X standard and saves it to disk.

Parameters

srcPDDoc: PDDoc: Input PDDoc to be converted.
outputFilePath: ASPathName: Output file path complete with the name of the PDF file we want to save the output to.
outputFileSystem: ASFileSys
option: PDFProcessorPDFXConversionOption: Define the PDF/X conversion option.
userParams: PDFProcessorPDFXConvertParams: Parameters to control the conversion. @Return True if conversion is successful. Will throw an exception in case of errors.

Returns

ASBool

PDFProcessorConvertToPDFA

ASBool PDFProcessorConvertToPDFA(PDDoc srcPDDoc, PDDoc *outPDDoc, PDFProcessorPDFAConversionOption option, PDFProcessorPDFAConvertParams userParams, PDDocSaveParams outSaveParams)

PDFProcessorProcs.h:48

Processes a PDF file and provides a pointer to the converted PDDoc.

Parameters

srcPDDoc: PDDoc: Input PDDoc to be converted.
outPDDoc: PDDoc *
option: PDFProcessorPDFAConversionOption: Define the PDF/A conversion option.
userParams: PDFProcessorPDFAConvertParams: Parameters to control the conversion.
outSaveParams: PDDocSaveParams

Returns

ASBool

PDFProcessorConvertToPDFX

ASBool PDFProcessorConvertToPDFX(PDDoc srcPDDoc, PDDoc *outPDDoc, PDFProcessorPDFXConversionOption option, PDFProcessorPDFXConvertParams userParams, PDDocSaveParams outSaveParams)

PDFProcessorProcs.h:78

Processes a PDF file, and provides a pointer to the converted PDDoc.

Parameters

srcPDDoc: PDDoc: Input PDDoc to be converted.
outPDDoc: PDDoc *
option: PDFProcessorPDFXConversionOption: Define the PDF/X conversion option.
userParams: PDFProcessorPDFXConvertParams: Parameters to control the conversion.
outSaveParams: PDDocSaveParams

Returns

ASBool

PDFProcessorInitialize

ASBool PDFProcessorInitialize(void)

PDFProcessorProcs.h:25

Initialises the PDFProcessor Plug-in.

Parameters

: void

Returns

ASBool

An ASBool value.

PDFProcessorTerminate

void PDFProcessorTerminate(void)

PDFProcessorProcs.h:55

Terminates the PDFProcessor Plug-in.

Parameters

: void

Returns

void

void.

Typedefs(1)

PDFProcessorProgressMon

typedef ASBool(* PDFProcessorProgressMon) (ASInt32 pageNum, ASInt32 totalPages, float current, void *clientData))(ASInt32 pageNum, ASInt32 totalPages, float current, void *clientData)

PDFProcessorExpT.h:132

Prototype of the callback which is registered by the client with the plug-in

Structures(2)

PDFProcessorPDFAConvertParams

typedef struct PDFProcessorPDFAConvertParamsRec * PDFProcessorPDFAConvertParams

PDFProcessorExpT.h:229

PDFProcessorPDFXConvertParams

typedef struct PDFProcessorPDFXConvertParamsRec * PDFProcessorPDFXConvertParams

PDFProcessorExpT.h:296

Enums(5)

PDFProcessorColorCompressionSet

PDFProcessorExpT.h:100

Enumeration for setting compression scheme for Color Images.

Values

kPDFProcessorColorJpegCompression
kPDFProcessorColorZipCompression
kPDFProcessorColorJpeg2000Compression

PDFProcessorGrayscaleCompressionSet

PDFProcessorExpT.h:109

Enumeration for setting compression scheme for Grayscale Images.

Values

kPDFProcessorGrayJpegCompression
kPDFProcessorGrayZipCompression
kPDFProcessorGrayJpeg2000Compression

PDFProcessorMonochromeCompressionSet

PDFProcessorExpT.h:118

Enumeration for setting compression scheme for Monochrome Images.

Values

kPDFProcessorMonoCCITTGroup3Compression
kPDFProcessorMonoCCITTGroup4Compression
kPDFProcessorMonoZipCompression
kPDFProcessorMonoRunLengthCompression

PDFProcessorPDFAConversionOption

PDFProcessorExpT.h:30

This is used to select which particular PDF/A standard we want to convert to.

Values

kPDFProcessorConvertToPDFA1aRGB: Convert to PDF/A-1a RGB
kPDFProcessorConvertToPDFA1aCMYK: Convert to PDF/A-1a CMYK
kPDFProcessorConvertToPDFA1bRGB: Convert to PDF/A-1b RGB
kPDFProcessorConvertToPDFA1bCMYK: Convert to PDF/A-1b CMYK
kPDFProcessorConvertToPDFA2aRGB: Convert to PDF/A-2a RGB
kPDFProcessorConvertToPDFA2aCMYK: Convert to PDF/A-2a CMYK
kPDFProcessorConvertToPDFA2bRGB: Convert to PDF/A-2b RGB
kPDFProcessorConvertToPDFA2bCMYK: Convert to PDF/A-2b CMYK
kPDFProcessorConvertToPDFA2uRGB: Convert to PDF/A-2u RGB
kPDFProcessorConvertToPDFA2uCMYK: Convert to PDF/A-2u CMYK
kPDFProcessorConvertToPDFA3aRGB: Convert to PDF/A-3a RGB
kPDFProcessorConvertToPDFA3aCMYK: Convert to PDF/A-3a CMYK
kPDFProcessorConvertToPDFA3bRGB: Convert to PDF/A-3b RGB
kPDFProcessorConvertToPDFA3bCMYK: Convert to PDF/A-3b CMYK
kPDFProcessorConvertToPDFA3uRGB: Convert to PDF/A-3u RGB
kPDFProcessorConvertToPDFA3uCMYK: Convert to PDF/A-3u CMYK
kPDFProcessorConvertToPDFA4RGB: Convert to PDF/A-4 RGB
kPDFProcessorConvertToPDFA4CMYK: Convert to PDF/A-4 CMYK
kPDFProcessorConvertToPDFA4eRGB: Convert to PDF/A-4e RGB
kPDFProcessorConvertToPDFA4eCMYK: Convert to PDF/A-4e CMYK
kPDFProcessorConvertToPDFA4fRGB: Convert to PDF/A-4f RGB
kPDFProcessorConvertToPDFA4fCMYK: Convert to PDF/A-4f CMYK

PDFProcessorPDFXConversionOption

PDFProcessorExpT.h:81

This is used to select which particular PDF/X standard we want to convert to.

Values

kPDFProcessorConvertToPDFX1a2001: Convert to PDF/X-1a 2001
kPDFProcessorConvertToPDFX32003: Convert to PDF/X-3 2003
kPDFProcessorConvertToPDFX42010: Convert to PDF/X-4 2010
kPDFProcessorConvertToPDFX62020: Convert to PDF/X-6 2020

xps2pdf

7 items

Functions(3)

XPS2PDFConvert

ASInt32 XPS2PDFConvert(ASCab inSettings, ASInt32 conversionFlags, ASPathName inPath, ASFileSys inFileSys, PDDoc *outPDDoc, void *clientData)

XPS2PDFProcs.h:37

Converts aa XPS file into a PDF file.

Parameters

inSettings: ASCab
conversionFlags: ASInt32: Kept for future use. Default to 0.
inPath: ASPathName: Folder path where the input XPS files are kept.
inFileSys: ASFileSys: File system
outPDDoc: PDDoc *: The output PDDoc which we want to make from XPS.
clientData: void *: Kept for future use. Default to NULL.

Returns

ASInt32

XPS2PDFInitialize

ASBool XPS2PDFInitialize(void)

XPS2PDFProcs.h:25

Initialises the XPS2PDF Plug-in.

Parameters

: void

Returns

ASBool

An ASBool value.

XPS2PDFTerminate

void XPS2PDFTerminate(void)

XPS2PDFProcs.h:44

Terminates the XPS2PDF Plug-in.

Parameters

: void

Returns

void

void.