Download the SDK

Last updated: April 15, 2019

If you are using JW Player SDK for Android 2.x.x, use this SDK documentation.

To add a player to your app, you must import the JW Player SDK for Android and then configure your project. You can choose one of three approaches to complete these tasks. In the following table, several notes about each approach are listed. Read each approach and click the GET STARTED link for the approach that suits your implementation needs.

Approach Notes
Gradle - No SDK download is required.
- Core and optional modules must be added to your app.
- ProGuard automatically applied. ProGuard protects the SDK classes.
- An existing app is required.
- Either the standard SDK repository or SDK with Amazon Fire (Fire OS 5+) support repository can be accessed.

GET STARTED
Local - JW Player SDK for Android must be downloaded and unzipped.
- Core and optional modules must be imported.
- ProGuard must be configured. ProGuard protects the SDK classes.
- An existing app is required.

GET STARTED
Demo - JW Player SDK for Android Open Source Demo must be downloaded.
- All modules are included. No modules need to be imported or set as dependencies.
- ProGuard automatically applied. ProGuard protects the SDK classes.
- An existing app is not required. The open source demo is a basic demonstration app that allows you to experiment with the SDK.

GET STARTED



Gradle

In the following subsections, you will learn how to complete these tasks:

  1. Get required items.
  2. Import SDK.

If you have problems completing any of these tasks, please log a support ticket for assistance.

Get required items

Before you begin the Gradle approach to add the SDK to your project, you need the items in the table below from JW Player.

Item Acquisition process
Enterprise or Developer license JW Player SDK for Android requires an Enterprise or Developer license.
Android Studio 1. Download Android Studio.
2.
Install Android Studio.
License key 1. From your JW Player dashboard, click Players > PLAYER DOWNLOADS & KEYS.
2. In the Downloads section, copy the LICENSE KEY for the Android SDK.

Import SDK

Now that you have the required items listed in the previous subsection, you can import the JW Player SDK for Android to your project and add dependencies.

Add SDK to your project

  1. From within Android Studio, open your app.
  2. Open the build.gradle file for your project.
  3. Add the JW Player Maven repository URL to your project. You can choose on one of two repositories:

    - For the standard JW Player SDK for Android, add https://mvn.jwplayer.com/content/repositories/releases/ to your project.
    - For the JW Player SDK for Android with Amazon Fire support, add https://mvn.jwplayer.com/content/repositories/amazon/ to your project. 
allprojects {
    repositories {
        ...
        maven {
            url 'https://mvn.jwplayer.com/content/repositories/releases/'
        }
    }
}

Add SDK dependencies

  1. Open the build.gradle file for your app.
  2. Add the com.longtailvideo.jwplayer:jwplayer-core and com.longtailvideo.jwplayer:jwplayer-common dependencies.
  3. Sync Gradle.
dependencies {
  ...
  implementation 'com.longtailvideo.jwplayer:jwplayer-core:#sdk_version_simple#'
  implementation 'com.longtailvideo.jwplayer:jwplayer-common:#sdk_version_simple#'
}

You have retrieved your JW Player license key and imported the JW Player SDK for Android into your project. You can now configure your project.


Local

In the following subsections, you will learn how to complete these tasks:

  1. Get required items.
  2. Import SDK.

If you have problems completing any of these tasks, please log a support ticket for assistance.

Get required items

Before you begin the Local approach to add the SDK to your project, you need the items in the table below from JW Player.

Item Acquisition process
Enterprise or Developer license JW Player SDK for Android requires an Enterprise or Developer license.
Android Studio 1. Download Android Studio.
2.
Install Android Studio.
JW Player SDK for Android and license key 1. From your JW Player dashboard, click Players > PLAYER DOWNLOADS & KEYS.
2. In the Downloads section, select a VERSION of the Android SDK from the dropdown menu.
3. Click the icon in the DOWNLOAD column.
4. Copy the LICENSE KEY for the Android SDK.
5. On your computer, unzip the SDK ZIP file.

Import SDK

Now that you have the required items listed in the previous subsection, you can add JW Player SDK for Android modules to your project and add dependencies.

Add module to your project

  1. From within Android Studio, open your app.
  2. Click File > New > New Module... > Import .JAR / .AAR Package.
  3. Click Next.
  4. Select jwplayer-core-#sdk_version_simple#.aar from your computer.
  5. Click Finish.
  6. Repeat the previous steps and add jwplayer-common-#sdk_version_simple#.aar.

Add SDK dependencies

  1. Click File > Project Structure... > Dependencies. Under Modules, be sure that your app is selected.
  2. Click the plus sign in the main panel.
  3. Select Module dependency.
  4. Select jwplayer-core-#sdk_version_simple# and jwplayer-common-#sdk_version_simple#.
  5. Click OK.

You have retrieved your JW Player license key and imported the JW Player SDK for Android into your project. You can now configure your project. If necessary, you can also configure ProGuard.


Demo

The JW Player SDK for Android Open Source Demo is a basic demonstration app. In the following subsection, you will learn how to get required items.

If you have problems completing any of these tasks, please log a support ticket for assistance.

Get required items

Before you can start experimenting with the JW Player SDK for Android Open Source Demo, you need the items in the table below from JW Player.

Item Acquisition process
Enterprise or Developer license JW Player SDK for Android requires an Enterprise or Developer license.
Android Studio 1. Download Android Studio.
2.
Install Android Studio.
JW Player SDK for Android Open Source Demo and license key 1. Clone the repository into your Android Studio workspace:

git clone git@github.com:jwplayer/jwplayer-sdk-android-demo.git.

2. From your JW Player dashboard, click Players > PLAYER DOWNLOADS & KEYS.
3. In the Downloads section, copy the LICENSE KEY for the Android SDK.

You have retrieved your JW Player license key and imported the JW Player SDK for Android Open Source Demo into Android Studio. You can now configure your project.



Use this form to provide your feedback.