集成准备

更新时间:
复制 MD 格式

本文档详细介绍了AliPlayerWidget的集成步骤和前提条件,帮助开发者快速上手使用该组件。

前提条件

开发环境配置

在使用 AliPlayerWidget 之前,请确保您的开发环境满足以下要求:

  • Flutter SDK

    • 版本要求不低于 2.10.0,推荐版本为 3.22.2

    • 运行 flutter doctor 检查并解决所有问题。

  • JDK 11

    说明

    JDK 11设置方法:Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle -> Gradle JDK -> 选择 11(如果没有11,请升级你的Android Studio版本)。

  • Android 开发环境

    • 安装最新版本的 Android Studio。

    • 配置 Android SDK,最低支持 API 级别为 21(Android 5.0)。

    • Gradle 版本不低于 7.0

  • iOS 开发环境

    • 安装最新版本的 Xcode。

    • 配置 CocoaPods,推荐版本为 1.13.0

    • 最低支持 iOS 版本为 10.0

权限配置

  • 权限配置

    • 在 Android 和 iOS 中启用网络权限,以便播放器能够加载在线视频资源。

  • License 配置

    • 您已获取播放器SDK的 License 授权证书和 License Key,详情请参见管理License

    • 注意:如未正确配置 License,播放器将无法正常工作,并可能抛出授权异常。

更多初始化配置,请参考 aliplayer_widget_example 示例工程。

示例 Demo

为了帮助开发者快速体验 AliPlayerWidget 的功能,我们基于 aliplayer_widget_example 示例工程构建了一个演示包。该演示包可以直接安装到设备上运行,无需额外配置开发环境。

获取方式

使用手机扫描以下二维码,即可快速下载并安装演示包:

demo-qr-code

说明

注意:二维码链接指向最新版本的演示包,请确保您的设备已开启允许安装第三方应用的权限。

SDK 集成与下载

aliplayer_widget 已经开源并提供多种下载方式。如果您需要对组件进行自定义修改,您可以使用源码依赖的方式,直接获取并修改源码。完整源码可通过以下方式获取:

下载说明

下载地址

Pub 源

说明

aliplayer_widget 推荐开发者通过包管理工具集成

GitHub

Github地址

源码包

aliplayer_widget.zip

下载包的内容包括:

  • 核心组件AliPlayerWidget 和 AliPlayerWidgetController 的完整实现。

  • 示例工程aliplayer_widget_example 提供点播、直播、列表播放等场景的代码示例,帮助开发者快速集成和使用。

  • 文档与注释:源码包含详细注释和开发指南,便于二次开发与定制。

添加依赖

aliplayer_widget 内部已依赖 flutter_aliplayer。大多数场景下,您只需添加 aliplayer_widget 即可。如果您需要直接使用底层 API(如 MediaLoader 预加载),可额外显式声明 flutter_aliplayer

SDK 版本说明

aliplayer_widget 默认使用播放器独立 SDK 版本。

场景

推荐版本

说明

仅需播放能力

普通播放器 SDK(推荐)

使用 flutter_aliplayer标准版本号即可

推流 + 播放

interactivelive 特殊版

仅建议在同时集成 flutter_livepush_plugin等推流能力,且需要与其底层 AliVCSDK 保持一致时使用

重要

非必要情况下,请不要使用 interactivelive 特殊版本。如果项目仅使用播放能力,请固定使用普通播放器 SDK 完整版本号,避免不必要地引入一体化 SDK,造成依赖复杂度增加或潜在 SDK 冲突。

可以通过以下任一方式添加依赖:

方式一:使用命令行添加(推荐)

在项目根目录下执行以下命令:

# 必须
flutter pub add aliplayer_widget

# 可选:仅当您需要直接使用 flutter_aliplayer 底层 API 时添加
flutter pub add flutter_aliplayer

方式二:手动添加

pubspec.yaml文件的dependencies 部分添加以下内容:

dependencies:
  # 必须
  aliplayer_widget: <latest_version>

  # 可选:仅当您需要直接使用 flutter_aliplayer 底层 API 时添加
  flutter_aliplayer: <latest_version>

获取依赖并构建项目

添加依赖后,需要获取依赖并构建项目:

  1. 获取依赖包(如果使用手动添加方式)。

    flutter pub get
  2. iOS平台额外步骤(仅限iOS)。

    cd ios
    pod install
    cd ..
  3. 构建项目。

    构建Android APK:

    flutter build apk

    构建iOS应用:

    flutter build ios

    构建通用应用:

    flutter build

完成以上步骤后,您就可以开始使用AliPlayerWidget进行视频播放开发了。如需了解具体的使用方法,请参考快速开始