:Integrate the SDK for iOS

Environment requirements

SDK description

The audio and video terminal SDK V1.2.0 and later provide different SDK packages based on business scenarios. You can select an SDK package based on your business requirements. An SDK package is easy to use and smaller in size. The following table describes the SDK packages.

(Recommended) Integrate the SDK online

1. After you select an SDK package, add the SDK dependencies to the Podfile file.

   # Select one of the following SDK combinations based on your business requirements.
   
    #1. Push SDK (RTS and RTC included), the short video SDK, and ApsaraVideo Player SDK
    pod 'AliVCSDK_Standard', '6.0.0'
    #2. Push SDK (RTS and RTC included), the short video SDK, Queen SDK, and ApsaraVideo Player SDK
    pod 'AliVCSDK_Premium', '6.0.0'
    #3. Push SDK and ApsaraVideo Player SDK
    pod 'AliVCSDK_BasicLive', '6.0.0'
    #4. Push SDK, ApsaraVideo Player SDK, and Queen SDK
    pod 'AliVCSDK_StandardLive', '6.0.0'
    #5. Short video SDK and ApsaraVideo Player SDK
    pod 'AliVCSDK_UGC', '6.0.0'
    #6. Short video SDK, Queen SDK, and ApsaraVideo Player SDK
    pod 'AliVCSDK_UGCPro', '6.0.0'
    #7. Push SDK (RTS and RTC included) and ApsaraVideo Player SDK
    pod 'AliVCSDK_InteractiveLive', '6.0.0'
    #8. Push SDK (RTS and RTC included), Queen SDK, and ApsaraVideo Player SDK
    pod 'AliVCSDK_PremiumLive', '6.0.0'

2. Run the following command:

   pod install

Integrate the SDK offline

To perform offline integration, you need to download two libraries of the specified versions and a resource bundle. The following table describes the frameworks and resource bundle required for offline integration.

1. Add dynamic libraries.
   1. Click the General tab. Find the Frameworks, Libraries, and Embedded Content section.
   2. Click the Plus icon, and then click Add Other… to import the AliVCSDK_xxx.framework and alivcffmpeg.framework dependencies. The name of the AliVCSDK_xxx.framework dependency is based on the SDK package that you use. If the alivcffmpeg.framework dependency is not required, you do not need to import this dependency.
   3. After the libraries are imported, select Embed & Sign.
2. Add other dependencies.
   1. Click the General tab. Find the Frameworks, Libraries, and Embedded Content section.
   2. Click the Plus icon to add the following dependencies: MobileCoreServices.framework, SystemConfiguration.framework, CoreTelephony.framework, CoreMedia.framework, VideoToolbox.framework, AVFoundation.framework, and libresolv.tbd.
3. (Optional) Import the resource bundle.
   Import the AliyunVideoSDKPro.bundle resource bundle to your project.

Configure permissions

After the SDK package is integrated, open the project and perform the following steps to modify configurations:

1. Choose Build Setting > Linking > Other Linker Flags and add -ObjC.
2. Choose Build Setting > Build Options and set the Enable Bitcode parameter to NO.
3. Open the info.plist file of the project and grant the following permissions:

   Privacy - Camera Usage Description
   Privacy - Microphone Usage Description
   Privacy - Photo Library Usage Description

Configure a license

If you access an SDK for the first time, you must apply for a license and obtain the corresponding license key and license file. For more information, see Usage notes on licenses.

After you obtain the license file, import it to the project and add two keys to the Info.plist file. The following table describes the keys and their values.

API references

For more information about methods of the audio and video terminal SDK, see Overview.

FAQ

For FAQ about SDK integration, see FAQ.