Proview Integrated sample assessment app for android

Learn to integrate proview-android-sdk and build proctor enabled android application - Sample Project by Talview

About proview-sample-android project

Proview is an automated cognitive remote proctoring solution powered by Talview that uses advanced video and audio analytics to detect candidate impersonation and suspicious activities during a remote online test. This document explains in detail how to integrate proview-android-sdk and build a proctor-enabled android application.

Building the project

• Clone the project, the master branch has the latest code.
• This app uses a proview token for proctoring and personal access token for accessing proview-android-sdk. if you are an existing proview customer, please reach out to someone in your organization who may already have the proview token and personal access token. if you are a new proview customer, please reach out to the Talview team using this link to get the proview token and personal access token. Once you have the proview token and personal access token, please add it to the local.properties file in your project, local.properties will like below:

sdk.dir=PATH_TO_ANDROID_SDK_ON_YOUR_LOCAL_MACHINE    
proviewToken=YOUR_PROVIEW_TOEKN
personalAccessToken=YOUR_PERSONAL_ACCESS_TOKEN

Integrate Proview-Android-SDK in your Android application

• Switch to project view in android studio
• Update build.gradle(Project: project-name)

buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:3.5.1"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.72"
    }
}

allprojects {
    repositories {
        google()
        jcenter()
        maven { url "https://jitpack.io" }
        maven { url "https://s3.amazonaws.com/repo.commonsware.com" }
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/talview/proview-android-sdk")
            credentials {
                username = ""
                password = "YOUR_PERSONAL_ACCESS_TOKEN"
            }
        }
    }
}

• Update build.gradle(Module: module-name)
  • Update default config

  defaultConfig{
      minSdkVersion 21
      targetSdkVersion 29
      ...
  }

  • Add compile options

  compileOptions {
      sourceCompatibility JavaVersion.VERSION_1_8
      targetCompatibility JavaVersion.VERSION_1_8
  }

  • Add Proview-Android-SDK dependency

  dependencies {
      // proview-android-sdk
      implementation "com.talview.proview:proview-android-sdk:1.1.2"
  }

• Update your AndroidManifest.xml
  • Add uses-feature required for proview-android-sdk

  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
      package="com.talview.android.proview.sample">
  
      <uses-feature android:name="android.hardware.camera" />
      <uses-feature android:name="android.hardware.camera.autofocus" />
  
  </manifest>

  • Add permissions required for proview-android-sdk

  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
      package="com.talview.android.proview.sample">
  
      <uses-permission android:name="android.permission.RECORD_AUDIO" />
      <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
      <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
      <uses-permission android:name="android.permission.CAMERA" />
      <uses-permission android:name="android.permission.INTERNET" />
      <uses-permission android:name="android.permission.WAKE_LOCK" />
      <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
  
  </manifest>

• Create your application class and extends android.app.Application like SampleApplication

public class SampleApplication extends Application {
}

• Override onCreate() method and initialize Proview

public class SampleApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        // Proview init function 2nd paramater required BuildConfig.DEBUG type to enable logs
        Proview.init(this, BuildConfig.DEBUG);

        // [Optional] Customized title for video and events capturing notification.
        // 1st parameter is for video uploading notification,
        // 2nd parameter is for proctor event captur notification.
        Proview.setNotificationTitles("Uploading proctor videos", "Capturing events");
    }
}

• Register your Application class to your AndroidManifest.xml file in <application> tag

<application
    android:name=".SampleApplication">
    .......
</application>

• Override the proview-android-sdk color configuration to apply your app theme

<resources>
    <color name="proviewColorPrimary">@color/colorPrimary</color>
    <color name="proviewColorPrimaryDark">@color/colorPrimaryDark</color>
    <color name="proviewColorSecondary">#5990cc</color>
    <color name="proviewColorSecondaryLight">#265990cc</color>
</resources>

