Push SDK, Short Video SDK, Player SDK, and Beauty Effects SDK license FAQ-Apsara Video SDK(Apsara Video SDK)-阿里云帮助中心

License error in the web player

Problem: A license error occurs when you use the Player SDK for Web.

Solution: Player SDK for Web v2.28.0 and later requires a license. New licenses are incompatible with earlier versions. Upgrade to v2.29.1 or later. If you have not purchased a license, go to the ApsaraVideo MediaBox SDK buy page to purchase a new license. After the purchase, you must bind it to your application.

License error in the mobile player

Problem: When using Player SDK for mobile clients v7.0.0 or later, an error like "License verify premium func:abr" appears.

Solution: Player SDK v7.0.0 and later offer different editions. Advanced features like ABR policies require a Professional Edition license. For more information, see Obtain an ApsaraVideo Player SDK license.

License expiration and renewal

Check the license expiration date

Log in to the ApsaraVideo VOD console or the ApsaraVideo Live console.
In the left navigation pane, choose SDK Management > My Licenses.
Click the License Management tab, find the license order that is bound to your application, and view its expiration date in the Expiration Date column.

Renew the license

Renew a license.

Important

If the expiration date in a text message differs from the console, the console date prevails (the validity period may have been manually extended). Ignore the expiration notice on the Renewal page in Billing and Cost Management. Disable auto-renewal.
If your license order bundles multiple SDK features, you must renew the entire order. Two methods are available:
1. If the license order has an instance ID, you can click Renew in the Actions column.
2. If the license order does not have an instance ID, you cannot use the Renew button. You must purchase a new license on the ApsaraVideo MediaBox SDK buy page and then bind it to your application.

Troubleshoot license errors

If a license error occurs during integration, follow these steps:

Verify the license configuration in the ApsaraVideo VOD or ApsaraVideo Live console.
1. Log in to the ApsaraVideo VOD console or the ApsaraVideo Live console.
2. In the left navigation pane, choose SDK Management > My Licenses.
3. Click the Application Management tab, find the target application, and then click Details. The application details and bound license information are displayed.
4. Verify the following:
  - Basic information: Check the application identifier (such as package name) and package signature. We recommend not binding a package signature.
  - License information: Check the SDK version, authorization type, expiration date, license status, and purchased value-added services.
Verify that the license configuration in your project matches the console.
- For web applications, check the license field configuration during player initialization.
  - domain: The domain where your player is hosted. Must match the domain specified during license application, or a subdomain of it.
  - key: Must match the license key displayed in the console.
- Android: Check the configuration in AndroidManifest.xml.
  - LicenseKey: Ensure the value of com.aliyun.alivc_license.licensekey matches the key displayed in the console.
  - License file: Ensure the value of com.aliyun.alivc_license.licensefile matches the path where your license file is stored.
  - Package ID: Ensure the applicationId in build.gradle matches the Package Name in the console.
  - Package signature: If you bound a signature when you created the license in the console, ensure the signature configured in your project matches the one bound in the console. Run the following command to query your package signature: keytool -v -list -keystore your.keystore.
- iOS: Check the Info.plist configuration.
  - Bundle ID: Check that the value of CFBundleIdentifier matches the Bundle ID configured in the console.
  - License Key: Check that the value of AlivcLicenseKey matches the one displayed in the console.
  - License file: Check that the value of AlivcLicenseFile matches the license file path in the ipa package.
- HarmonyOS: The main configuration to check is in the module.json5 file.
  - BundleId: The bundleName in app.json5 must match the HarmonyOS BundleID configured in the console.
  - LicenseKey: The value of com.aliyun.alivc_license.licensekey must match the license key displayed in the console.
  - License file: The value of com.aliyun.alivc_license.licensefile must match the path to the license file within the hap package.

Apply for a complimentary SDK license

If your cumulative spending or resource plan purchases in the last 31 days (T-30 to T) reach a certain threshold, you qualify for a complimentary license. Before your current license expires, you must bind the complimentary license. To apply for a complimentary Player SDK, visit Player SDK Gift Application. For other features, you can submit a ticket.

Important

T: The current day.
T-30: The 30th day before the current day.
The statistical period is the last 31 days and is calculated on a rolling basis.

Module	Edition	Applicable product	Complimentary criteria
Player SDK	Standard Edition/Professional Edition Does not include any value-added features.	ApsaraVideo Live ApsaraVideo VOD Intelligent Media Service	For more information, see Obtain an ApsaraVideo Player SDK license.
Push SDK	Standard Edition/Interactive Edition	ApsaraVideo Live	Complimentary. You can place an order on the ApsaraVideo MediaBox SDK buy page.
Short Video SDK	Basic Edition	ApsaraVideo VOD Intelligent Media Service	Purchase of any resource plan of CNY 1,800 or more.
Short Video SDK	Standard Edition	ApsaraVideo VOD Intelligent Media Service	Purchase of any resource plan of CNY 30,000 or more.
Beauty Effects SDK	Basic Edition	ApsaraVideo Live ApsaraVideo VOD	Purchase of any resource plan of CNY 99 or more.

License file and key updates

license file: Update the license file after renewal. The renewed file contains the updated expiration date and improves authentication success. An older license file in a published app typically continues to work.
license key: The license key remains unchanged. Each license key is uniquely mapped to a user ID (UID).

Modify an application ID

If your application information changes, modify it in the console.

Important

Changing application identifiers (such as Package Name) causes authentication to fail for apps using the old identifiers. Re-download and replace the license file. Proceed with caution.

Log on to the console.
In the left navigation pane, choose .
Click the Application Management tab. Find the target application and click Edit.
You can modify the application name, platform, Android application signature MD5 hash, and application identifiers such as the package name.
Click Modify to save the changes.

Modify the Android package signature

Modify the package signature with caution. Changing authorization settings such as the package signature may cause SDK authentication to fail for published app versions. Common scenarios:

If you change the package signature from A to B, app versions using signature A stop working. Create a new application with the same package name but signature B for new versions.
Unbinding the package signature may cause authentication failures on older SDK versions. Do not unbind if your app uses any of these versions:
- ApsaraVideo MediaBox SDK: v1.6.0 and earlier
- Player SDK: v5.5.1.0 and earlier
- Push SDK: v4.4.8 and earlier
- Short Video SDK: v3.35.0 and earlier

Modify authorized modules, editions, or features

The console does not support modifying license configurations. To add SDK modules or change the edition or features of an existing module, submit a ticket.