Push SDK, Short Video SDK, Player SDK, and Queen SDK license FAQ - Apsara Video SDK

This topic describes common issues and solutions for applying for, renewing, using, and modifying license binding information.

What to do if a license error occurs in Player SDK for Web

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

Solution: If you use Web Player SDK V2.28.0 or later, you must purchase a license. These licenses are not compatible with Web Player SDK versions earlier than 2.28.0. We recommend that you use Web Player SDK V2.29.1 or later to avoid service disruptions. If you have not purchased a Web Player SDK license, you can purchase a new one on the or the ApsaraVideo MediaBox SDK page. After the purchase, you must bind the license again.

What to do if a license error occurs in Player SDK for mobile

Problem: An error similar to "License verify premium func:abr" occurs when you use Player SDK for mobile V7.0.0 or later.

Solution: Player SDK for mobile V7.0.0 and later offers features in different editions. To use Professional Edition features, such as advanced adaptive bitrate (ABR) policies, you must purchase and bind a Professional Edition license. For more information, see Get a license for Player SDK.

How to view the license expiration date and renew the license

View the license expiration date

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

Renew the license

For more information about license renewal, see Renew a license.

Important

If the license expiration date in the SMS notification you receive is different from the expiration date in the console, this is because the validity period was manually extended for historical reasons. The date in the console takes precedence. Ignore the expiration prompt on the Renewals page in Expenses and Costs. We recommend that you disable the auto-renewal feature.
If your historical license order is a package that combines multiple software development kit (SDK) features, you must renew the entire license order. You cannot renew individual features separately. You can renew the license in one of the following ways:
1. If the license order has an instance ID, click Renew in the Actions column.
2. If the instance ID of the license order is empty, you cannot renew the license using the Renew button. You must purchase a new license order from the or the MediaBox Audio/Video SDK page, and then perform License Binding again.

How to troubleshoot license errors

If the license integration fails or an error occurs, you can troubleshoot the issue as follows:

Check whether the license authorization configuration in the ApsaraVideo VOD or ApsaraVideo Live console is correct.
1. Log on to the ApsaraVideo VOD console.
2. In the navigation pane on the left, choose SDK Management > My Licenses.
3. Click the Application Management tab, find the target application, and click Details. The basic information about the application and the bound license is displayed.
4. Check whether the following information is correct.
  - Basic application information: Application identifier (such as Package Name) and package signature. We recommend that you do not bind a package signature.
  - Bound license information: SDK version, authorization type, expiration date, status, and value-added services.
Check whether the license configuration in your project is correct and consistent with the license information in the console.
- Web: Check the license field configuration in the player initialization code.
  - domain: Check whether the domain name of the page where your player is located is the same as or a subdomain of the domain name that you specified when you applied for the license.
  - key: Check whether the value of the License Key is the same as the one that is displayed in the console.
- Android: Check the AndroidManifest.xml configuration.
  - LicenseKey: Check whether the value of com.aliyun.alivc_license.licensekey is the same as the one that is displayed in the console.
  - Certificate file: Check whether the value of com.aliyun.alivc_license.licensefile is the same as the path where your certificate file is stored.
  - Package ID: Check whether the applicationId in build.gradle is the same as the Package Name in the console.
  - Package signature: If you bound a signature when you created the license in the console, make sure that the signature configured in the project is the same as the one that is bound in the console. You can run the following command to query your package signature: keytool -v -list -keystore your.keystore.
- iOS: Check the Info.plist configuration.
  - Bundle ID: Check whether the value of CFBundleIdentifier is the same as the Bundle ID that you configured in the console.
  - LicenseKey: Check whether the value of AlivcLicenseKey is the same as the one that is displayed in the console.
  - Certificate file: Check whether the value of AlivcLicenseFile is the same as the path of the certificate file in your ipa package.
- HarmonyOS: Check the module.json5 configuration.
  - BundleId: Check whether the value of bundleName in the app.json5 file is the same as the HarmonyOS BundleID configured in your console.
  - LicenseKey: Check whether the value of com.aliyun.alivc_license.licensekey is the same as the one that is displayed in the console.
  - Certificate file: Check whether the value of com.aliyun.alivc_license.licensefile is the same as the path of the certificate file in your hap package.

Do I need to update the license file and key after I purchase and authorize a new license?

License file: We recommend that you update the file. After renewal, the expiration date in the license file is updated. Using the updated license file can improve the authentication success rate. In general, using a historical license file in a released app does not affect its functionality.
License Key: The key remains unchanged. The License Key has a one-to-one mapping with a UID.

How to modify the application ID

You can modify the information about the application that is bound to a license in the console.

Important

Modifying the application identifiers such as package name will cause authentication failures for applications with the original identifiers. You must download the new certificate file to replace the old one. Proceed with caution.

Log on to the ApsaraVideo VOD console.
In the left-side navigation pane, choose SDK Management > My Licenses.
On the Application Management tab, find the desired application and click Edit in the Actions column.
Modify the application name, platform, MD5 hash, and application identifiers such as package name.
Confirm the settings and click Modify.

Modify the MD5 hash of an Android application signature

Modify the MD5 hash of the signature with caution to prevent service disruptions. An app that integrates ApsaraVideo MediaBox SDK requires a license file and key. If you modify the authorization configuration, such as the MD5 hash of the signature, the SDK in the released app version may fail the authorization check. This can cause features to malfunction. Common scenarios are as follows:

If you change the MD5 hash of the signature for an Android app from A to B, the app configured with "MD5 hash=A" will malfunction. In this case, create a separate application. Use the same package name and set "MD5 hash=B" for the new version.
If you unbind the signature, older SDK versions cannot pass the authorization check. Do not unbind the signature if your app has ever used the following SDK 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

How to modify authorized modules, versions, and features

The console does not currently support upgrading or downgrading configurations. To add SDK modules or modify the version or features of existing SDK modules, you can submit a ticket.