Quran Lab

Android quick start

The Kotlin SDK for Android: the install line, where the key goes, and the quick start.

The Kotlin SDK is an AAR for Android (minSdk 26, arm64-v8a and armeabi-v7a). The package is ai.quranlab:tajweedformer on Maven Central; the source is at github.com/Quran-Lab/tajweedformer-android.

Install

// settings.gradle.kts: mavenCentral() in the repositories
// app/build.gradle.kts
dependencies {
    implementation("ai.quranlab:tajweedformer:2.0.2")
}

The key

Use an apps key. The app is identified by its Gradle applicationId. Keep the key out of your repository:

# local.properties (git-ignored)
QURANLAB_KEY=qlk_v1_...

Read it in Gradle into a BuildConfig field or a manifest placeholder, and pass it to the SDK at launch.

What it needs

  • Android 8.0 (API 26) or later, on arm64-v8a or armeabi-v7a. The default emulator image on Intel and AMD PCs is x86-64 and does not run it: use a phone, or an ARM image.
  • The RECORD_AUDIO permission, asked for by your app, to hear the learner.
  • A connection once. The model (56.5 MB) downloads before the first session and every file is verified; after that it runs offline.

Quick start

The quick start for this version is in the package's README: github.com/Quran-Lab/tajweedformer-android.