All Products
Search

This Product

    Apsara Video SDK:Getting started

    Document Center

    Apsara Video SDK:Getting started

    Last Updated:Nov 28, 2025

    This topic describes how to get started with ApsaraVideo MediaBox SDK. 

    Step 1: Understand the features of MediaBox SDK

    ApsaraVideo MediaBox SDK offers four integrated SDKs tailored for various scenarios: SDK for basic streaming, SDK for interactive streaming, SDK for short videos, and all-in-one SDK.

    Feature

    Player SDK

    Push SDK

    ARTC SDK

    Short Video SDK

    Queen SDK

    Live streaming by streamer

    Supported

    • Streamer-viewer co-streaming

    • Streamer battle

    Supported

    (available in Interactive Edition)

    Supported

    Audio and video call

    Supported

    Video recording

    Supported

    Video editing

    Supported

    Video upload

    Supported

    Live streaming

    Supported

    VOD

    Supported

    Retouching

    Supported

    Gesture recognition

    Supported

    Chroma key

    Supported

    Step 2 (Optional): Try a demo of ApsaraVideo MediaBox SDK

    Scan the following QR code to download and install a demo of ApsaraVideo MediaBox SDK. 

    image.png

    For more information about the demo source code, see Demo.

    Step 4: Apply for a license

    Step 1: Create an application

    1. Go to the My Licenses page in the VOD console, select the Application Management tab, and click Create Application.image

    2. Edit the application information. Applications are categorized by client type: Web and Mobile.

      1. Web: Enter an Application Name and Web Domain Name.image

        Notes on web domain name:

        • Correct format example: aliyun.com.

          Important

          To cover multiple subdomains (for example, pc.aliyun.com and mobile.aliyun.com), enter the root domain: aliyun.com.

        • Incorrect format examples:

          • Including a protocol: http://aliyun.com or https://aliyun.com.

          • Including a path or subpage: aliyun.com/index or aliyun.com/login.

          • Using a wildcard domain name: *.aliyun.com or .aliyun.com.

      2. Mobile: Enter an Application Name, Android Package Name, iOS BundleID, and HarmonyOS BundleID based on the platforms you select.

        image

        Associate an Android application signature

        Note

        • This field is required if you select Android for Platform Type and check Associate Signature.

        • Associating an application signature enhances security and prevents other applications with the same package name from using your license.

        • Newer SDK versions do not require you to associate an application signature. These versions include: ApsaraVideo MediaBox SDK V1.7.0 and later, ApsaraVideo Player SDK V5.5.2 and later, Push SDK V4.4.9 and later, and Short Video SDK V3.36.0 and later.

        Obtain the MD5 hash of an Android application signature in one of two ways:

        • Via command line: Run keytool -v -list -keystore your.keystore to view the MD5 hash of the corresponding signature.

        • Via Android Studio: In the right-hand sidebar, navigate to Gradle > Tasks > android > signingReport. When using this method, convert all letters in the MD5 hash to lowercase and remove the colons.image.png

    Step 2: Purchase a license

    Note

    If you have already purchased a license, proceed to Step 3: Associate a license.

    1. Return to the My Licenses page, select the Instance tab, and click License Purchase.image

    2. On the ApsaraVideo MediaBox SDK purchase page, select the SDK and feature modules you need. Confirm your selections and complete the purchase.

    3. After payment, return to the Instance tab. You will see the newly purchased instance.

    Step 3: Associate a license

    1. Return to the My Licenses page, select the License Management tab, and click Associate License.image

    2. On the Associate License page, select the application and the corresponding SDK license order. After confirming the information, click Associate.

      Note

      You can associate each license order with a maximum of one application, covering web and mobile platforms.

      image

    3. After the association is successful, return to the License Management tab. You will see the name of the associated application and its authorization information.

    Step 4: Obtain authorization information

    1. On the License Management tab, find the target application.image

    2. Confirm that the authorization information is correct. Click Download Certificate to download the license certificate file. Save the License Key to integrate into your application. To configure the license file, see Bind a license.

    Step 5: Integrate ApsaraVideo MediaBox SDK and configure the license

    For more information, see Quick integration.

    Step 6: Implement business logic based on your requirements

    For more information, see Integration by module.