Zebra Translate
Android Quick Start

Platforms

• Android (5.0+, API 21+)

Requirements

• Picovoice Account and AccessKey
• Android Studio
• Android device with USB debugging enabled or Android simulator

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Install Android Studio.

2. Include mavenCentral() repository in the top-level build.gradle. Then add the following to the app's build.gradle:

dependencies {
    // ...
    implementation 'ai.picovoice:zebra-android:${LATEST_VERSION}' // replace with latest version
}

3. Add the following to the app's AndroidManifest.xml file:

<uses-permission android:name="android.permission.INTERNET" />

Usage

Create an instance of Zebra Translate:

import ai.picovoice.zebra.*;

final String accessKey = "${ACCESS_KEY}"; // AccessKey obtained from Picovoice Console (https://console.picovoice.ai/)
final String modelPath = "${MODEL_PATH}"; // Replace with a translation model file

try {
    Zebra zebra = new Zebra.Builder()
      .setAccessKey(accessKey)
      .setModelPath(modelPath)
      .build(appContext);
} catch (ZebraException ex) { }

Read more about how to select a model in the Translation Models section.

Translate text:

String translation = zebra.transate("${TEXT_TO_TRANSLATE}");

When done, release resources explicitly:

zebra.delete();

Translation Models

Supported Zebra translation models are located in our GitHub repository. The selected model decides the source and target translation languages.

The format of the model follows:

zebra_params_${SOURCE}_${TARGET}.pv

Where ${SOURCE} is the language code of the source language and ${TARGET} is the language code of the target language for the translation.

Demo

For the Zebra Translate Android SDK, we offer a demo application that demonstrates how to use the Translate engine.

Setup

Clone the Zebra Translate repository from GitHub using HTTPS:

git clone --recurse-submodules https://github.com/Picovoice/zebra.git

Usage

1. Open the Android demo using Android Studio.
2. Copy your AccessKey from Picovoice Console into the ACCESS_KEY variable in MainActivity.java.
3. Go to Build > Select Build Variant... and select the language pair you would like to run the demo with (e.g. enfrDebug -> English to French translation demo)
4. Run the application using a connected Android device or using an Android simulator.

Resources