android-player-samples

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

Learn more about the Brightcove Native Player SDKs.

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:

Brightcove ExoPlayer sample apps:

An important note about the ExoPlayer sample apps

The ExoPlayer sample apps on the master branch only support Google ExoPlayer 2.10.8, which is the currently supported version of ExoPlayer with the Brightcove Native SDK for Android.

Brightcove sample apps using ExoPlayer

360 Video Sample app: This app shows how to use the Brightcove ExoPlayer to play 360 videos.
Ad Rules Sample App: This app shows how to use the Brightcove ExoPlayer with Google IMA ads.
Ad Rules Widevine Modular Sample App: This app shows how to use the Brightcove ExoPlayer with Google IMA ads and Widevine Modular content.
AppCompat Activity Sample App: This app shows how to setup the Brightcove ExoPlayer with the AppCompat plugin and an Activity.
AppCompat Fragment Sample App: This app shows how to setup the Brightcove ExoPlayer with the AppCompat plugin and a Fragment.
Basic Sample App: This app shows how to setup the Brightcove ExoPlayer to play.
Basic Cast Sample App with Brightcove Cast Receiver: This adds Google Chromecast support to the Brightcove Native Player SDK for Android, and demonstrates integration with the upated Brightcove Cast Receiver app v2.0. Please refer to the Release Notes in the v6.16.0 release of the Brightcove Native Player SDK for Android for more information.
Basic Cast Sample App with Google Cast Receiver: This adds Google Chromecast support to the Brightcove Native Player SDK for Android, and demonstrates integration with Google's Demo Receiver app. Please refer to the Release Notes in the v6.16.0 release of the Brightcove Native Player SDK for Android for more information.
FreeWheel Sample App: This app shows how to use the Brightcove ExoPlayer with FreeWheel ads.
FreeWheel Widevine Modular Sample App: This app shows how to use the Brightcove ExoPlayer with FreeWheel ads and Widevine Modular content.

Note that in order to enable the FreeWheel sample apps, you must independently obtain the non-free FreeWheel AdManager.aar library archive and install it into the directory libs/ which is typically located at the root of your /home/ directory. The Brightcove Native SDK for Android and the FreeWheel sample apps require the FreeWheel AdManager library version 6.28.0. Please note that Brightcove does not distribute the FreeWheel libraries. Contact FreeWheel directly for more information on how to obtain their products.

Basic SSAI Sample App: This app shows how to configure an app to use the Brightcove Native Player for Android SSAI Plugin to play a video.
ID3 Tags Sample App: This app shows how to use the Brightcove ExoPlayer with ID3 tags.
HLS Live Sample App: This app shows how to use the Brightcove ExoPlayer with HLS Live and Live DVR content. Please note that a Live/DVR URL is not supplied with this sample app, and must be supplied by the developer.
TextureView Sample App: This app shows how to use the Brightcove ExoPlayer with TextureView.
Widevine Modular Sample App: This app shows how to setup the Brightcove ExoPlayer with Widevine Modular content.
Offline Playback Sample App: This app demonstrates the Offline Playback feature.
Picture In Picture Sample App: This app demonstrates the Picture-in-Picture feature. Please note that Picture-in-Picture is supported only with Android 8.0 and above, and only on phone and tablet devices.

Brightcove MediaPlayer sample apps:

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.19.4 of the IMA SDK.
Basic Bundled Video Sample App: This app shows how to play a video that is stored on the device for offline viewing.
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.

As noted above, you must independently obtain the non-free FreeWheel AdManager.aar library archive and install it into the directory libs/ which is typically located at the root of your /home/ directory. The Brightcove Native SDK for Android and the FreeWheel sample apps require the FreeWheel AdManager library version 6.28.0. Please note that Brightcove does not distribute the FreeWheel libraries. 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.19.4 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 4.11.0 of the Adobe provided, non-free, jar file was used to test this sample app.

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, please make sure you have the latest version. You can obtain and install the latest version from: Android Studio After Android Studio is installed, please follow the following steps:

From Android Studio using VCS installation:

Select the Checkout From Version Control option in the new project dialog,
Pick the GITHUB menu entry
Use https://github.com/BrightcoveOS/android-player-samples.git for the URL
Click on SUBMIT and use default values on subsequent screens.

From Android Studio using Import

Clone this repo to your file system.
In the File menu, select the Import Project... option in the new project dialog,
Using the file selector dialog, select the top level build.gradle file from the cloned repo on your system,
Click on OK and use default values on subsequent screens.

Android Studio will now download, import and build all of the sample apps. 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.

Building with Gradle on the command line

These sample apps now build with the latest released version of Gradle, 5.4.1. Please note that when building these apps from the command line, that the Gradle daemon is started, and will continue to run after the build completes.

To stop the daemon after the build completes, run the following: ./gradlew --stop

Running a sample app

To run a sample app on an Android 5.0 or later device, plug the device into the computer and ensure that USB debugging is enabled.
Select a sample app from the Run/Debug Configuration selector and click on the run (green button) icon to start the sample.

Support

If you have questions, need help or want to provide feedback, please use the Support Portal or contact your Account Manager. To receive notification of new SDK software releases, subscribe to the Brightcove Native Player SDKs Google Group.

Enjoy!

The Brightcove Player Android Team

isabella232 / android-player-samples Goto Github PK