ApsaraVideo VOD:Quick integration

Environment requirements

Prerequisites

• A license for ApsaraVideo Player SDK is registered and the license file AliVideoCert-********.crt is obtained. For more information, see Obtain a license.

• The ApsaraVideo Player SDK for iOS package is downloaded before you integrate the SDK by using on-premises files. The SDK package contains ApsaraVideo Player SDK for iOS and the source code of a demo. We recommend that you use the latest version of ApsaraVideo Player SDK for iOS. For information about how to download the latest version of the SDK, see SDK overview and download.

cd $(SDK_PATH)   // The path of the SDK file.
sh createMoreKindsOfArch.sh

Usage notes

• When you package your application files, dSYM files are used to symbolicate crash reports.

• AlivcFFmpeg and AliyunPlayer are required when you use ApsaraVideo Player SDK for iOS. You can find header files in AliyunPlayer.framework.

• If you want to integrate both the short video SDK and ApsaraVideo Player SDK, make sure to import the correct version of AlivcFFmpeg. Otherwise, you will not be able to use the features provided by the SDKs. For more information, see AlivcFFmpeg dependencies.

• Specific features of ApsaraVideo Player SDK for iOS may not run as expected on a simulator. After you integrate ApsaraVideo Player SDK for iOS, we recommend that you use an iPhone for debugging.

• A simulator is included in the installation package of ApsaraVideo Player SDK for iOS. You can use the simulator to debug code. If you want to publish the application, do not use SDKs that contain simulators. Otherwise, the application may fail to be submitted to App Store.

Integrate the SDK by using CocoaPods (Recommended)

1. Use CocoaPods statements to integrate ApsaraVideo Player SDK for iOS. Sample code:

   Note

   If you want to integrate both the short video SDK and ApsaraVideo Player SDK, replace AliPlayerSDK_iOS in the following code with AliPlayerPartSDK_iOS. AliPlayerPartSDK_iOS does not contain the FFmpeg framework. This prevents conflicts with the FFmpeg framework of the short video SDK for iOS.

   ruby
     platform:ios, '8.0'
     target 'yourProject' do
         # ApsaraVideo Player SDK. We recommend that you use the latest version. For more information, visit the official website: https://help.aliyun.com/zh/vod/developer-reference/sdk-overview-and-download?spm=a2c4g.11186623.0.0.63cde7ea3nNYgA#section-v53-2oj-xfd.
         pod 'AliPlayerSDK_iOS'
      end

2. Optional: If you want the player to support the ARTC protocol or play RTS streams, add the pod dependencies as required. Sample code:

   Note

   Make sure that the version number of the SDK is correct. Otherwise, an error will be reported and the dependencies will fail to be added.

   ruby
     platform:ios, '8.0'
     target 'yourProject' do
        # ApsaraVideo Player SDK. We recommend that you use the latest version. For more information, visit the official website: https://help.aliyun.com/zh/vod/developer-reference/sdk-overview-and-download?spm=a2c4g.11186623.0.0.63cde7ea3nNYgA#section-v53-2oj-xfd.
         pod 'AliPlayerSDK_iOS'
        # Real-time Streaming (RTS) SDK. We recommend that you use the latest version. For more information, visit the official website: https://help.aliyun.com/zh/live/user-guide/pull-streams-over-rts-on-ios?spm=a2c4g.11186623.help-menu-29949.d_2_11_0_6_1.5edb659e1iPsz6.
         pod 'AliPlayerSDK_iOS_ARTC', '6.19.0'
         pod 'RtsSDK', '2.6.3'
        # This version number is for reference only. For more information about the latest version of the RTS SDK, see Download SDKs.  
      end

Integrate the SDK by adding local files

1. In the Xcode project, click the General tab.

2. Add the frameworks of ApsaraVideo Player SDK for iOS to the Frameworks, Libraries, and Embedded Content section. Select Embed & Sign in the Embed column for these frameworks.

   

3. Click the Build Settings tab.

