ApsaraVideo VOD:Quick integration

Environment requirements

SDK download

• To download Flutter SDK, visit Flutter SDK.

• To download the latest version of ApsaraVideo Player SDK for Flutter, see SDK overview and download.

• To download the plugins for ApsaraVideo Player SDK for Flutter (provided in patches on ApsaraVideo Player SDK for Flutter), visit ApsaraVideo Player SDK for Flutter plug-ins.

Project description

The native layer of ApsaraVideo Player SDK for Flutter is developed based on ApsaraVideo Player SDK for Android and ApsaraVideo Player SDK for iOS. The source code is included in the dependencies of the demo. You can modify the source code based on your business requirements.

The following table describes the folders in the directory.

ApsaraVideo Player SDK for Flutter supports both the live streaming and player features. If you do not need the live streaming feature, you can change the kernel of ApsaraVideo Player SDK for Flutter from multi-module (live streaming + player) to single-module (player). To do so, perform the following steps:

Limits

ApsaraVideo Player SDK for Android cannot run on simulators. After you integrate ApsaraVideo Player SDK for Android, you must run the SDK on an Android device.

Integration

1. Start VS Code.

2. Choose View > Command Palette….

3. Enter flutter and select Flutter: New Project.

4. Enter a project name such as myapp and press Enter.

5. Specify the location for storing the project and click OK.

   Wait for the project to be created. When the main.dart file appears, the project is created.

6. Integrate ApsaraVideo Player SDK for Flutter into your project.

   You can integrate ApsaraVideo Player SDK for Flutter by adding flutter_aliplayer as a dependency to the pubspec.yaml file of the project.

   dependencies:
     flutter_aliplayer: ^version
   # version specifies the version number of ApsaraVideo Player SDK for Flutter, such as 5.4.0. Replace version with the actual version number.

7. Optional: If your business scenario requires RTS, add the following dependencies. For more information about RTS, see Overview.

   You can use one of the following methods to add the dependencies:

   Note

   • The version numbers used in the following examples are for reference only.

   • The version of RTS SDK that you integrate must match the version of ApsaraVideo Player SDK. For more information about the versions of ApsaraVideo Player SDK that RTS SDK supports, see Release notes.

   • For more information about the versions of ApsaraVideo Player SDK for Android and iOS, see Release notes for ApsaraVideo Player SDK for Android and Release notes for ApsaraVideo Player SDK for iOS. For more information about the versions of RTS SDKs, see Release notes.

   • Method 1: Implement integration on the native layer of your Android or iOS device

     Android: Include the dependencies in the build.gradle file. Sample code:

     dependencies{
         implementation 'com.aliyun.sdk.android:AlivcArtc:$version'
         implementation 'com.aliyun.rts.android:RtsSDK:$version'
     }
     # version specifies the version number of ApsaraVideo Player SDK for Android or RTS SDK for Android. Examples: 'com.aliyun.sdk.android:AlivcArtc:5.4.9.1' and 'com.aliyun.rts.android:RtsSDK:2.5.0'.

     iOS: Include the dependencies in the Podfile file. Sample code:

     target 'Runner' do
       flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
     
       pod 'AliPlayerSDK_iOS_ARTC', '$version'  #$version specifies the version number of ApsaraVideo Player SDK for iOS. Example: 5.4.9.1.
       pod 'RtsSDK', '$version'  #$version specifies the version number of RTS SDK for iOS. Example: 2.5.0.
     
     end

   • Method 2: Use the Flutter plug-in (update stopped)

     You can obtain the versions of RTS SDK and ApsaraVideo Player SDK from the CHANGELOG.md file of the flutter_aliplayer project.

      flutter_aliplayer_artc: ^version
      flutter_aliplayer_rts: ^version
     # version specifies the version number. Examples: flutter_aliplayer_artc: ^5.2.3 and flutter_aliplayer_rts: ^1.5.0. Replace version with the actual version number.

FAQ

Can I debug apps on the Xcode simulator after I integrate ApsaraVideo Player SDK on iOS?