ApsaraVideo Live:SDK integration

Integrated Environment

Download the SDK package

Integrate the Push SDK

After you integrate the Push SDK manually or using a pod, you must also request permissions and disable Bitcode.

If you choose to integrate the Push SDK manually, follow the manual integration steps. If you choose to integrate the Push SDK using a pod, follow the pod integration steps.

1. Manual integration:

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

   2. Drag the following files into your Xcode project:

      • AlivcLibReplayKitExt.framework

      • AlivcLivePusher.framework

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

      • queen.framework

      • openvc2.framework

      • MNN.framework

      • AliyunQueenUIKit.framework

      To depend on a version of the ApsaraVideo Player SDK, also drag the following files:

      • RtsSDK.framework

      • AliyunPlayer.framework

      • artcSource.framework

      • alivcffmpeg.framework

   3. Select Copy items if needed, and then click Finish.

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

2. Pod integration:

   1. In a terminal window, enter the following command to install CocoaPods.

      Important

      Before you install CocoaPods, make sure that a Ruby environment is installed on your Mac.

      sudo gem install cocoapods

   2. Go to the project path and enter the following command in a terminal window to create a Podfile file.

      pod init

   3. Edit the Podfile file 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 represents the version number of the Push SDK. Replace this placeholder with the latest version number from the SDK Downloads page, such as 7.4.0.

      • The Push SDK cannot be integrated with the Player SDK (AliyunPlayer). To integrate both the Push SDK and the Player SDK, use the All-in-One Media SDK. For more information, see Scenarios and Integration of the All-in-One Media SDK.

   4. Enter the following command in a terminal window. After the pod command is executed, a project file with the .xcworkspace extension is generated. This file contains the integrated SDK. Double-click the file to update and install the SDK.

      pod install

      or

      pod update

3. Request permissions.

   Note

   You must add permissions for camera and microphone access.

   In the Info.plist file, add the Privacy - Camera Usage Description and Privacy - Microphone Usage Description permissions for the camera and microphone.If the app needs to continue stream ingest in the background, enable the background audio capture 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 the Bitcode option in the project. To do this, set Enable Bitcode to NO, as shown in the figure.

5. Configure the license.

   For instructions, see Integrate a license.

Usage notes

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

• For API sample 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 Queen dependency libraries are missing during manual integration, see the Queen_SDK_iOS document to add the required libraries.