AliPlayerKit Project Overview-ApsaraVideo VOD(VOD)-阿里云帮助中心

This topic describes the AliPlayerKit project, including an overview, core features, project structure, quick integration, getting started guide, demo, and related products.

Overview

AliPlayerKit is a core User Interface (UI) framework designed for video playback in video-centric applications.

It provides low-code, extensible UI components and scenario-based solutions. This lets you build full-featured video playback without handling complex player APIs or UI implementation details.

Core Features

Low-code integration: Integrate video playback with just a few lines of code. No direct calls to low-level player APIs are required.
Out-of-the-box UI components: Configurable player UI components that support basic playback and common interactions.
Scenario-based solutions: Built-in solutions for long-form video, short video, live streaming, and playlists to help you quickly deliver complete playback experiences.
Highly extensible architecture: A slot system lets you freely combine UI elements, and a policy system supports flexible extension of your business logic.

Download the Project

To download the project, visit AliPlayerKit. The repository includes clear documentation and step-by-step instructions for developers. In the future, we plan to add features that will further simplify and enhance the integration experience.

Project Structure

At the architectural level, AliPlayerKit is built on the player kernel. It unifies playback capabilities for various video use cases by providing a consistent UI component system and abstracted playback scenarios.

The project module structure is as follows:

PlayerKit-Android/
├── demo-app/                   # Demo app: Full-feature demonstration
├── demo-settings/              # Settings module: Configuration UI for the demo app
├── docs/                       # Documentation: Architecture overview, integration guide, and API reference
├── playerkit/                  # Core module: Player UI components
├── playerkit-examples/         # Examples module: Feature demonstrations
└── playerkit-scenes/           # Scenarios module: Business-scenario solutions

Read Online

To read the documentation online, visit Read Online. This site contains the latest information about the AliPlayerKit project.

Quick Integration

AliPlayerKit uses a layered architecture and offers two integration options. Choose the one that best fits your business needs:

Layer	Module	Description	Use case
Component layer	`playerkit`	Core UI components, including player view, controller, and data model.	You need custom UI or fine-grained control over playback behavior.
Scenarios layer	`playerkit-scenes`	Complete scenario solutions, including UI and business logic.	Quickly implement standard playback scenarios.

Note

For detailed integration steps, see Integration Preparation and Getting Started.

Demo

To help developers quickly experience the features of AliPlayerKit, we offer two options:

Run the project: Run the sample project to try all features.
Install the demo app: Install the APK directly on your device.

Run the Project

Prerequisites

Before you run the project, ensure that the following requirements are met:

Requirement	Description
JDK 11	Configure it in Preferences → Build Tools → Gradle → Gradle JDK, and select version 11.
Android Studio	Latest version: Android Studio.
Android SDK	Minimum API level 21 (Android 5.0). We recommend compileSdkVersion 31 or higher.
Gradle	Version 7.0 or higher.
License	You have obtained a player license certificate and license key. For details, see Manage Licenses.

Steps

Step 1: Add the license certificate file

Place the license certificate file in the demo-app/src/main/assets/cert/ directory.

Step 2: Configure the license key

Add the following code inside the <application> element in demo-app/src/main/AndroidManifest.xml:

<meta-data
    android:name="com.aliyun.alivc_license.licensekey"
    android:value="Your License Key" />
<meta-data
    android:name="com.aliyun.alivc_license.licensefile"
    android:value="assets/cert/license.crt" />

Step 3: Run the project

Open the project in Android Studio and run the demo-app module.

FAQ

Change the package name: Licenses are bound to the app package name. To change the demo-app package name:

Request a new license for the updated package name.
Update the applicationId in the demo-app/build.gradle file.
Update the package attribute in the demo-app/src/main/AndroidManifest.xml file.

Important

If the license is not configured correctly, the player will not work and may return an authorization error.

Demo application

We provide a demo app built from this project to help you quickly try out the features of AliPlayerKit. You can install and run the app directly on your device without setting up a development environment.

How to obtain the app:

Scan the QR code below with your mobile phone to download and install the demo app:

Demo QR Code

Note

Make sure your device allows the installation of apps from unknown sources.

Related Products

AliPlayerKit is built on the audio and video capabilities of Alibaba Cloud. We recommend using it with the following cloud services for optimal playback performance and user experience: