Quick start

Updated at:

Quickly integrate the ApsaraVideo MediaBox SDK into your app by following these steps.

Step 1: Understand MediaBox SDK features

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

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 SDK demo

Scan the following QR code to download and install the MediaBox SDK demo app.

image.png

For the demo's source code, see Try the demo.

(Optional) Step 3: Try the AUI Kits demo

Scan the following QR code to download and install the low-code interactive live streaming app.

image.png

For the demo source code and more use cases, see AUI Kits low-code application solution.

Step 4: Apply for a license

Step 1: Create an application

  1. Go to the My Authorizations page in the ApsaraVideo VOD console. On the Application Management tab, click Create Application.

  2. Enter the application information. Applications are categorized by platform: Web or Mobile.

    • Web: Enter an Application Name and the corresponding Web Domain. Select I understand and agree to the compliance commitments (click View Statement for details), and then click Create.

      Create a Web application

      Web domain guidelines

      • Example of a valid domain: aliyun.com. To cover multiple subdomains, such as pc.aliyun.com and mobile.aliyun.com, enter only the primary domain name aliyun.com.

      • Avoid the following formats:

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

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

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

    • Mobile: Select a platform, enter an Application Name, and provide the corresponding Android package name, iOS Bundle ID, and HarmonyOS Bundle ID to create the application.

      The HarmonyOS Bundle ID can be found in the bundleName field of your project's app.json5 file. After you enter the information, select the Compliance Commitment checkbox and click Create.

      Create a mobile application

      Bind an Android application signature

      • This field is required if you select Android for the Platform Type and select Bind Signature.

      • Binding a signature enhances security by preventing other applications with the same package name from using the license.

      • Newer SDK versions do not require a bound signature, including ApsaraVideo MediaBox v1.7.0 and later, player SDK v5.5.2 and later, live streaming 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:

      • Run the keytool -v -list -keystore your.keystore command to view the MD5 value of the corresponding signature.

      • From Android Studio: Click Gradle in the right-hand sidebar and navigate to Tasks > android > signingReport for the app. Convert any letters in the resulting MD5 value to lowercase and remove the colons.

Step 2: Purchase a license

Note
  • If you have already purchased a license, proceed to Step 3: Bind a license.

  • The Standard Edition and the Professional Edition of the player SDK ship in the same SDK package and are distinguished by license type. After you purchase a Professional Edition license and bind it to your application, you can use the Professional Edition features.

  1. Return to the My Authorizations page, select the Order Instances tab, and click Purchase License.

  2. On the ApsaraVideo MediaBox purchase page, select the SDK and function modules based on your business needs , and complete the purchase.

    When you purchase a player SDK license, ensure that the platform you select matches your application's platform type. A mismatch causes the license binding to fail.

    Note

    SDK benefits can only be purchased separately. For example, Player SDK Standard Edition can be purchased separately.On the MediaBox Audio and Video SDK purchase page, select the version of each SDK module as needed.After the selection is completed, confirm the purchase quantity and payable expenses, and click Buy Now to complete the payment.

  3. After the payment is successful, return to the Order Instances tab to view your new order instance.

Step 3: Bind a license

  1. Return to the My Authorizations page, select the License Management tab, and click Bind License.

  2. On the Bind License page, select the application and the SDK license order to bind. Each license order can be bound to a single application.

  3. In the Authorized Platforms section, select the platforms that you want to authorize, such as Android. A mobile license is valid only for a mobile application.

  4. After you confirm the information, click Bind.

    After a successful binding, return to the License Management tab to view the bound application name and its authorization information.

Step 4: Obtain authorization information

  1. On the License Management tab, find the target application. Your License Key is displayed at the top of the page. Click the copy button to copy the key. A Download Certificate link is available under each application name in the list.

  2. After you confirm the authorization details, click Download Certificate to save the license file to your local machine. Also, save the license key for use during application integration. For instructions on configuring the license file, see Integrate a license.

Step 5: Integrate the SDK and configure the license

For detailed instructions, see All-in-one SDK integration.

Step 6: Implement business logic

For more information, see integration by module.