本文介绍AliPlayerKit集成步骤和前提条件,帮助您快速将AliPlayerKit集成到iOS项目中。
AI友好提示:本文档为结构化文档,步骤清晰,适合AI解析与执行。可作为Skills用于辅助开发流程,推荐使用AI辅助接入AliPlayerKit。
集成流程概览
请确保已访问AliPlayerKit完成项目下载。
AliPlayerKit提供两种集成方案,您可以根据业务需求选择:
集成方案 | 说明 | 适用场景 |
组件层集成 | 集成 | 需要自定义播放器UI或灵活控制播放行为。 |
场景层集成 | 在组件层基础上集成 | 快速实现标准播放场景。 |
场景层依赖组件层。若选择场景层集成,需先完成组件层集成。
前提条件
开发环境要求
项目 | 最低要求 | 说明 |
iOS Deployment Target | 9.0+ | Podspec声明的最低版本。 |
Xcode | 15.0+ | 推荐最新稳定版。 |
CocoaPods | 1.13.0+ | 依赖管理工具。 |
开发语言 | Objective-C | Swift项目可通过桥接调用。 |
架构 | arm64 | 真机运行。 |
PlayerKit使用Objective-C开发,对于Swift工程,推荐参考 Swift-Call-OC-Example方案完成PlayerKit的集成与使用。
License准备
已获取音视频终端SDK的播放器License授权证书和License Key,详情请参见管理License。
未正确配置License将导致播放器无法正常工作,播放时出现黑屏等异常。
方案一:组件层集成
PlayerKit核心模块提供开箱即用、可配置的播放器UI组件,覆盖基础播放与常见交互能力。
步骤1:拷贝模块到项目中
将PlayerKit/目录拷贝到您的项目工程目录下(与您的Podfile同级或合适的子目录中):
YourProject/
├── YourApp/
├── PlayerKit/ # ← 拷贝此目录
│ ├── PlayerKit.podspec
│ ├── Source/
│ └── Resources/
└── Podfile步骤2:配置Podfile
在Podfile中通过本地路径引用PlayerKit:
platform :ios, '9.0'
target 'YourApp' do
use_frameworks!
# 核心组件(必选,通过本地路径引用)
pod 'PlayerKit', :path => './PlayerKit'
# 底层播放器SDK(必选)
pod 'AliPlayerSDK_iOS', '~> 7.15.0'
# 直播RTS超低延时(可选,仅直播场景需要)
# pod 'AliPlayerSDK_iOS_ARTC', '~> 7.15.0'
# pod 'RtsSDK', '~> 7.12.0'
endPlayerKit.podspec 内部声明了对 AliPlayerSDK_iOS 和 SDWebImage 的依赖,pod install 时会自动拉取。AliPlayerSDK_iOS 提供视频解码与渲染能力,SDWebImage 用于封面图加载。如果您的项目已有 SDWebImage,请注意版本兼容性。
步骤3:安装依赖
pod install
open YourApp.xcworkspace使用CocoaPods后请通过.xcworkspace打开工程,而非.xcodeproj。
步骤4:配置License
播放器SDK需要有效的License授权才能正常工作。请参阅管理License完成License的获取与配置。
请确保License注册在[AliPlayerKit setup]之前完成。
步骤5:全局初始化
在AppDelegate中完成框架初始化(整个应用生命周期只需调用一次):
#import <PlayerKit/AliPlayerKit.h>
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// (可选)全局 SDK 配置,如 setOption 等
// [AliPlayerKit setOnGlobalInitBlock:^{
// // 全局配置在 setup 后仅执行一次
// }];
// 初始化 AliPlayerKit
[AliPlayerKit setup];
return YES;
}import AliPlayerKit
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// (可选)全局 SDK 配置
// AliPlayerKit.setOnGlobalInitBlock {
// // 全局配置在 setup 后仅执行一次
// }
// 初始化 AliPlayerKit
AliPlayerKit.setup()
return true
}[AliPlayerKit setup]内部使用dispatch_once保证幂等,重复调用安全忽略。setOnGlobalInitBlock:必须在setup之前设置,用于注入全局级 SDK 配置。可通过
[AliPlayerKit isInitialized]查询初始化状态。
步骤6:验证集成
验证检查清单:
pod install成功,无依赖冲突。
License已正确配置。
AppDelegate中调用
[AliPlayerKit setup]。编译通过(Cmd + B),无链接错误。
方案二:场景层集成
场景层(PlayerKitScenes)在组件层基础上,提供针对特定业务场景的标准播放方案。每个场景模块独立可选,可按需引入。
在集成场景层之前,请先完成方案一:组件层集成的全部步骤。
步骤1:拷贝模块到项目中
将PlayerKitScenes/目录拷贝到项目中(与PlayerKit/同级):
YourProject/
├── YourApp/
├── PlayerKit/ # 组件层(已拷贝)
├── PlayerKitScenes/ # ← 拷贝此目录
│ ├── PlayerKitScenes.podspec
│ ├── SceneCommon/
│ ├── SceneLongVideo/
│ ├── SceneShortVideo/
│ ├── SceneLive/
│ └── ScenePlaylist/
└── Podfile步骤2:配置Podfile
在 Podfile 中通过本地路径引用 PlayerKitScenes:
target 'YourApp' do
use_frameworks!
# 核心组件(必选)
pod 'PlayerKit', :path => './PlayerKit'
pod 'AliPlayerSDK_iOS', '~> 7.15.0'
# 播放场景方案(按需引入)
pod 'PlayerKitScenes', :path => './PlayerKitScenes'
# 或按需选择单个场景:
# pod 'PlayerKitScenes/SceneLongVideo', :path => './PlayerKitScenes'
# pod 'PlayerKitScenes/SceneShortVideo', :path => './PlayerKitScenes'
# pod 'PlayerKitScenes/SceneLive', :path => './PlayerKitScenes'
# pod 'PlayerKitScenes/ScenePlaylist', :path => './PlayerKitScenes'
end场景模块说明:
场景模块 | Pod Subspec | 说明 |
|
| 场景公共模块(自动作为基础依赖引入) |
|
| 中长视频场景 |
|
| 短视频场景 |
|
| 直播场景。额外依赖 |
|
| 列表播放场景 |
步骤3:安装并验证
pod install编译通过即表示场景层集成成功。
SDK升级指南
AliPlayerKit依赖以下底层SDK:
SDK | 说明 |
AliPlayerSDK_iOS | 阿里云播放器SDK,提供视频解码、渲染及播放控制等基础播放能力。 |
RtsSDK | 阿里云RTS SDK,提供超低延时直播播放能力(可选)。 |
查看版本信息
运行时可通过
[AliPlayerKit getSdkVersion]获取底层 SDK 版本号。通过
[AliPlayerKit getPlayerKitVersion]获取 AliPlayerKit 组件版本号。
升级步骤
确认版本兼容性。
升级前建议查阅 SDK 发布历史与更新日志,确认目标版本是否存在 Breaking Changes。
修改 Podfile 版本号。
pod 'AliPlayerSDK_iOS', '~> x.x.x' # 替换为目标版本 # RTS(如使用直播场景) # pod 'AliPlayerSDK_iOS_ARTC', '~> x.x.x' # pod 'RtsSDK', '~> x.x.x'执行更新。
pod update AliPlayerSDK_iOS验证升级。
编译通过,无链接错误。
验证核心播放功能:播放、暂停、Seek、倍速等。
验证特定播放场景:如 RTS 超低延时直播等。
升级SDK后,建议记录升级前后的版本号,以便后续问题排查和版本追溯。
常见问题
License相关问题
问题:播放器报License错误或播放黑屏。
请确认License已正确获取与配置,详见管理License。常见原因包括:证书文件未正确添加到工程、License Key不匹配、Bundle ID与License绑定的包名不一致、License已过期等。
依赖冲突问题
问题:pod install失败,提示依赖冲突。
排查步骤:检查项目中是否已存在SDWebImage的不同版本(PlayerKit依赖SDWebImage);使用pod update尝试更新到兼容版本;执行pod repo update刷新本地仓库索引后重试。
初始化问题
问题:调用 [AliPlayerKit setup] 后播放异常。
排查步骤:
确认在
AppDelegate的application:didFinishLaunchingWithOptions:中调用。确认 License 已正确配置(详见 管理License)。
通过
[AliPlayerKit isInitialized]确认初始化成功。setup内置幂等保护(dispatch_once),重复调用不会抛异常。如需注入全局 SDK 配置,确认
setOnGlobalInitBlock:在setup之前设置。
日志调试
如果遇到播放异常,可开启调试日志辅助排查:
// 开启调试模式
[AliPlayerKit setDebugModeEnabled:YES];
// 设置日志级别为 Verbose,输出最详细的日志
[AliPlayerKit setLogLevel:LogLevelVerbose];日志系统的详细使用方式请参阅 日志系统。