Push SDK, Short Video SDK, Player SDK, and Beauty Effects SDK license FAQ - ApsaraVideo VOD

This topic answers frequently asked questions about applying for, renewing, using, and modifying the application information bound to a license.

License error in the web player

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

Solution: Integration with Player SDK for Web v2.28.0 or later requires a license. Newly purchased licenses are not compatible with earlier versions of Player SDK for Web. To ensure full functionality, we recommend upgrading to v2.29.1 or later. If you have not purchased a Player SDK 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 you use Player SDK for mobile clients v7.0.0 or later, an error message similar to "License verify premium func:abr" appears.

Solution: Player SDK v7.0.0 and later are available in different editions. To use advanced features such as advanced ABR policies, you must purchase and bind a Professional Edition license. For more information, see Obtain an ApsaraVideo Player SDK license.

Check license expiration and renew

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

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

Important

If the license expiration date in the text message you received differs from the date displayed in the console, it is because the validity period was manually extended for historical reasons. The expiration date in the console prevails. You can ignore the expiration notice on the Renewal page in the Billing and Cost Management console. We recommend disabling the auto-renewal feature.
If your historical license order bundles multiple SDK features, you must renew the entire license order. You cannot renew a single feature separately. Two renewal 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.

How to troubleshoot license errors

If you encounter an error during license integration, follow these troubleshooting steps:

Verify that the license authorization is correctly configured in the ApsaraVideo VOD console or the 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 basic information about the application and the license bound to it is displayed.
4. Verify that the following information is correct:
  - 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 is correct and consistent with the license information in the console.
- For web applications, check the license field configuration during player initialization.
  - domain: The domain of the page where your player is hosted. This must be the domain you specified when you applied for the license, or one of its subdomains.
  - key: The value of the license key. This 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.

License file and key updates

license file: We recommend updating the license file. After a renewal, the expiration date in the license file is updated. Integrating the updated license file can improve the authentication success rate. In most cases, using an older license file in a published app does not affect its functionality.
license key: The license key remains unchanged. Each license key is uniquely mapped to a user ID (UID).

How to modify an application ID

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

Important

Modifying application identifiers (such as Package Name) will cause authentication to fail for applications using the old identifiers. You must re-download and replace the license certificate file. Proceed with caution.

Log on to the ApsaraVideo VOD 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 to prevent online service failures. When you use the ApsaraVideo MediaBox SDK, your app requires a license file and key for configuration. If you modify authorization settings, such as the package signature, SDK authentication may fail for published app versions, which can cause features to stop working. Common scenarios include:

If you change the package signature of an Android application from A to B, app versions that use signature A will stop working. In this case, we recommend creating a new application with the same package name but with signature B for new app versions.
If you unbind the package signature, authentication may fail for older SDK versions. We do not recommend unbinding the signature if your app uses any of 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

Modify authorized modules, editions, or features

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