• Checkout SampleAssessmentActivity to start proctoring for your assessment
  • Step 1: Create Activity/Fragment or if you have an Activity/Fragment for your assessment goto Step 2
  • Step 2: Replace your Answer Section EditText to ProviewMonitoringEditText see an example here
  • Step 3: Add ProctorCameraView to your assessment host Activity/Fragment see an example here
  • Step 4: Initialize proctorCameraView in your UI component initialization

  public class SampleAssessmentActivity extends AppCompatActivity {  
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_sample_assessment);
  
        proctorCameraView = findViewById(R.id.proctorCameraView);
    }
  }

  • Step 5: Proview initializePreFlight with mandatory parameters like proviewToken (Talview Proview Token), candidateId (for candidate profile), externalId(for uniques session) and assessmentTitle (refers to proview assessment title)
    • Start PreFlight for checking candidate hw check on onPreFlightInitialized callback
    • Start your assessment and proctoring.
    • Stop session and proctoring once your assessment ends.

  public class SampleAssessmentActivity extends AppCompatActivity {  
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_sample_assessment);
  
        initializeProview();
    }
  
    // - Initialize Proview session with required details.
    private void initializeProview() {
        Proview.get().initializePreFlight(
            /*TALVIEW_PROVIEW_TOKEN*/ "PROVIEW_TOKEN",
            /*CANDIDATE_ID*/ "CANDIDATE_ID",
            /*EXTERNAL_ID*/ "EXTERNAL_ID",
            /*ASSESSMENT_TITLE*/ "Sample Proctor Assessment",
            new PreFlightInitializeCallback() {
                @Override
                public void onPreFlightInitialized(@NotNull String sessionId) {
                    // Save this unique sessionID on your server.
                    startTestWithProviewPreflight();
                }
  
                @Override
                public void onError(@NotNull String errorMessage) {
                    //Exiting the activity on error.
                    Toast.makeText(SampleAssessmentActivity.this, errorMessage, Toast.LENGTH_SHORT).show();
                    finish();
                }
            }
         );
    }
  
    // - Start PreFlight for checking candidate's phone hardware.
    private void startTestWithProviewPreflight() {
        Proview.get().startPreflight(this, new PreFlightCallback() {
            @Override
            public void onPreFlightComplete() {
                // Initialize your ProctorCameraView and start your assessment.
                initializeProctorCameraView();
            }
  
            @Override
            public void onPreFlightFailure(@NotNull String errorMessage) {
                //Exiting the activity on error.
                Toast.makeText(SampleAssessmentActivity.this, errorMessage, Toast.LENGTH_SHORT).show();
                finish();
            }
  
            @Override
            public void onPreFlightCancelled() {
                //Exiting the activity on preFlightCancelled.
                Toast.makeText(SampleAssessmentActivity.this, "Pre Flight cancelled", Toast.LENGTH_SHORT).show();
                finish();
            }
        });
    }
  
    // - First Initialize your [ProctorCameraView] and in onInitializeSuccess callback, start proctoring.
    private void initializeProctorCameraView() {
        proctorCameraView.init(this, new ProctorCameraListener() {
             @Override
             public void onInitializeSuccess() {
                 // startProctoring session and your assessment to capture events.
                 startProctorSessionAndAssessment();
             }
  
             @Override
             public void onError(int errorCode) {
                 Toast.makeText(SampleAssessmentActivity.this, "ProviewCameraView Init OnError Code " + errorCode, Toast.LENGTH_SHORT).show();
                 finish();
             }
        });
    }
  
    // - Start session and in onSuccess callback startProctoring to capture all events.
    private void startProctorSessionAndAssessment() {
        // starting the session and proctoring.
        Proview.get().startSession(new ProviewStartSessionListener() {
            @Override
            public void onSuccess() {
                proctorCameraView.startProctoring();
                startYourAssessment();
            }
  
            @Override
            public void onFailure(int errorCode) {
                Toast.makeText(SampleAssessmentActivity.this, "OnStartSession Failure ErrorCode : " + errorCode, Toast.LENGTH_SHORT).show();
                finish();
            }
        });
  
        // [Optional but recommended] to show video upload progress to user at the end of your assessment.
        // so user can wait till the gets uploaded.
        Proview.get().listenForVideoUploads(new ProctorVideoUploadListener() {
  
            @Override
            public void onSessionComplete() {
                runOnUiThread(() -> {
                    Toast.makeText(SampleAssessmentActivity.this, "Video Uploaded and Session Completed successfully.", Toast.LENGTH_SHORT).show();
                });
                finish();
            }
  
            @Override
            public void onError(int errorCode) {
                runOnUiThread(() -> {
                    Toast.makeText(SampleAssessmentActivity.this, "CurrentSessionVideoProgress OnFailure ErrorCode " + errorCode, Toast.LENGTH_SHORT).show();
                });
                finish();
            }
  
            @Override
            public void uploadProgress(int progress) {
                // Upload progress callback.
                runOnUiThread(() -> {
                    uploadPercentageTextView.setText("Uploading " + progress + "%");
                });
            }
        });
        }
  
    private void startYourAssessment() {
        questionRecyclerView.setAdapter(questionAdapter);
        progressBar.setVisibility(View.GONE);
        uploadPercentageTextView.setVisibility(View.GONE);
        questionRecyclerView.setVisibility(View.VISIBLE);
        proctorCameraView.setVisibility(View.VISIBLE);
     }
  
  
     // stop proctoring and session at the end of the assessment.
     public void onAnswerSubmit(Question question, boolean isLastQuestion, int position) {
        if (isLastQuestion) {
            proctorCameraView.stopProctoring();
  
            Proview.get().stopSession(new ProviewStopSessionListener() {
                @Override
                public void onSuccess() {
                    // [Optional but recommended] to show video upload progress to user at the end of your assessment.
                    showUploadProgressScreen();
                }
  
                @Override
                public void onFailure(int errorCode) {
                    Toast.makeText(SampleAssessmentActivity.this, "ProviewStop OnFailure ErrorCode " + errorCode, Toast.LENGTH_SHORT).show();
                    finish();
                }
            });
        } else {
            questionRecyclerView.getLayoutManager().scrollToPosition(position + 1);
        }
     }
  
     // [Optional] abortSession onBackpress to clear current session.
     @Override
     public void onBackPressed() {
         new AlertDialog.Builder(this)
                 .setTitle(getString(R.string.exit))
                 .setMessage(getString(R.string.exit_message))
                 .setPositiveButton(getString(R.string.ok), (dialog, which) -> {
  
                     // abortSession will clear your current session.
                     Proview.get().abortSession(new ProviewAbortSessionListener() {
                         @Override
                         public void onSuccess() {
                             finish();
                         }
  
                         @Override
                         public void onFailure(int errorCode) {
                             Toast.makeText(SampleAssessmentActivity.this, "OnAbort Failure ErrorCode " + errorCode, Toast.LENGTH_SHORT).show();
                         }
                     });
                 })
                 .setNegativeButton(getString(R.string.cancel), ((dialog, which) -> {
                     dialog.cancel();
                 })).show();
         }
  }

Proview-Android-SDK API Reference for this project

Proview Android SDK is a proctoring sdk.

• In Proview, we have three methods:

  • init() : To initialize Proview
  • initializePreFlight(String proviewToken, String candidateId, String externalId, String assessmentTitle) : proviewToken is required, candidateId is a unique identifier for candidate profile, externalId for unique proview session, assessmentTitle for identify assessment taken
  • startPreflight(context, PreFlightCallback) : Start PreFlight for checking candidate hw check etc.

• In ProctorCamera, we have custom views like ProctorCameraView

<com.talview.android.sdk.proview.view.ProctorCameraView
    android:id="@+id/proctorCameraView"
    android:layout_width="70dp"
    android:layout_height="70dp"/>

• In ProviewMonitoring, we have custom views like ProviewMonitoringEditText

<com.talview.android.sdk.proview.view.monitoring.ProviewMonitoringEditText
    android:id="@+id/proviewMonitoringEditText"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"/>

Find this project useful?

• Support it by clicking the ⭐ button on the upper right of this page. ✌️

Feedback

Your feedback helps make proview-android-sdk better. Please let us know if you discover an issue or have an idea for improving this SDK. Feel free to report here

License

   Copyright (C) 2020 Talview