android-player-samples

Still under development and is experimental - please use at your own risk. See release notes in the top level file release-notes.txt.

======================

Provides sample apps for the Brightcove Player SDK and Plugins for Android.

The Android sample app projects in this repository can be inserted directly into Android Studio and subsequently executed or simulated. This version of the sample apps supports the latest Brightcove SDK and plugins. The following sample apps are included:

• Ad Rules Google IMA Sample App: This app shows how to setup to use the Google IMA Plugin to play ads via Ad Rules. This version has been tested and works with v3 of the IMA SDK.

• Ad Rules Google IMA Widevine Sample App: This app shows how to setup to use the Google IMA Plugin to play ads via Ad Rules with a Widevine video. This version has been tested and works with v3 of the IMA SDK.

• Basic Akamai Identity Services Sample App: This app shows how to configure an app to use the Brightcove native Android player with Akamai Identity Services.

• Basic AdobePass Sample App: This app shows how to configure an app to use the Brightcove native Android player with AdobePass.

• Basic Bundled Video Sample App: This app shows how to play a video that is stored on the device for offline viewing.

• Basic Cast Sample App: This add Google Chromecast with the Brightcove native Android player. Note that this app requires installation of the Google Play and Google Repository plugins into the Android Studio. To install these plugins, open Android Studio, and then open the Tools menu. From here, select Android, then SDK Manager. When the SDK Manager opens, scroll to the bottom and select Google Play Services and Google Repository under the Extras menu. Click Install Packages, accept the license agreement, and close the SDK Manager when installation completes.

• Basic FreeWheel Sample App: This app shows how to configure an app to use the Brightcove native Android player FreeWheel Plugin to play a video.

• Basic FreeWheel Widevine Sample App: This app shows how to configure an app to use the Brightcove native Android player FreeWheel Plugin to play a Widevine video.

Note that in order to enable the FreeWheel sample apps, you must independently obtain and install the non-free file AdManager.jar into the top-level directory libs/. The FreeWheel sample apps were tested with version 5.7.2. Contact FreeWheel directly for more information on how to obtain their products.

• Basic Google IMA Sample App: This app shows how to setup to use the Google IMA Plugin to play ads before, during and after a video. This version has been tested and works with v3 of the IMA SDK.

• Basic Google IMA Widevine Sample App: This app shows how to setup to use the Google IMA Plugin to play ads before, during and after a Widevine video. This version has been tested and works with v3 of the IMA SDK.

• Basic Omniture Sample App: This app shows how to configure an app to use the Brightcove native Android player Omniture Plugin to play a video.

Note that in order to enable this sample app, you must independently obtain and install the file adobeMobileLibrary.jar into the top-level directory libs/. Version 3.2.2 of the Adobe provided, non-free, jar file was used to test this sample app.

• Basic Widevine Sample App: This app shows how to configure an app to use the Brightcove native Android player Widevine Plugin to play a video.

• HLS Player FreeWheel Sample App: This app shows how to configure an app to use the HLS Player with the FreeWheel Plugin to play a video.

• HLS Player ID3 Sample App: This app shows how to use ID3 tags with the HLS player.

• HLS Player Google IMA Sample App: This app shows how to configure an app to use the HLS Player with the Google IMA Plugin to play a video.

• HLS Player Sample App: This app shows how to setup the HLS player to play.

• WebVTT Sample App: This app shows how to implement closed captioning using WebVTT files with Android 4.4.

Installing the sample apps

Currently, all of the sample app projects must be installed together as a bundle. Individual sample app projects also have specific dependencies. For those specific dependencies, see the individual project descriptions above for details.

To install the sample apps into Android Studio follow these steps:

1. Obtain and install the latest version of Android Studio using the provided on-line instructions,
2. Configure Android Studio for Android versions from Android 10 to Android 19 (see Android Studio help for details),
3. Invoke the new project wizard using the File menu if it is not presented by default,

From Android Studio using VCS installation:

1. Select the Checkout From Version Control option in the new project dialog,
2. Pick the GITHUB menu entry
3. Use [email protected]:BrightcoveOS/android-player-samples.git for the URL
4. Click on SUBMIT and use default values on subsequent screens.

From Android Studio using Import

1. Clone this repo to your file system.
2. Select the Import Project... option in the new project dialog,
3. Using the file selector dialog, select the top level build.gradle file from the cloned repo on your system,
4. Click on OK and use default values on subsequent sceens.

Android Studio will now download/import and build the sample app. At this point the samples will be in your instance of Android Studio where you can observe the snippets in action on a physical or virtual device, walk through the code using the Android Studio debugger, search on keywords or just browse Android source code.

Overriding the default build behavior

By default, the sample apps will build with the most recent Brightcove Android Native Player version at build time. To override this behavior with a specific version, create a file named .gradle/gradle.properties in your home directory and set the value of the property anpVersion to the desired version. An invalid version will cause no sample app projects to be configured.

Running a sample app

1. To run a sample app on an Android 4.2.2 or later device, plug the device into the computer and ensure that USB debugging is enabled. Android Studio will recognize the device as long as the device identifies as running a version between Android 10 and Android 19 otherwise Android Studio will run the sample app in the simulator. Using the simulator is not recommended as video support is buggy. This will be resolved as Android Studio and the Android SDK mature.
2. Select a sample app from the Run/Debug Configuration selector and click on the run (green button) icon to start the sample.

Enjoy!

The Brightcove Player Android Team