2. FOCR SDK Features

Init gateway

Contact us for get app_id & secret_key

Java

OCRManager.initGateway(appId, secretKey, new IInitGatewayCallback() {
  @Override
  public void onSuccess() {

  }

  @Override
  public void onFail(@Nullable AppException error) {

  }
});

Kotlin

OCRManager.initGateway(appId, secretKey, object : IInitGatewayCallback {
  override fun onSuccess() {

  }

  override fun onFail(error: AppException?) {

  }
})

Register OCR callback

After registration, the SDK will return the corresponding status in the callback

Status	Description
onStart	Called at start OCR
onSuccess	Called when return result
onFail	Called when an error occurs in process

Java

OCRManager.registerOCRCallback(new IOCRCallback() {
  @Override
  public void onStart() {

  }

  @Override
  public void onFail(@Nullable AppException error) {

  }

  @Override
  public void onSuccess(@NonNull OCRData result) {

  }
});

Kotlin

OCRManager.registerOCRCallback(object : IOCRCallback {
  override fun onStart() {

  }


  override fun onFail(error: AppException?) {

  }

  override fun onSuccess(result: OCRData) {

  })
})

Get Config

• Get list config used to ocr param

• When sucess, result is listConfig, it will be called on onSuccess() in callback

• When fail, it will called on onFail() in callback

Java

OCRManager.getConfig(new IOCRConfigCallback() {
    @Override
    public void onSuccess(@NonNull List<OCRConfigData> listConfig) {
        
    }

    @Override
    public void onFail(@Nullable AppException error) {

    }
});

Kotlin

OCRManager.getConfig(object : IOCRConfigCallback {
    override fun onSuccess(listConfig: List<OCRConfigData>) {

    }

    override fun onFail(error: AppException?) {
    
    }
})

Start OCR

• Used to start OCR

• When successful start, it will be called on onStart() in callback

• When have result result will be return on onSuccess in callback.

• When fails, it will be processed at callback onFail() in callback.

Java

//use file
OCRManager.startOCR(documentType, responseFormat, toMathMl, file); 
...
//use file path
OCRManager.startOCR(documentType, responseFormat, toMathMl, absoluteFilePath); 

Kotlin

//use file
OCRManager.startOCR(documentType, responseFormat, toMathMl, file) 
...
 //use file path
OCRManager.startOCR(documentType, responseFormat, toMathMl, absoluteFilePath)

Export OCR data

• Used to export data OCR to csv or excel file

• exportType is OCRExportType.CSV or OCRExportType.EXCEL

• When export success data will be return on onSuccess in callback.

• When fails, it will be processed at callback onFail() in callback

Java

OCRManager.export(requestId, exportType, new IExportCallback() {
    @Override
    public void onSuccess(@NonNull String data) {
        
    }

    @Override
    public void onFail(@Nullable AppException error) {

    }
});

Kotlin

OCRManager.export(requestId, exportType, object : IExportCallback {
    override fun onSuccess(data: String) {

    }

    override fun onFail(error: AppException?) {
    
    }
})

UI Preview OCR data

<ai.ftech.focrsdk.sdk.FOCRView
    android:id="@+id/ocrView"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

Then set OCRData from onSuccess to view

  ocrView.setData(ocrData)