app
root
repo
    +--com
        +--trustvision
            +--tv_api_sdk
                +--3.x.x
                    +--tv_api_sdk-3.x.x.aar
                    +--tv_api_sdk-3.x.x.pom
                maven-metadata.xml
            +--tv_core_sdk
            +--tv_sdk_client
...

buildscript {
    ext.kotlin_version = '1.6.21' // or any version that >= 1.5 and < 1.8

    repositories {
        maven {
            url 'https://maven.google.com'
        }
        mavenCentral()
        google()
    }

    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}

allprojects {
    repositories {
        maven { url "https://maven.google.com" }
        maven { url "https://jitpack.io" }
        maven { url "path/to/tvsdk/folder" }  // example : maven { url "${project.rootDir}/repo" }
        ...
    }
}

pluginManagement {
    repositories {
        google()
        mavenCentral()
        gradlePluginPortal()
    }
}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.PREFER_PROJECT)
    repositories {
        google()
        mavenCentral()
    }
}

android {
    ...
    aaptOptions {
        noCompress "tflite"
    }
}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation('com.trustvision:tv_sdk_client:3.x.x@aar') {
        transitive = true
    }
    testImplementation 'junit:junit:4.12'

}

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    TrustVisionSDK.INSTANCE.init(context, jsonConfigurationByServer, languageCode, new BaseTrustVisionSDK.TVInitializeListener() {
        @Override
        public void onInitSuccess() {

        }

        @Override
        public void onInitError(@NonNull TVDetectionError error) {

        }
    });
}

TrustVisionSdk.INSTANCE.getSupportedLanguages();

TrustVisionSdk.INSTANCE.changeLanguageCode(String languageCode);

<resources>
    <string name="tv_title_activity_main" />
    <integer name="google_play_services_version">1</integer>
    <style name="tvAppTheme.NoActionBar" parent="AppTheme.NoActionBar" />
</resources>

TrustVisionSDK.INSTANCE.installDynamicFeature(it -> {
    // We often execute this code to install some necessary resources for dynamic feature
    SplitCompat.installActivity(it);
    return Unit.INSTANCE;
});

TVIDConfiguration.Builder builder=new TVIDConfiguration.Builder()
    .setCardType(selectedCard)
    .setCardSide(TVSDKConfiguration.TVCardSide.FRONT)
    .setReadBothSide(false)
    .setEnableSound(false)
    .setEnablePhotoGalleryPicker(false)
    .setEnableTiltChecking(false)
    .setSkipConfirmScreen(false)
    .setEnableScanNFC(true)
    .setEnableScanQr(true);

TVIDConfiguration configuration=builder.build();

Collections.singletonList(
    new TVCardType(
        "vn.national_id",
        "CMND cũ / CMND mới / CCCD",
        true,
        TVCardType.TVCardOrientation.HORIZONTAL,
        null,
        null
    )
);

TrustVisionSDK.INSTANCE.startIDCapturing(activity, configuration, new TVCapturingCallBack(){
    @Override
    public void onNewFrameBatch(FrameBatch frameBatch){

    }

    @Override
    public void onError(TVDetectionError error){

    }

    @Override
    public void onSuccess(TVDetectionResult result){

    }

    @Override
    public void onCanceled(){

    }

    @Override
    public String readIdCardNumber(@NonNull TVImageClass image) {

    }
});

// this dictionary will be used for ID Tampering Verification
Map frontCardFrameBatchIdsDictionary = new HashMap<String, String>();
Map backCardFrameBatchIdsDictionary = new HashMap<String, String>();
// frameBatchIdsDictionary.put(
//    key = <id_returned_from_sdk>,
//    value = <id_responded_from_server>
// );

@Override
public void onNewFrameBatch(FrameBatch frameBatch) {
    Gson gson = new Gson();
    String framesStr = gson.toJson(frameBatch.getFrames());
    Map<String, Object> params = new HashMap<>();
    params.put("frames", framesStr);
    params.put("metadata", frameBatch.getMetadata());
    params.put("label", "video");

    String jsonToBeUploaded=gson.toJson(map);
    // upload frame batch to server using this api:
    // https://ekyc.trustingsocial.com/api-reference/customer-api/#upload-videoaudioframes
    YourResponseObject uploadingResult = yourMethodToUploadFrameBatch(jsonToBeUploaded);

    // Keep the id that generated by the SDK corresponding with the one responded from server
    if (cardSide == TVSDKConfiguration.TVCardSide.FRONT) {
        frontCardFrameBatchIdsDictionary.put(
            key = frameBatch.batchId,
            value = uploadingResult.fileId
        );
    } else {
        backCardFrameBatchIdsDictionary.put(
            key = frameBatch.batchId,
            value = uploadingResult.fileId
        );
    }
}

