The short video SDK requires licenses for authorization. This topic explains how to acquire and utilize a short video SDK license.
License service update
The all-in-one license service, introduced for the short video SDK V3.29.0 and later, provides access authorization for applications using Push SDK, short video SDK, ApsaraVideo Player SDK, and Queen SDK. A license is tied to an application, allowing you to bind a license to one Android application and one iOS application. The integration method for the short video SDK has been updated due to this new license service. The system adjusts deployment parallelism based on the following rules:
Short Video SDK Version | Integration Method |
V.3.29.0 and later | If you are a new user and want to use the short video SDK V3.29.0 or later, integrate the latest version of the short video SDK by following the instructions in the documentation.
|
Version earlier than V.3.29.0 | If you have integrated the short video SDK of a version earlier than V3.29.0, you can continue using the SDK within the validity period of your license. To update the SDK to V3.29.0 or later, you must call a specific method to register the SDK by using the obtained license key and license file when you integrate the SDK.
|
License authorization
Step 1: create an application
-
Go to the ApsaraVideo VOD console My Authorization, select the Application Management tab, and click Create Application.
-
Edit the application information. Applications are divided into Web and mobile platforms based on the Platform Type.
-
Web: Enter the Application Name and the corresponding Web Domain Name in sequence to complete the application creation.
Notes on filling in the Web domain name:
-
Standard filling example: aliyun.com.
ImportantTo cover multiple subdomains simultaneously, such as pc.aliyun.com and mobile.aliyun.com, you only need to fill in the primary domain "aliyun.com".
-
Incorrect filling examples (do not fill in the following forms):
-
Including protocol header: http://aliyun.com or https://aliyun.com.
-
Including path or subpage: aliyun.com/index or aliyun.com/login.
-
Using wildcard domain name: *.aliyun.com or .aliyun.com.
-
-
-
Mobile: Enter the Application Name in sequence, and fill in the corresponding Android Package Name, iOS BundleID, and HarmonyOS BundleID to complete the application creation.
Bind Android Application Signature
Note-
If the Platform is selected as Android and the Bind Signature option is checked, this item is required.
-
Binding the signature enhances security and prevents the license from being misused by applications with the same package name.
-
The new version of the SDK supports signature-free binding, including MediaBox audio and video SDK v1.7.0 and later, player SDK v5.5.2 and later, stream ingest SDK v4.4.9 and later, and short video SDK v3.36.0 and later.
To obtain the MD5 hash of the Android application signature, use one of the following methods:
-
Obtain through command: Execute
keytool -v -list -keystore your.keystore
to view the MD5 hash of the corresponding signature. -
Obtain through Android Studio: Click the Gradle tab in the right sidebar, find the corresponding app's Tasks > android > signingReport to obtain. The MD5 hash needs to be converted to lowercase and the colons removed.
-
-
Step 2: purchase license
If you have already purchased a license, proceed directly to Step 3: Bind License to complete the license binding.
-
Return to the My Authorization page, select the Order Instance tab, and click License Purchase.
-
Enter the audio and video terminal SDK purchase page, select the SDK and corresponding function modules according to your business needs (SDK benefits cannot be purchased in combination), and proceed with the purchase after confirming that everything is correct.
ImportantAs shown in the figure, SDK benefits only support individual purchases. For example, you can purchase the standard edition of the player SDK separately.
-
After successful payment, return to the Order Instance tab, where you can see the newly purchased order instance.
Step 3: bind license
-
Return to the My Authorization page, select the License Management tab, and click License Binding.
-
Enter the License Binding page, select the application and corresponding SDK license order you need to bind, confirm that the information is correct, and click Bind.
NoteEach license order can bind to only one application, covering either the Web or mobile platform.
-
After successful binding, return to the License Management tab, where you can see the application name and corresponding authorization information that have been successfully bound.
Step 4: obtain authorization information
-
In the License Management tab, find the target application.
-
After confirming that the authorization information is correct, click Download Certificate to download the license certificate file to your local device and save the license key for later integration into the application. For configuration steps, see Integrate License.
Renew a license
License expiration
The license for the short video SDK is valid for a specified period. The criteria for determining license expiration vary by SDK version. The system adjusts job parallelism based on the following rules:
-
For the short video SDK versions earlier than V3.29.0:
-
The return value of the interface is
ALIVC_FRAMEWORK_LICENSE_FAILED(-10011001)
. -
One of the following messages is displayed in the log:
-
No network is available for 30 days. The license is disabled. Renew the license or contact sales personnel for authorization.
-
The license is disabled. Renew the license or contact sales personnel for authorization.
-
The license is invalid because the package name, bundle ID, and signature are not registered on the official website of the short video SDK. Your seven-day free trial period has ended.
-
-
-
For the short video SDK V3.29.0 and later:
-
The return value of the interface is
ALIVC_FRAMEWORK_LICENSE_FAILED(-10011001)
. -
One of the following messages is displayed in the log:
-
The license is expired. Renew the license or contact sales personnel for authorization.
-
The license is not initialized. For more information, see Initialize SDK (Android) or Initialize SDK (iOS) to integrate the SDK.
-
The license is invalid because the package name, bundle ID, and signature are not registered on the official website of the short video SDK. Contact sales personnel for authorization.
-
If you use value-added services, the following message is displayed: XXX is expired. Renew the license or contact sales personnel for authorization. XXX refers to the value-added service in use.
-
If you use value-added services, the following message is displayed: XXX is invalid. Obtain the license before using the value-added service. XXX refers to the value-added service in use.
-
-
License renewal
Method 1: Renew On The License Management Page
-
Log on to the ApsaraVideo VOD console.
-
In the left-side navigation pane, select
. -
Select the License Management tab, find the instance ID bound to the corresponding application, and click the Renew button in the Operation column.
Important-
If the instance ID is empty, you need to renew through Method 2: Purchase a New License and Bind the Application or submit an Alibaba Cloud technical ticket.
-
Renewal applies to the license order. If your license order contains multiple SDK benefits, renewal will apply to all SDKs as a whole. Configuration changes are not supported. If you have any questions, please submit an Alibaba Cloud technical ticket for consultation.
-
-
Enter the renewal management interface and click the Renew button in the Operation column.
-
Enter the audio and video terminal SDK renewal page. After confirming that your current configuration and subscription duration are correct, click Buy Now to complete the renewal (it is recommended that you check Auto-renewal Upon Expiry to avoid expiration).
Method 2: Purchase A New License And Bind The Application
If you have purchased an SDK license and the corresponding order instance ID is empty, you need to place an order on the MediaBox audio and video SDK purchase page before the license authorization expires. After purchase, proceed with Step 3: Bind License to avoid business anomalies caused by the inability to call the SDK online.