Bitmovin Android Player

The Bitmovin Android Player internally consists of multiple modules that aren't meant to be included directly. Only the top-level player module should be included in your project.

The player can be included with Gradle by adding the following to your build.gradle.kts file:

    implementation("com.bitmovin.player:player:$bitmovinPlayerVersion")

Optional dependencies:

Advertising

In order to use advertising functionality, the following dependencies must be added manually

    implementation("com.google.ads.interactivemedia.v3:interactivemedia:3.31.0")
implementation("com.google.android.gms:play-services-ads-identifier:18.0.1")

Casting

In order to use casting functionality, the following dependency must be added manually

    implementation("com.google.android.gms:play-services-cast-framework:21.4.0")

Offline playback

In order to use offline functionality, the following dependency must be added manually

    implementation("androidx.localbroadcastmanager:localbroadcastmanager:1.1.0")

The following additional permissions are required in the manifest

    <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />

When targeting Android 13 (API level 33) and above, the following permission has to be declared in the manifest and requested at runtime before starting downloads Without that permission granted by the user, notifications posted by the download service are not displayed. See https://developer.android.com/develop/ui/views/notifications/notification-permission for more details.

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

When targeting Android 14 (API level 34) and above, the following permission is also required to enable downloading assets while the app is in the background. See https://developer.android.com/about/versions/14/changes/fgs-types-required#data-sync for more details.

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

Additional resources:

All modules:

Link copied to clipboard
Link copied to clipboard

The player-analytics module provides an integration for the Bitmovin Analytics Collector.

Link copied to clipboard

The player-core module contains all non web UI related API of the Bitmovin Android Player SDK.

Link copied to clipboard

The player-ui-web module provides an integration for the Bitmovin Player Web UI. It comes with a com.bitmovin.player.PlayerView and default UI handling to an attached com.bitmovin.player.api.Player instance.