// These lists contain all valid frame batch ids that responded by server
var validFrontCardServerFrameBatchIds: List<String>? = null
var validBackCardServerFrameBatchIds: List<String>? = null

override fun onSuccess(result: TVDetectionResult) {
// the batch id list is null when Frame Recording feature is disabled by client settings.
// Wait until every Frame batch has been uploaded to server before calling this
    if (everyFrameBatchUploadingCompleted) {
        result.frontCardFrameBatchIds?.also {
            validFrontCardServerFrameBatchIds = removeRedundantFrameBatchIds(
                frontCardFrameBatchIdsDictionary,
                it
            )
        }
        result.backCardFrameBatchIds?.also {
            validBackCardServerFrameBatchIds = removeRedundantFrameBatchIds(
                backCardFrameBatchIdsDictionary,
                it
            )
        }
    }
}

private fun removeRedundantFrameBatchIds(
    batchIdsDictionary: MutableMap<String, String>,
    validIdsFromSDK: Collection<String>
): List<String> {
    val iter: MutableIterator<Map.Entry<String, String>> = batchIdsDictionary.entries.iterator()
    while (iter.hasNext()) {
        val (key1) = iter.next()
        if (!validIdsFromSDK.contains(key1)) {
            iter.remove()
        }
    }
    return batchIdsDictionary.values.toList()
}

{
  "file": "<byte[] dataToUpload>",
  "label": "proper label, check the API document for detail"
}

{
  "image": {
    "id": "<frontCardId>"
  },
  "image2": {
    "id": "<backCardId>"
  },
  "qr1_images": [
    {
      "id": "<qrId>"
    }
  ],
  "card_type": "<result.cardType.getCardId()>",
  "videos": [
    {
      "id": "<validFrontCardServerFrameBatchIds.get(index)>"
    },
    {
      "id": "<validFrontCardServerFrameBatchIds.get(index + 1)>"
    },
    ...
    {
      "id": "<validBackCardServerFrameBatchIds.get(index)>"
    },
    {
      "id": "<validBackCardServerFrameBatchIds.get(index + 1)>"
    },
    ...
  ]
}

TVImageClass frontQrImage = result.getFrontIdQr().getImages().get(i);
Map<String, String> metadata = frontQrImage.getMetadata();
String label = frontQrImage.getLabel();
byte[] data = frontQrImage.getImageByteArray();

override fun readIdCardNumber(image: TVImageClass): String? {
  var idNumber: String? = null;
  // call api or do any thing to read and return id number
  // TODO
  return idNumber;
}

TVSelfieConfiguration.Builder builder = new TVSelfieConfiguration.Builder()
    .setCameraOption(TVSDKConfiguration.TVCameraOption.FRONT)
    .setEnableSound(false)
    .setLivenessMode(TVLivenessMode.PASSIVE)
    .setSkipConfirmScreen(false);

TVSelfieConfiguration configuration = builder.build();

TrustVisionSDK.INSTANCE.startSelfieCapturing(activity, configuration, new TVCapturingCallBack() {
    @Override
    public void onNewFrameBatch(FrameBatch frameBatch) {

    }

    @Override
    public void onError(TVDetectionError error) {

    }

    @Override
    public void onSuccess(TVDetectionResult result) {

    }

    @Override
    public void onCanceled(){

    }
});

// this dictionary will be used for Liveness verification
Map selfieFrameBatchIdsDictionary = new HashMap<String, String>();
// frameBatchIdsDictionary.put(
//    key = <id_returned_from_sdk>,
//    value = <id_responded_from_server>
// );

@Override
public void onNewFrameBatch(FrameBatch frameBatch) {
    Gson gson = new Gson();
    String framesStr = gson.toJson(frameBatch.getFrames());
    Map<String, Object> params = new HashMap<>();
    params.put("frames", framesStr);
    params.put("metadata", frameBatch.getMetadata());
    params.put("label", "video");

    String jsonToBeUploaded = gson.toJson(map);
    // upload frame batch to server using this api:
    // https://ekyc.trustingsocial.com/api-reference/customer-api/#upload-videoaudioframes
    YourResponseObject uploadingResult = yourMethodToUploadFrameBatch(jsonToBeUploaded);

    // Keep the id that generated by the SDK corresponding with the one responded from server
    frameBatchIdsDictionary.put(
        key = frameBatch.getId(),
        value = uploadingResult.fileId
    );
}

