Legacy Android SDK
2.2.1
2.2.1
  • Introduction
  • Requirements
  • Downloading
  • Setup
  • Initialization
    • Network Security Settings
  • User Management
    • Create User
    • User status
    • Delete engine enrol
    • Delete User
  • Face Engine
    • Liveness Detection
      • Liveness Customisation
    • Face Verification
    • Camera Helper
  • Voice Engine
    • Initialization
    • Audio Recording
    • Recording Submission
  • Document Engine
    • Validate document
    • Validate entity
  • Enums
Powered by GitBook
On this page
  • Callback
  • Implementation example
  1. Voice Engine

Recording Submission

During a session, Biometrid is expecting audio samples containing a set of numbers (prompt) provided on previous steps. This method allows the submission of this files.

BiometridAuthVoice.getInstance().submitAudioFile(
    String id, 
    String path, 
    SessionType session, 
    AuthVoiceCallback context
);

submitAudioFile()

method

String id

id corresponding the biometric user

String path

absolute path for the temporary audio file

SessionType session

Biometrid session

AuthVoiceCallback

Applicational context

Callback

@Override
public void authSubmitAudioCallback(boolean status, SessionType sessionType, VoiceResponseStatus response, String prompt,  JSONObject jsonObject, Errors errors){
    if(!status && serrors != null) 
          Log.e("error", error.getMessage());
    else {
        Log.i("current session", session.getName());
        Log.i("active prompt", prompt);
        
        // All possible response results will fall under one of this alternatives
        switch (response){
            case SessionCompletedWithSuccess:
                break;
            case SessionFailed:
                break;
            case RequestLimitReached:
                break;
            case AudioSubmittedWithSuccess:
                break;
            case VoiceAlreadyEnrolled:
                break;
            case VoiceNotEnrolled:
                break;
            case NoVoiceEngineConfigurationAvailable:
                break;
            case ProblemOccurred:
                break;
        }
    }
}

authRecordAudioCallback

callback

boolean status

Request status

SessionType session

Biometrid's session type

VoiceResponse response

Enum containing all possible outcomes

String prompt

Next set of numbers

JsonObject jsonObject

Contains the full response from the api

Errors errors

Error object

Implementation example

public class ExampleActivity extends Activity 
        implements AuthVoiceCallback {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_example);
        
        BiometridAuthVoice.getInstance().submitAudioFile(
            "biometrid_od", 
            "path to file", 
            SessionType.VERIFY, 
            this
        );
    }

    
    @Override
    public void authSubmitAudioCallback(boolean status, SessionType sessionType, VoiceResponseStatus response, String prompt,  JSONObject jsonObject, Errors errors){
        if(!status && serrors != null) 
              Log.e("error", error.getMessage());
        else {
            Log.i("current session", session.getName());
            Log.i("active prompt", prompt);
            
            // All possible response results will fall under one of this alternatives
            switch (response){
                case SessionCompletedWithSuccess:
                    break;
                case SessionFailed:
                    break;
                case RequestLimitReached:
                    break;
                case AudioSubmittedWithSuccess:
                    break;
                case VoiceAlreadyEnrolled:
                    break;
                case VoiceNotEnrolled:
                    break;
                case NoVoiceEngineConfigurationAvailable:
                    break;
                case ProblemOccurred:
                    break;
            }
        }
    }

    ...
}

PreviousAudio RecordingNextDocument Engine

Last updated 6 years ago

For more information on this method please check our api

documentation