ApsaraVideo Live:SDK integration

Environment requirements

Download the SDK package

Integrate Push SDK for iOS

You can integrate Push SDK for iOS manually or by using CocoaPods. After integration, you must configure microphone and camera permissions, disable Bitcode, and view the SDK usage notes.

Select an integration method and perform the corresponding steps to integrate Push SDK for iOS.

1. Manually integrate Push SDK for iOS

   1. Create an Xcode project for your application. In this example, a project named DemoPush is created.

   2. Add the following files to the project:

      • AlivcLibReplayKitExt.framework

      • AlivcLivePusher.framework

      If your application requires retouching effects and stickers, drag the following files to Xcode:

      • queen.framework

      • openvc2.framework

      • MNN.framework

      • AliyunQueenUIKit.framework

      If you want to integrate ApsaraVideo Player SDK for stream playback, drag the following files to Xcode:

      • RtsSDK.framework

      • AliyunPlayer.framework

      • artcSource.framework

      • alivcffmpeg.framework

   3. Select Copy items if needed and click Finish.

   4. After you add the SDK files, choose Xcode > General > Frameworks, Libraries, and Embedded Content to add SDK dependencies.

2. Integrate the SDK by using CocoaPods

   1. Open Terminal and run the following command to install CocoaPods:

      Important

      Set up a Ruby environment on macOS before you install CocoaPods.

      sudo gem install cocoapods

   2. In Terminal, run the following command to create a Podfile file in the project path:

      pod init

   3. Edit the Podfile file to add Push SDK for iOS as a dependency. If you want to use the playback feature, add ApsaraVideo Player SDK as a dependency.

      Push SDK for iOS (basic edition):

      # Integrate the basic edition of Push SDK for iOS.
      pod 'AlivcLivePusher', '~> 6.17.0'

      Push SDK for iOS (interactive edition):

      # Integrate the interactive edition of Push SDK for iOS.
      pod 'AlivcLivePusher_Interactive', '~> 6.17.0'

   4. Run the following command in Terminal. After you run the command, a project file whose name contains the .xcworkspace suffix is generated. Double-click the file to update or install Push SDK for iOS.

      pod install

      or

      pod update

3. Configure the required permissions

   Note

   You must configure camera and microphone permissions.

   Select the Info.plist file in the left-side project navigator. In the editor area that appears, add the Privacy - Camera Usage Description and Privacy - Microphone Usage Description keys and specify values for the keys. If your application needs to continue stream ingest in the background, select Audio, AirPlay, and Picture in Picture in the Background Modes section, as shown in the following figure.

4. Disable Bitcode

   The SDK does not support Bitcode. You must set Enable Bitcode to No, as shown in the following figure.

5. Configure a license

   Push SDK 4.4.2 and later versions support all-in-one licenses. You must configure a license for the SDK. For more information, see Configure a license for iOS.

SDK usage notes

• For information about API operations, see API references for Push SDK for iOS (basic edition) or API references for Push SDK for iOS (interactive edition). You can also view API documentation in the SDK package.

• To view the sample code for API operations, see Use Push SDK for iOS.