音視頻終端SDK License通過與應用標識一一綁定,以實現對該應用調用SDK進行授權。獲取SDK License后,需要在對應的直播推流SDK、短視頻SDK、播放器SDK、美顏特效SDK中接入License以完成SDK的授權流程。通過閱讀本文,您可以了解如何在Web、Android、iOS和HarmonyOS端接入License。
前提條件
已申請License,并獲取License文件和License Key。具體操作,請參見申請License。
鑒權流程
如上圖所示,音視頻終端SDK的License鑒權流程依賴LicenseKey與License文件,配置要求如下:
項目 | 是否必須 | 說明 | |||||
LicenseKey | 是 | 用于請求更新License文件。 SDK初始化時會檢查更新證書文件,在程序運行時也會每隔15分鐘檢查更新證書文件。 | |||||
License文件 | 否,建議配置 | 用于當未能從服務端成功請求到證書時鑒權使用的證書文件,例如由于網絡問題導致無法下載證書等極端場景。 證書文件內容包含了開通的權限以及有效期。因此,為了在弱網絡環境下提高鑒權通過率,建議在權限發生變化時主動更新內置證書文件。 說明
|
如有特殊原因不希望內置License文件時,不填寫LicenseFile相關配置即可(具體參考下文)。
不配置內置證書文件意味著鑒權依據全部來源于服務端,這樣可能會因為網絡不穩定而導致鑒權不穩定;也可能導致用戶首次使用應用需要等待證書下載完成才能通過鑒權(耗時取決于用戶當時的網絡情況)。
播放器SDK服務環境
為了滿足全球化合規要求,阿里云播放器SDK(6.14.0及以上版本)為您提供了多樣化的環境選擇,確保服務的本地化和合規性。根據您所選擇的服務環境,播放器SDK的License鑒權以及播放器SDK所涉及的播放質量服務數據將由相應的服務中心提供支持。您可以根據自己的需求選擇以下服務環境。
請注意,目前阿里云中國站用戶支持使用全球環境和國際站環境(新加坡節點),您所使用的播放器SDK(6.14.0及以上)默認設置為全球環境配置。
環境 | 說明 | 使用建議 |
全球環境(默認) | 通過阿里云中國上海節點提供服務,確保全球用戶的接入和授權需求得到滿足。 | 適用于中國內地業務。 |
國際站環境 | 專為國際站用戶設計,通過新加坡節點提供服務,以滿足特定區域的合規性和性能要求。 | 適用于中國香港、中國澳門、中國臺灣及海外業務。 |
Web端接入License
從控制臺獲取License Key。
在初始化播放器時傳入license字段,包含注冊的域名和License Key:
var player = new Aliplayer({ license: { domain: "example.com", // 申請 License 時填寫的域名 key: "example-key" // 申請成功后,在控制臺可以看到 License Key } });
初始化播放器后,如果沒有相關錯誤提示,則表示License配置成功。
說明請確保播放器所在頁面的域名和申請License時填寫的域名保持一致,或者是填寫域名的子域名,否則 License校驗將會不通過(localhost 不會校驗)。
Android端接入License
(推薦)將證書文件拷貝到Android Studio項目中的assets目錄下。
說明您也可以將證書文件復制到設備中的其他位置,但要保證第2步中
com.aliyun.alivc_license.licensefile
對應的value的值和License的路徑保持一致。在AndroidManifest.xml文件中添加<meta-data>節點。
重要若配置License后校驗失敗,您可以檢查<meta-data>節點是否處于<application>元素下面,且<meta-data>的name是否正確。若未能解決問題,您可以參考License相關常見問題進行排查。
<meta-data android:name="com.aliyun.alivc_license.licensekey" android:value="foIVziMaUHaRqgDyhf6b6eb8fcf014af39535d0720a32****"/> <!-- TODO:請設置您的 LicenseKey值--> <meta-data android:name="com.aliyun.alivc_license.licensefile" android:value="assets/cert/release.crt"/> <!-- TODO:請設置您的 LicenseFile文件路徑-->
iOS端接入License
將License文件復制到Xcode項目中指定目錄,并在Target Membership中選中當前項目。
打開Info.plist,分別修改AlivcLicenseKey和AlivcLicenseFile為申請License時獲取的License Key和License文件路徑。
HarmonyOS端接入License
將獲取到的License證書文件拷貝到DevEco Studio項目中,建議放到rawfile目錄下。
在module.json5文件中添加如下字段。
key為
com.aliyun.alivc_license.licensekey
(全小寫),value為LicenseKey的值。key為
com.aliyun.alivc_license.licensefile
(全小寫),value為步驟1中證書文件的放置路徑,請根據實際情況填寫。"metadata": [ { "name": "com.aliyun.alivc_license.licensekey", "value": "********" }, { "name": "com.aliyun.alivc_license.licensefile", "value": "license.crt" }, ]