ApsaraVideo Live:SDK integration

Environment requirements

Download the Push SDK

Integrate the Push SDK

After you integrate the Push SDK manually or using CocoaPods, you must also request permissions, disable Bitcode, and review the usage instructions.

This procedure provides instructions for both manual integration and CocoaPods integration. Follow the steps that apply to your chosen method.

1. Manual integration

   1. Create an SDK test project named App > DemoPush.

   2. Drag the following files into your Xcode project:

      • AlivcLibReplayKitExt.framework

      • AlivcLivePusher.framework

      To use retouching and sticker effects, you must also drag the following files:

      • queen.framework

      • openvc2.framework

      • MNN.framework

      • AliyunQueenUIKit.framework

      If your project has a dependency on the ApsaraVideo Player SDK, you must also drag the following files:

      • RtsSDK.framework

      • AliyunPlayer.framework

      • artcSource.framework

      • alivcffmpeg.framework

   3. Select Copy items if needed and click Finish.

   4. After you import the SDK, add its dependencies under Xcode > General > Frameworks, Libraries, and Embedded Content.

2. CocoaPods integration

   1. In a Terminal window, run the following command to install CocoaPods.

      Important

      Ensure that a Ruby environment is set up on your Mac before you install CocoaPods.

      sudo gem install cocoapods

   2. Navigate to your project's directory and run the following command in a Terminal window to create a Podfile.

      pod init

   3. Edit the Podfile to add the Push SDK dependency. If you need live playback, you can also add the ApsaraVideo Player SDK dependency.

      # Push SDK Basic Edition
      pod 'AlivcLivePusher', '~> x.y.z'

      Note

      • x.y.z indicates the version number of Push SDK of Android. Replace it with the actual version number, such as 7.4.0. For information about the latest version number, see SDK download.

      • You cannot integrate Push SDK and Player SDK (AliyunPlayer) at the same time. If you want to integrate both the SDKs, use ApsaraVideo MediaBox SDK instead. For more information, see Download all-in-one SDKs and Quick integration.

   4. Run the following command in a Terminal window. After the command finishes, an .xcworkspace file is generated. Double-click this file to open your project in Xcode.

      pod install

      or

      pod update

3. Request permissions

   Note

   You must request permissions for the camera and microphone.

   In the Info.plist file, add the Privacy - Camera Usage Description and Privacy - Microphone Usage Description keys to request access to the camera and microphone.If your app needs to continue stream ingest while in the background, enable background audio mode. To do this, select Audio, AirPlay, and Picture in Picture, as shown in the figure.

4. Disable Bitcode

   The SDK does not support Bitcode. You must disable this option in your project. Set Enable Bitcode to NO, as shown in the figure.

5. Configure the license

   For more information, see Integrate a license for the Push SDK.

Usage notes

• For detailed API information, see API reference for the Basic Edition.

• For sample API code, see Feature usage.

FAQ

Compilation Error

If you receive the Building for iOS, but the linked and embedded framework XXX.framework' was built for iOS + iOS Simulator compilation error, perform the following steps:

1. Click the Xcode menu.

2. Choose File > Workspace Settings to open the settings dialog box.

3. Change Build System to Legacy Build System.

Missing Queen Dependency Libraries During Compilation

If dependency libraries for Queen are missing during manual integration, refer to the Queen_SDK_iOS documentation to add the required dependency libraries.