本文介紹Android端播放器SDK的環境要求、集成方式及使用參考。
環境要求
類別 | 說明 |
系統版本 | 支持Android 4.3及以上版本。 |
手機芯片 | 架構要求:
|
開發工具 | 推薦使用Android Studio,本文操作步驟基于Android Studio開發。下載地址:Android Studio。 |
前提條件
本地集成SDK時,需要先下載Android端播放器SDK包(包含了播放器SDK及Demo源碼),從V5.4.6.0版本開始Android端播放器SDK提供了支持AndroidX和不支持AndroidX的Demo,請根據您的項目按需選擇下載,推薦下載使用最新版本。下載地址請參見播放器SDK。
解壓后的目錄結構如下:
文件名 | 作用 |
demo | 播放器的Demo源碼。 |
JavaDoc | 播放器API文檔。 |
sdk | 播放器SDK的aar庫。sdk的目錄結構參見下表。 |
X.X.XReleaseNote | 版本說明。 |
sdk文件目錄結構如下:
文件名 | 說明 |
AliyunPlayer-x.x.x-full.aar | 完整的aar包,包含了FFmpeg動態庫的包。 |
AliyunPlayer-x.x.x-part.aar | aar包,不包含FFmpeg的動態庫的包。 |
AlivcArtp-x.x.x.aar | 支持artp協議,非必須。 |
AlivcArtc-x.x.x.aar | 支持artc協議,非必須。 |
如果不集成短視頻SDK,直接依賴AliyunPlayer-x.xx.x-full.aar包即可。
如果集成播放器的同時,也集成短視頻SDK,那么播放器的SDK依賴AliyunPlayer-x.x.x-part包,同時使用共通的FFmpeg版本,即需要額外依賴com.aliyun.video.android:AlivcFFmpeg:x.x.x這個包。
如果集成時使用了錯誤的SDK包,會導致FFmpeg沖突。
使用限制
Android端播放器SDK不支持模擬器,集成完成后需要真機運行。
SDK集成(本地集成)
以下步驟以Android Studio Flamingo | 2022.2.1版本的Android Studio開發工具為例,其余開發工具的操作步驟類似。
拷貝需要的aar包到工程的libs目錄下(如果沒有libs文件夾,手動創建libs文件夾即可)。
修改Project下的build.gradle文件,在allprojects的repositories節點中增加flatDir的設置,示例如下:
flatDir { dirs 'libs' }
修改App的build.gradle文件,dependencies節點中增加對aar的引用和Conan的引用,示例如下:
dependencies { implementation fileTree(dir: 'libs', include: ['*.aar']) //阿里云播放器5.3.0 版本以前需要引入AlivcConan庫,5.3.0及其以后的版本不需要引入。 implementation 'com.alivc.conan:AlivcConan:x.x.x' }
混淆配置。
在App的Proguard-rules.pro文件中添加以下混淆配置,示例如下:
-keep class com.alivc.**{*;} -keep class com.aliyun.**{*;} -keep class com.cicada.**{*;} -dontwarn com.alivc.** -dontwarn com.aliyun.** -dontwarn com.cicada.**
SDK集成(Gradle集成)
請確保網絡正常,并且可以正常訪問阿里云Maven倉庫。如果由于網絡故障,無法從Maven倉庫下載到播放器SDK包,則建議通過本地集成方式來集成SDK,詳細請參見SDK集成(本地集成)。
在Project的build.gradle中增加阿里云的Maven地址依賴。示例如下:
maven { url "https://maven.aliyun.com/repository/releases" }
操作后的截圖如下:
修改App的build.gradle文件,dependencies節點中增加依賴。示例如下:
說明請確保引入的播放器SDK版本號填寫正確,否則將報錯并引入失敗。播放器SDK的版本可以從功能發布記錄查看。
implementation 'com.aliyun.sdk.android:AliyunPlayer:x.x.x-full' //阿里云播放器5.3.0 版本以前需要引入AlivcConan庫,5.3.0及其以后的版本不需要引入 implementation 'com.alivc.conan:AlivcConan:x.x.x'
操作后的截圖如下:
配置License
V5.4.7.1及之后版本的Android端播放器SDK必須按以下操作配置License后,方可使用。
播放器SDK現免費提供,License有效期為1年,1年后若無特殊約定我們將為您免費自動續期。
License配置完成后,查看日志若無License相關報錯,則表示License配置成功。
獲取License證書文件,獲取方式請參見管理License。
說明配置的License文件和LicenseKey和申請時提交的應用信息(PackageName和Signature)有嚴格的對應關系,請確保License文件和LicenseKey和申請時的信息保持一致,否則會出現鑒權失敗的情況。
將獲取到的證書文件拷貝到Android Studio項目中,建議放到assets目錄下,也可以放到沙箱或者其他路徑。
在AndroidManifest.xml文件中添加如下meta-data。
key為
com.aliyun.alivc_license.licensekey
(全小寫),value為LicenseKey的值。key為
com.aliyun.alivc_license.licensefile
(全小寫),value為步驟二中證書文件的放置路徑,請根據實際情況填寫。
<meta-data android:name="com.aliyun.alivc_license.licensekey" android:value="xxxxxxxxx" /> <meta-data android:name="com.aliyun.alivc_license.licensefile" android:value="assets/license.crt" />