Installation

Adding the SDK takes a repository line, a dependency and a few build settings.

The current version is 3.2.0-rc1, a release candidate of 3.2.0. The coordinates on this page use this version. Once the final version is released, only the version number changes.

1. Add the Maven repository#

The SDK is published to a Maven repository hosted by Veeplay. Add it next to google() and mavenCentral():

repositories {
    google()
    mavenCentral()
    maven { url "https://s3-eu-west-1.amazonaws.com/android.veeplay.com/releases" }
}

If your project declares repositories in settings.gradle (dependencyResolutionManagement), add the maven line there instead.

2. Add the dependency#

dependencies {
    implementation 'com.veeplay:veeplay-player-android:3.2.0-rc1'
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.1.5'

    // optional, only for Google Cast
    implementation 'com.veeplay:veeplay-player-android-cast:3.2.0-rc1'
}

Artifact	Purpose
`com.veeplay:veeplay-player-android`	The player. Required.
`com.veeplay:veeplay-player-android-cast`	Google Cast support. Optional, see Google Cast.

Use desugar_jdk_libs 2.1.5 or higher. The SDK does not ship it, so the choice of version is yours.

3. Set the build requirements#

android {
    compileSdk 36

    defaultConfig {
        minSdk 24
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_11
        targetCompatibility JavaVersion.VERSION_11
        coreLibraryDesugaringEnabled true
    }
}

You also need Android Gradle Plugin 8.6.0 or higher, which in turn needs Gradle 8.7 or higher and JDK 17. If your AGP prints a warning that compileSdk 36 is newer than it was tested with, update the AGP rather than lowering compileSdk.

Two dependency notes for apps that upgrade from 3.1:

Keep Gson on 2.13.x. A newer Gson makes JSON configuration fail.
Remove any com.google.android.exoplayer (ExoPlayer 2) dependency. Its resources clash with Media3's.

If your app declares missingDimensionStrategy 'veeplaySDK', 'general' in its product flavors, you can remove it. The SDK has no flavors any more.

4. Manifest#

The player needs network access. You do not need to declare the INTERNET permission yourself: it is merged into your manifest from the SDK's dependencies (the Google IMA SDK).

The SDK declares its own activities, including the web browser used for ad clickthroughs, so you do not need to add them.

Only if you use Google Cast, also add the Cast options provider inside <application>:

<meta-data
    android:name="com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
    android:value="androidx.media3.cast.DefaultCastOptionsProvider" />

See Google Cast for the rest of the Cast setup.

5. Register your app#

Next step#

Continue with the Quick start.