// These lists contain all valid frame batch ids that responded by server
var validServerFrameBatchIds: List<String>? = null

override fun onSuccess(result: TVDetectionResult) {
    // the batch id list is null when Frame Recording feature is disabled by client settings.
    // Wait until every Frame batch has been uploaded to server before calling this
    if (everyFrameBatchUploadingCompleted) {
        result.livenessFrameBatchIds?.also {
            validServerFrameBatchIds = removeRedundantFrameBatchIds(
                selfieFrameBatchIdsDictionary,
                it
            )
        }
    }
}

private fun removeRedundantFrameBatchIds(
    batchIdsDictionary: MutableMap<String, String>,
    validIdsFromSDK: Collection<String>
): List<String> {
    val iter: MutableIterator<Map.Entry<String, String>> = batchIdsDictionary.entries.iterator()
    while (iter.hasNext()) {
        val (key1) = iter.next()
        if (!validIdsFromSDK.contains(key1)) {
            iter.remove()
        }
    }
    return batchIdsDictionary.values.toList()
}

// These lists of image ids will be used in Liveness Verification
List<String> frontalImageIds = new ArrayList<>();
List<String> gestureImageIds = new ArrayList<>();

@Override
public void onSuccess(TVDetectionResult result) {
    handleSelfieImages(result.getSelfieImages());
}

private void handleSelfieImages(List<SelfieImage> selfieImages) {
    for (selfieImage: selfieImages) {
        // Handle frontal images
        if (selfieImage.getFrontalImage() != null && selfieImage.getFrontalImage().getImageByteArray() != null){
            byte[] frontalImageByteArray = selfieImage.getFrontalImage().getImageByteArray();
            // frontalImageId is the id of the image, returned from server when the uploading API is completed successfully
            String frontalImageId = yourUploadImageMethod(frontalImageByteArray);
            frontalImageIds.add(frontalImageId);
        }

        // Handle gesture images
        if (selfieImage.getGestureImage() != null && selfieImage.getGestureImage().getImageByteArray() != null){
            byte[] gestureImageByteArray = selfieImage.getGestureImage().getImageByteArray();
            // gestureImageId is the id of the image, returned from server when the uploading API is completed successfully
            String gestureImageId = yourUploadImageMethod(gestureImageByteArray);
            gestureImageIds.add(gestureImageId);
        }
    }
}

{
  "file": "<byte[] dataToUpload>",
  "label": "<proper label, check the API document for detail>"
}

{
  "images": [
    {
      "id": "<frontalImageIds.get(index)>"
    },
    {
      "id": "<frontalImageIds.get(index + 1)>"
    },
    ...
  ]
}

{
  "gesture_images": [
    {
      "gesture": "<result.getSelfieImages().get(index).getGestureType().toGestureType().toLowerCase()>",
      "images": [
        {
          "id": "<gestureImageIds.get(index)>"
        }
      ]
    },
    {
      "gesture": "<result.getSelfieImages().get(index + 1).getGestureType().toGestureType().toLowerCase()>",
      "images": [
        {
          "id": "<gestureImageIds.get(index + 1)>"
        }
      ]
    },
    ...
  ]
}

{
  "videos": [
    {
      "id": "<validServerFrameBatchIds.get(index)>"
    },
    {
      "id": "<validServerFrameBatchIds.get(index + 1)>"
    },
    ...
  ]
}

{
  "metadata": "<result.getLivenessMetadata()>"
}

TVQRConfiguration.Builder builder= new TVQRConfiguration.Builder()
    .setCardType(selectedCard)
    .setCardSide(TVSDKConfiguration.TVCardSide.FRONT)
    .setEnableSound(false)
    .setSkipConfirmScreen(false);

TVQRConfiguration configuration=builder.build();

new TVCardType(
    "vn.national_id",
    "CMND cũ / CMND mới / CCCD",
    true,
    TVCardType.TVCardOrientation.HORIZONTAL,
    null,
    null
);

TrustVisionSDK.INSTANCE.startQRScanning(activity, configuration, new TVCapturingCallBack(){
    @Override
    public void onError(TVDetectionError error){

    }

    @Override
    public void onSuccess(TVDetectionResult result){

    }

    @Override
    public void onCanceled(){

    }
});

TVImageClass frontQrImage = result.getFrontIdQr().getImages().get(i);
Map<String, String> metadata = frontQrImage.getMetadata();
String label = frontQrImage.getLabel();
byte[] data = frontQrImage.getImageByteArray();

