YouTube Android Player API

The YouTube Android Player API enables you to incorporate video playback functionality into your Android applications. The API defines methods for loading and playing YouTube videos (and playlists) and for customizing and controlling the video playback experience.

Using the API, you can load or cue videos into a player view embedded in your application's UI. You can then control playback programmatically. For example, you can play, pause, or seek to a specific point in the currently loaded video.

You can also register event listeners to get callbacks for certain events, such as the player loading a video or the player state changing. Finally, the API has helper functionality to support orientation changes as well as transitions to fullscreen playback.

How it works

The API client library interacts with a service that is distributed as a part of the YouTube app for the Android platform. The client library has a light footprint, meaning it won't adversely impact your app's file size, if you use ProGuard as part of your build process.

As the API develops, you will be able to access newly introduced API features by upgrading to a newer version of the API client library. However, upgrading is not necessary if you do not care about new features or bug fixes.

In addition, the YouTube app is delivered through the Google Play Store, which means that updates to the API service are not dependent on carrier or OEM system image updates. Generally, devices running Android 2.2 (Froyo) or later that have the Google Play Store app installed will receive updates within a few days. As a result, your application can use the YouTube Android Player API and reach most devices in the Android ecosystem.

Note: Users need to run version 4.2.16 of the mobile YouTube app (or higher) to use the API.

Getting Started

The following documents will help you to set up your development environment and use the YouTube Android Player API:

  • The download page provides a link to download the API client library and JavaDocs.

  • The instructions for registering your application explain how to register your app in the Google API Console and to obtain an Android API key, which you will need to use the API.

  • The setup instructions explain how to set up an API project using either Eclipse or IntelliJ.

  • The sample applications overview describes the sample applications included in the API download.

  • The JavaDoc reference provides detailed definitions of the API's interfaces, classes, methods, and enums.