API Overview

OCR SDK extern C API

OCR SDK provides character detection and recognition functions across various platforms through C language-based interface, and can access main functions through ArgoSDK.h header file. This section lists public APIs defined with extern "C" and briefly explains the basic roles and purposes of each function.

The API maintains C linkage for easy use in C++ environments and is configured to control the entire OCR processing including initialization, configuration, processing, and resource release. Each function is used to control detailed operations of OCR modules or retrieve results.

Included Headers

#include <ArgoSDK.h>

API List

void	freePointer (char** pointer)
void *	CreateFromImrModelFile (void** obj, char* licensePath, char* engineLibDirPath, char* imrModelDataPath, char* name, bool isRecovery, bool isSelfCheck, int gpuCount, int engines_per_gpu[])
void *	CreateFromMakeUpJsonStr (void** obj, char* licensePath, char* engineLibDirPath, char* jsonStr, char* name, bool isRecovery, bool isSelfCheck, int gpuCount, int engines_per_gpu[])
void *	CreateArgoSDK (char* licensePath, char* engineLibDirPath, char* logFilePath)
bool	initFromImrModelFile (void* obj, char* imrModelDataPath, char* name, bool isRecovery, bool isSelfCheck, int gpuCount, int engines_per_gpu[])
bool	initFromMakeUpJsonStr (void* obj, char* jsonStr, char* name, bool isRecovery, bool isSelfCheck, int gpuCount, int engines_per_gpu[])
void	setLogFilePath (void* obj, char* logFilePath)
int	releaseArgoSDK (void* obj)
int	getGpuCount (void* obj)
bool	isCudaAvailable (void* obj)
int	getOpenApi (void* obj, char** openApiJson)
int	getOpenApiOption (void* obj, char** openApiOptionJson, char* openApiName)
int	getStatusJsonStr (void* obj, char** resultJson)
int	getArgoEngineInitInfo (void* obj, char** resultJson)
int	getResourcesInfo (void* obj, char** resultJson, char* resourcePath)
int	run (void* obj, char** resultJson, char* openApiName, char* requestId, int imgWidth, int imgHeight, int colorSpace, char* imgData, char* requestOptionJsonStr)
void	runAsync (void* obj, C_RESULT_CALLBACK callback, char* openApiName, char* requestId, int imgWidth, int imgHeight, int colorSpace, char* imgData, char* requestOptionJsonStr)
int	runBase64 (void* obj, char** resultJson, char* openApiName, char* requestId, int imgWidth, int imgHeight, int colorSpace, char* imgData, char* requestOptionJsonStr)
void	runAsyncBase64 (void* obj, C_RESULT_CALLBACK callback, char* openApiName, char* requestId, int imgWidth, int imgHeight, int colorSpace, char* imgData, char* requestOptionJsonStr)
void *	runAsyncQueueBase64 (void* obj, char* openApiName, char* requestId, int imgWidth, int imgHeight, int colorSpace, char* imgData, char* requestOptionJsonStr)
int	waitResult (void* obj, char** resultJson)
int	releaseQueue (void* obj)