TVNfcConfiguration.Builder builder = new TVNfcConfiguration.Builder()
        .setNfcCode(nfcCode)
        .setSOD(sod)
        .setRequestReadImageNfc(true)
        .setRequestIntegrityCheckNfc(true)
        .setRequestCloneDetectionNfc(true)
        .setNfcMaxRetries(5);

TVNfcConfiguration configuration = builder.build();

TrustVisionSDK.INSTANCE.startNfcScanning(activity, configuration, new TVCapturingCallBack() {
    @Override
    public void onCanceled() {

    }

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

    }

    @Override
    public void onError(@NonNull TVDetectionError error) {

    }
});

// [FlowStartingFunc]: startIdCapturing, startSelfieCapturing, startQRScanning, startNfcScanning

TrustVisionSDK.INSTANCE.[FlowStartingFunc](..., builder.build(), new TVCapturingCallBack() {
    @Override
    public void onError(TVDetectionError error) {
        String message = error.getErrorDescription();
        Log.d("", message);
        showToast(message);

        ///////////////////////////////////////
        // ERROR HANDLER
        int code = error.getErrorCode();
        String description = error.getErrorDescription();

        switch code {
            case TVDetectionError.CONFIGURATION_ERROR:
            // Invalid configuration
            case TVDetectionError.DETECTION_ERROR_PERMISSION_MISSING:
            // No camera permission.
            case TVDetectionError.DETECTION_ERROR_CAMERA_ERROR:
            // The camera can't be opened.
            case TVDetectionError.DETECTION_ERROR_SDK_INTERNAL:
            // The SDK has an unexpected error.
            case TVDetectionError.DETECTION_ERROR_NFC:
            // The SDK has an unexpected error when scanning NFC
        }
    }

    @Override
    public void onSuccess(TVDetectionResult result) {

    }

    @Override
    public void onCanceled() {

    }
});

TrustVisionSDK.INSTANCE.isNfcSupport(Context): Boolean

int NEUTRAL = 1
int TURN_LEFT = 5
int TURN_RIGHT = 6
int FACE_UP = 7
int FACE_DOWN = 8

int TVDetectionError.DETECTION_ERROR_PERMISSION_MISSING = 1004
int TVDetectionError.DETECTION_ERROR_CAMERA_ERROR = 1005
int TVDetectionError.DETECTION_ERROR_SDK_INTERNAL = 1007

  private void customizeTVCommonThemes() {
      // Common Title label theme
      TVLabelTheme titleLabelThemeDefault = TVThemeDefaultValues.getTitleLabelTheme();
      titleLabelThemeDefault.setFont(your_font);
      // there are more to be customized...

      // Common Normal label theme
      TVLabelTheme normalLabelThemeDefault = TVThemeDefaultValues.getNormalLabelTheme();
      normalLabelThemeDefault.setTextSize(your_text_size);
      // there are more to be customized...

      // Common Instruction label theme
      TVLabelTheme instructionLabelTheme = TVThemeDefaultValues.getInstructionLabelTheme();
      instructionLabelTheme.setTextColor(your_text_color);
      // there are more to be customized...

      // Common Error label theme
      TVLabelTheme errorLabelThemeDefault = TVThemeDefaultValues.getErrorLabelTheme();
      errorLabelThemeDefault.setCornerRadius(your_corner_radius);
      // there are more to be customized...

      // Common Timeout label theme
      TVLabelTheme timeoutLabelThemeDefault = TVThemeDefaultValues.getTimeoutLabelTheme();
      timeoutLabelThemeDefault.setBackgroundColors(your_background_colors);
      // there are more to be customized...
  }

private TVTheme initTVTheme() {
    TVTheme customizedTheme = new TVTheme();

    // Selfie capturing screen
    customizedTheme.getSelfieCapturingTheme().getGestureTheme().setLookStraightActiveImage(your_image);
    // there are more to be customized...

    // Selfie confirmation screen
    customizedTheme.getSelfieConfirmationTheme().setRetryButtonImage(your_image);
    // there are more to be customized...

    // Id capturing screen
    customizedTheme.getIdCapturingTheme().setMaskViewNeutralImage(your_image);
    // there are more to be customized...

    // Id confirmation screen
    customizedTheme.getIdConfirmationTheme().setCloseButtonImage(your_image);
    // there are more to be customized...

    // QR guideline popup
    customizedTheme.getQrGuidelinePopupTheme().setHeaderImage(your_image);
    // there are more to be customized...

    // QR guideline popup
    customizedTheme.getQrRetryPopupTheme().setBackgroundColor(your_color);
    // there are more to be customized...

    return customizedTheme;
}