Obtain and renew a short video SDK license-ApsaraVideo VOD(VOD)-阿里云帮助中心

The short video SDK requires a license. Learn how to obtain, use, and renew a license.

License service update

Starting from version 3.29.0, the short video SDK uses the integrated license service provided by ApsaraVideo for MediaBox. An ApsaraVideo for MediaBox license authorizes multiple SDKs: the Push SDK, short video SDK, ApsaraVideo Player SDK, and Queen SDK. Each license can be bound to a maximum of one Android application and one iOS application. This update also changes the SDK integration method.

Short video SDK version

Integration method

New integration

Integrate version 3.29.0 or later by following the latest documentation.

Android: Initialize the SDK.
iOS: Initialize the SDK.

SDK version upgrade

If you use a version earlier than 3.29.0, you can continue using it until the license expires. To upgrade to version 3.29.0 or later, call the registration API to integrate the LicenseKey and LicenseFile.

Important

Apply for the LicenseKey and LicenseFile in the ApsaraVideo VOD console. Go to SDK Management > My Licenses to enable license authorization. For detailed steps, see Manage licenses.

Android: Initialize the SDK.
iOS: Initialize the SDK.

Obtain a license

The short video SDK requires a license. License editions differ in price and features.

Compare editions in the Feature list. The following table describes how to obtain a license for each edition.

Note

A license is bound to the application's bundle ID and package name. Ensure the application information is correct when you apply.
For the same application under the same Alibaba Cloud account, the license file is shared. New license requests include previous request content, and you can use different metadata.

Free trial

Try the Basic Edition free for one month. Apply for a short video SDK trial. The trial requires license verification. Manage a license.

Note

After you apply, view your trial benefits in My Free Tiers.

Purchase a commercial edition

Important

T: The current day, inclusive.
T-30: 30 days before the current day, inclusive.
The statistical period is a rolling 31-day window.

Edition	Method	Notes
Basic Edition	Method 1: In the VOD console, navigate to SDK Management > My Licenses to create an application and bind a license. Apply for a Basic Edition trial (one month) or purchase the official license (one year). Manage License. Method 2: Purchase Data Transfer Plan, Storage Plan, Transcoding Plan, or Content Moderation Plan. If your total order amount exceeds CNY 1,900 within a rolling 31-day period, you can receive a free one-year Basic Edition license. After meeting the requirement, submit an application form. You will be notified of the result by email.	If you obtain a license by using Method 1, each order authorizes one application (for both iOS and Android).
Standard Edition	Method 1: In the VOD console, go to SDK Management > My Licenses, create an application and bind a license, and then apply for a Standard Edition trial (1 month) or purchase the official license (1 year). Manage Licenses. Method 2: Purchase Data Transfer Plan, Storage Plan, Transcoding Plan, or Content Moderation Plan. If your total order amount exceeds CNY 30,000 within a rolling 31-day period, you can receive a free one-year Standard Edition license. After meeting the requirement, submit an application form. You will be notified of the result by email.	If you obtain a license by using Method 1, each order authorizes one application (for both iOS and Android).
Professional Edition	Method 1: To apply for a Professional Edition trial (1 month) or purchase the official license (1 year), go to SDK Management > My Licenses in the VOD console to create an application and bind a license. Manage Licenses.	The Professional Edition includes advanced features such as advanced beautification, smart matting, and gesture recognition. These features are provided by Alibaba Cloud's Queen SDK or a third-party SDK and require separate purchases. Purchase the Queen SDK through Obtain a license for the Queen SDK. For third-party SDKs, contact their business representatives.

Renew a license

Check license expiration

Licenses expire after a set period. Expiration criteria differ by SDK version, with version 3.29.0 as the dividing line.

Versions earlier than 3.29.0:
- The API returns the ALIVC_FRAMEWORK_LICENSE_FAILED(-10011001) error code.
- One of the following messages appears in the logs:
  - License disabled due to no network access for 30 days. Please renew or re-obtain authorization.
  - License disabled. Please renew or re-obtain authorization.
  - Invalid license (package name/signature or bundle ID not registered on the official website of the short video SDK). The 7-day trial period has expired and the license is disabled.
Version 3.29.0 and later:
- The API returns the ALIVC_FRAMEWORK_LICENSE_FAILED(-10011001) error code.
- One of the following messages appears in the logs:
  - License expired. Please renew or re-obtain authorization.
  - License not initialized. Integrate by following Initialize the SDK (Android) or Initialize the SDK (iOS).
  - Invalid license (package name/signature or bundle ID not registered on the official website of the short video SDK). Please obtain a new authorization.
  - Value-added service 'xxx' has expired. Please renew or re-obtain authorization. ('xxx' is a placeholder for the specific value-added service.)
  - Invalid use of value-added service 'xxx'. Please obtain a license for the service before use. ('xxx' is a placeholder for the specific value-added service.)

Renew a license

Renew your license before it expires to prevent service interruptions. Two situations may prevent you from renewing directly from the License Management page:

Empty instance ID — The instance ID column for the order on the License Management page is empty.
Console error during renewal — A red error message appears at the bottom of the renewal page: Order configuration parameters do not meet validation criteria. Please reconfigure the product! This prevents you from completing the renewal by clicking Buy Now.
If you encounter either situation, purchase a new license and bind it to your application, or submit an Alibaba Cloud ticket for renewal.

In most cases, renew your license directly from the License Management page (Method 1). Use Method 2 if you received a complimentary license by consuming resources or purchasing a designated subscription package. Use Method 3 if the instance ID of your license order is empty or a console error occurs during renewal.

Method 1: Renew from the License Management page (recommended)

Renewal applies to the entire license order. If your license order includes multiple SDK entitlements, all of them are renewed together. You cannot change the configuration during renewal. If you have questions, submit an Alibaba Cloud ticket.

Go to the My Authorizations page in the ApsaraVideo VOD console.
Select the License Management tab, find the instance ID that is bound to the target application, and click Renew in the Actions column.
If the instance ID is empty or an error occurs in the console during renewal, use Method 3: Purchase a new license and bind the application or submit an Alibaba Cloud ticket for renewal.
On the renewal management page, click Renew in the Actions column. You are redirected to the Expenses and Costs > Renewals page. On the Manual Renewal tab, find the target ApsaraVideo MediaBox instance and click Renew in the Actions column.
On the ApsaraVideo MediaBox renewal page, confirm your current configuration and the renewal duration, and then click Buy Now to complete the renewal.
(Recommended) Enable auto-renewal to prevent expiration.

Method 2: Renew through resource plan purchase

If you have received a complimentary license by consuming resources or purchasing a designated subscription package, you must bind the new license before your current one expires. Follow the instructions in Step 3: Bind a license to avoid service interruptions from failed SDK calls in production.

SDK	Eligible amount	Application link
player SDK	For details, see Obtain a player SDK license.	Player SDK Bonus Application
short video SDK	For details, see Obtain a short video SDK license.	Apply by submitting a Yida form.
live streaming SDK	Free of charge	No application required

Method 3: Purchase a new license and bind the application

If the instance ID is empty for your purchased SDK license or if an error occurs during renewal, you must purchase a new license from the ApsaraVideo MediaBox Purchase Page before your current license expires. After the purchase, follow the instructions in Step 3: Bind a license to prevent service interruptions.