4. In the Search Paths section, set the Framework Search Paths parameter to the path in which the framework files are stored.

Bind a license to an iOS application

1. Configure the license.

   1. In the Xcode project, copy the certificate file AliVideoCert-********.crt to the project, preferably to the AppSupportFiles directory. You can also place it in the sandbox or other paths. Ensure it's included in the Target Membership.

      

   2. Open Info.plist and update AlivcLicenseKey, AlivcLicenseFile (China site environment), AlivcLicenseKey_SEA, AlivcLicenseFile_SEA (international site environment), or AlivcLicenseKey_OVERSEA, AlivcLicenseFile_OVERSEA (new international site environment) with the license key and file path obtained when you apply for a license.

      Important

      • For Alibaba Cloud international site (alibabacloud.com) users who need to use ApsaraVideo Player SDK:

        • For SDK version 6.14.0 or later, configure the international site environment or new international site environment license.

        • For SDK version 7.0.0 or later, it's recommended to configure the new international site environment license for enhanced service support.

        • If not using ApsaraVideo Player SDK, only the China site environment license is necessary.

      • You can bind two licenses at once (one international site environment license and one China site environment license). After each app launch, set the player's runtime environment by configuring the service environment of ApsaraVideo Player SDK. The environment cannot be changed during player operation.

      // License configuration for the Chinese mainland and Hong Kong (China), Macao (China), and Taiwan (China) (default configuration)
      <key>AlivcLicenseFile</key>
      <string>XXX</string>
      <key>AlivcLicenseKey</key>
      <string>foIVziMaUHaRqgDyhf6b6eb8fcf014af39535d0720a32****</string>
      
      
      // License configuration for Global (excluding the Chinese mainland and Hong Kong (China), Macao (China), and Taiwan (China)), manually add _SEA at the end
      <key>AlivcLicenseFile_SEA</key>
      <string>XXX</string>
      <key>AlivcLicenseKey_SEA</key>
      <string>f6b6efoIVziMaUHaRqgDyhb8fcf014af39535d0a32072****</string>
      
      // License configuration for the new Global (excluding the Chinese mainland and Hong Kong (China), Macao (China), and Taiwan (China)), manually add _OVERSEA at the end
      <key>AlivcLicenseFile_OVERSEA</key>
      <string>XXX</string>
      <key>AlivcLicenseKey_OVERSEA</key>
      <string>f6b6efoIVziMaUHaRqgDyhb8fcf014af39535d0a32072****</string>

2. Configure the service environment of ApsaraVideo Player SDK (necessary for the international site or new international site environment).

   ApsaraVideo Player SDK V6.14.0 and later supports selecting a service environment. The ApsaraVideo Player SDK V6.14.0 and later is set to the China site environment by default. If you need to use the international site environment (currently, users of the Alibaba Cloud international site (alibabacloud.com) can only use the international site environment), you must update the configuration of ApsaraVideo Player SDK to the international site or new international site environment after each app startup. Otherwise, the license of ApsaraVideo Player SDK will fail to be authenticated. You can skip this step in other versions and scenarios where SDKs are used.

   // When you use the Global (excluding the Chinese mainland and Hong Kong (China), Macao (China), and Taiwan (China)) environment, make sure that you call the following operation to update the default configuration to the international site environment before you call any player API to ensure that all subsequent services run in the international site environment
   // Update the service environment to the international environment by calling the following operation. You cannot alter the environment when the player is running.
   AlivcBase.EnvironmentManager.globalEnvironment = ENV_SEA;
   // Update the service environment to the new international environment by calling the following operation. You cannot alter the environment when the player is running.
   AlivcBase.EnvironmentManager.globalEnvironment = ENV_GLOBAL_OVERSEA;

FAQ

What do I do if an error message indicating that an AlivcFFmpeg or AlivcConan conflict exists is returned when I reference a third-party SDK in my project?

What do I do if a sandBox error occurs?

For more information about the issues that may occur when you use ApsaraVideo Player SDK and corresponding solutions, see FAQ about players.

References

Basic features

Advanced features