Initialize the SDK

Prerequisites

Import header files

Import the SDK header files before you use the short video SDK. The header files contain the API declarations required by the SDK.

• Version 7.0.0

  Starting from version 7.0.0, the import method is unified.

  #import <AliVCSDK_ShortVideo/AliVCSDK_ShortVideo.h>

• Before version 7.0.0

  • Professional Edition & Standard Edition

    #import <AliyunVideoSDKPro/AliyunVideoSDKPro.h>

  • Basic Edition

    #import <AliyunVideoSDKBasic/AliyunVideoSDKBasic.h>

Register the SDK

Starting from version 3.29.0, the short video SDK uses an upgraded license service. Register the SDK after your app starts to enable the SDK features. The following code shows how to register the SDK:

// For versions 3.30.0 and later:
NSError *error = [AliyunVideoSDKInfo registerSDK]; // If the returned error is nil, the registration is successful.
// A registration failure is usually caused by an integration error. Add an Assert statement to display the error and suggested fix during integration and debugging.
NSAssert2(error == nil, @"Failed to register the SDK! %@; %@", error.localizedDescription, error.localizedRecoverySuggestion);

// For version 3.29.0:
// Rename the obtained LicenseFile to license.crt. Add the file to your app project. Then, use the following method to get the path of the LicenseFile.
NSString *licenseFilePath = [NSBundle.mainBundle pathForResource:@"license" ofType:@"crt"];
// Use the obtained LicenseKey and LicenseFilePath to register the SDK.
[AliyunVideoSDKInfo registerSDKWithLicenseKey:LicenseKey licenseFile:licenseFilePath];

AliyunVideoLicense *license = AliyunVideoLicenseManager.CurrentLicense;

// For versions 3.30.0 and later
AliyunVideoLicenseManager.EventDelegate = self; // For more information, see the AliyunVideoLicenseEventDelegate protocol description.

AliyunVideoLicenseResultCode code = [AliyunVideoLicenseManager check];       

[AliyunVideoLicenseManager Refresh:^(AliyunVideoLicenseRefreshCode code){
    // Update result: code
}];

Set the resource bundle import path

If you integrate the short video SDK by using CocoaPods with minimum dependencies, you may need to import the AliyunVideoSDKPro.bundle resource bundle. To reduce your app's package size, configure the app to download the resource bundle at runtime. After the download completes, set the bundle path to make it available to the SDK.

1. Upload the resource bundle to your cloud storage, such as Object Storage Service (OSS).

2. When the app starts, check for the resource bundle. If the bundle does not exist, download it to your local device.

3. After the resource bundle is downloaded or if it already exists locally, set the import path for the resource bundle in the short video SDK as follows:

   [AliyunVideoSDKInfo setSDKBundlePath:@"The local storage path of the resource bundle"];

Log output

// The log levels are defined as follows:
typedef NS_ENUM(NSInteger, AlivcLogLevel)
{
    AlivcLogClose = 1,
    AlivcLogVerbose,
    AlivcLogDebug,
    AlivcLogInfo,
    AlivcLogWarn,
    AlivcLogError,
    AlivcLogFatal
};
// Set the log output level
[AliyunVideoSDKInfo setLogLevel:AlivcLogDebug];
                

Version information

[AliyunVideoSDKInfo printSDKInfo];

NSString *version = [AliyunVideoSDKInfo version]; // Version number
NSString *module = [AliyunVideoSDKInfo module];   // Version type
int moduleCode =[AliyunVideoSDKInfo versionCode]; // Version type code
NSString *buildId =[AliyunVideoSDKInfo videoSDKBuildId]; // Version packaging ID
NSLog(@"\n==============\nVERSION: %@\nBUILD_ID: %@\nMODULE: %@\nMODULE_CODE: %d\n==============", version, buildId, module, moduleCode);