Skip to main content

Android SDK Installation

This guide covers the full installation of VLPlay SDK for Android, including Gradle configuration, permissions, and ProGuard rules. [PLACEHOLDER] VLPlay SDK requires Android API 21 or higher and is compatible with both Kotlin and Java projects. The SDK uses AndroidX and is fully compatible with Jetpack Compose.

[PLACEHOLDER] VLPlay SDK for Android is hosted on our private Maven repository. You must configure the repository URL in your project-level Gradle settings before adding the dependency.

1. Configure Repository​

settings.gradle.kts
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("https://maven.vlplay.vn/releases")
        }
    }
}

2. Add Dependency​

app/build.gradle.kts
dependencies {
    implementation("vn.vlplay:sdk-android:1.0.0")

    // Optional: In-App Purchase support
    implementation("vn.vlplay:sdk-android-iap:1.0.0")
}

3. Add Permissions​

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

4. ProGuard / R8 Rules​

If you use code minification, add the following to your ProGuard rules:

proguard-rules.pro
-keep class vn.vlplay.sdk.** { *; }
-keepattributes *Annotation*
-keepattributes Signature

5. Sync Project​

Run File → Sync Project with Gradle Files in Android Studio. If sync succeeds, proceed to Initialization.