Quick Start

更新时间:
复制 MD 格式

This topic describes how to quickly integrate the MediaBox audio and video SDK.

Step 1. Learn about the features of the MediaBox audio and video SDK

The MediaBox Audio/Video SDK currently offers four all-in-one SDKs for different scenarios: Basic Live SDK, Interactive Live SDK, Short Video SDK, and Standard All-in-one SDK.

Feature

Player SDK

Push SDK

ARTC SDK

Short Video SDK

Queen SDK

Start streaming

Supported

  • Streamer-viewer interactive streaming

  • Cross-channel PK battles

Supported

(Interactive Edition)

Supported

Audio/video calls

Supported

Video recording

Supported

Video editing

Supported

Video upload

Supported

Live playback

Supported

VOD playback

Supported

Retouching and effects

Supported

Gesture recognition

Supported

Smart matting

Supported

(Optional) Step 2. Try the MediaBox audio and video SDK demo

Scan the following QR code to download and install the MediaBox audio and video SDK app to try it out.

image.png

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

(Optional) Step 3. Try the AUI Kits low-code application solution demo

Scan the following QR code to download and install the low-code interactive stream app to try it out.

image.png

For the demo source code and more scenarios, see AUI Kits Low-code Application Solution.

Step 4. Request a license

Step 1: Create an application

  1. Log on to the ApsaraVideo VOD console, go to My Licenses, select the Application Management tab, and click Create Application.image

  2. Enter the application details based on the selected platform.

    1. Web: Enter the Application Name and the corresponding Web Domain Name.image

      Notes on web domain name:

      • Correct format example: aliyun.com.

        Important

        To authorize multiple subdomains, such as pc.aliyun.com and mobile.aliyun.com, enter only 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: Select the platform, enter the Application Name, and provide the corresponding Android Package Name, iOS Bundle ID, and HarmonyOS Bundle ID.

      image

      Bind an Android application signature

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

      • Binding the signature improves security and prevents other applications with the same package name from using your license.

      • Newer SDK versions do not require a bound 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.

      You can obtain the MD5 value of your Android application signature in two ways:

      • From the command line: Run the following command to view the MD5 value of the corresponding signature.

        keytool -v -list -keystore your.keystore
      • From Android Studio: In the right-hand sidebar, click the Gradle tab and navigate to Tasks > android > signingReport. If you use this method, you must convert the MD5 value to lowercase and remove the colons.image.png

Step 2: Purchase a license

Note

If you have 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.

    Important

    Ensure the selected platform matches your application's target platform. A platform mismatch will cause the license binding to fail.image

  3. After payment, return to the Instance tab. The purchased license will be listed.

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

    Each license order can be bound to a single application.

    image

  3. After the binding 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, locate 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 Configure a License.

Step 5. Integrate the MediaBox audio and video SDK and configure license authorization

For more information, see Integrate the all-in-one SDK.

Step 6. Implement business logic as needed

For more information, see Integrate by module.