疫情期間过蹂,很多線下活動轉為線上舉行十绑,實時音視頻的需求劇增,在視頻會議酷勺,在線教育本橙,電商購物等眾多場景成了“生活新常態(tài)”。
本文將教你如何通過即構ZEGO sdk在Android端搭建視頻通話能力脆诉。即構SDK提供100+種行業(yè)解決方案甚亭,每月贈送10000分鐘免費時長,提供免費接入體驗击胜。
接下來我們看看完整的實現(xiàn)流程亏狰。
1 準備環(huán)境
在開始集成 ZEGO Express SDK 前,請確保開發(fā)環(huán)境滿足以下要求:
Android Studio 2020.3.1 或以上版本偶摔。
Android SDK 25骚揍、Android SDK Build-Tools 25.0.2、Android SDK Platform-Tools 25.x.x 或以上版本。
Android 4.4 或以上版本信不,且支持音視頻的 Android 設備嘲叔。
Android 設備已經(jīng)連接到 Internet。
2 項目準備
2.1 創(chuàng)建項目
進入即構官網(wǎng)抽活,在【ZEGO控制臺】創(chuàng)建項目硫戈,并申請有效的 AppID,這一步很關鍵下硕,appid為應用的唯一標識丁逝,如身份證號,是應用的身份證明梭姓,用于明確你的項目及組織身份霜幼。zego提供的服務也是基于APP ID;
App ID的獲取方式很簡單誉尖,只需3~5分鐘罪既,在即構官網(wǎng)-我的項目-創(chuàng)建即可。創(chuàng)建的項目信息可用于SDK的集成和配置铡恕;
2.2 Token 鑒權
登錄房間時必須 使用 Token 鑒權 琢感,可參考 Token 鑒權教程。
為了方便開發(fā)階段的調(diào)試探熔,開發(fā)者可直接在 ZEGO 控制臺獲取臨時 Token(有效期為 24 小時) 來使用驹针,詳情請參考 控制臺(新版) - 項目管理中的 “項目信息”。
3 集成
3.1 項目設置
開始集成前诀艰,可參考如下步驟設置你的項目柬甥;
如已有項目,本步驟可忽略其垄。
如需新建項目暗甥,可按照以下步驟創(chuàng)建你的新項目:
1.打開 Android Studio,選擇 “File > New > New Project” 菜單捉捅。
[圖片上傳失敗...(image-d091db-1648827994681)]
2.填寫項目名及項目存儲路徑。
[圖片上傳失敗...(image-6a630d-1648827994681)]
3.其它按照默認設置虽风,單擊 “Next”棒口,最后單擊 “Finish” 完成新工程創(chuàng)建。
3.2 導入 SDK
目前支持的平臺架構包括:armeabi-v7a辜膝、arm64-v8a无牵、x86、x86_64厂抖。
在實現(xiàn)基本的實時音視頻功能之前茎毁,需確保獲取的sdk為最新版本,保證音視頻功能體驗為最優(yōu);
- 使用 JitPack 自動集成 SDK
進入項目根目錄七蜘,打開 “build.gradle” 文件谭溉,在 “allprojects” 中加入如下代碼。
...
allprojects {
repositories {
maven { url 'https://www.jitpack.io' }
google()
jcenter()
}
}
進入 “app” 目錄橡卤,打開 “build.gradle” 文件扮念,在 “dependencies” 中添加 implementation 'com.github.zegolibrary:express-video:2.+',這樣能獲取到最新的版本碧库。
...
dependencies {
...
implementation 'com.github.zegolibrary:express-video:2.+'
}
4 設置權限
以上步驟集成已完成柜与,為保證SDK運行效果更佳,需要在應用中設置所需的權限嵌灰,步驟如下:
進入 “app/src/main” 目錄喂窟,打開 “AndroidManifest.xml” 文件,添加權限嚣镜。
<!-- SDK 必須使用的權限 -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<!-- App 需要使用的部分權限 -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-feature
android:glEsVersion="0x00020000"
android:required="true" />
<uses-feature android:name="android.hardware.camera" />
<uses-feature android:name="android.hardware.camera.autofocus" />
因為 Android 6.0 在一些比較重要的權限上要求必須申請動態(tài)權限豆同,不能只通過 “AndroidMainfest.xml” 文件申請靜態(tài)權限。因此還需要參考執(zhí)行如下代碼秕脓,其中 “requestPermissions” 是 “Activity” 的方法柒瓣。
String[] permissionNeeded = {
"android.permission.CAMERA",
"android.permission.RECORD_AUDIO"};
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
if (ContextCompat.checkSelfPermission(this, "android.permission.CAMERA") != PackageManager.PERMISSION_GRANTED ||
ContextCompat.checkSelfPermission(this, "android.permission.RECORD_AUDIO") != PackageManager.PERMISSION_GRANTED) {
requestPermissions(permissionNeeded, 101);
}
}
具體的權限說明如下:
[圖片上傳失敗...(image-f4001e-1648827994681)]
其中非必要權限 “android.permission.READ_PHONE_STATE” 僅用于實現(xiàn) SDK 的打斷事件處理,因此只需在 AndroidMainfest.xml 文件中進行聲明即可吠架,不需要動態(tài)申請(業(yè)務方有需求則另外處理)芙贫。
5 防止混淆代碼
在 “proguard-rules.pro” 文件中,為 SDK 添加 -keep 類的配置傍药,防止混淆 SDK 公共類名稱磺平。
-keep class **.zego.**{*;}
至此,我們已經(jīng)完成了ZEGO Android SDK的自動集成拐辽,已實現(xiàn)了音視頻的基礎能力拣挪。接下來可在此基礎上實現(xiàn)在線KTV,云健身俱诸,線上劇本殺等當下熱門玩法菠劝。
接下來的內(nèi)容,我將給大家分享音視頻的常用功能睁搭,如Token 鑒權赶诊,創(chuàng)建房間,一對一視頻通話等园骆;
6 實現(xiàn)流程
用戶通過 ZEGO Express SDK 進行視頻通話的基本流程為:
用戶 A舔痪、B 加入房間,用戶 B 預覽并將音視頻流推送到 ZEGO 云服務(推流)锌唾,用戶 A 收到用戶 B 推送音視頻流的通知之后锄码,在通知中播放用戶 B 的音視頻流(拉流)。
[圖片上傳失敗...(image-83c3b0-1648827994681)]
整個音視頻通話推拉流過程的 API 調(diào)用時序如下圖:
[圖片上傳失敗...(image-eee2c3-1648827994681)]
6.1 初始化
1. 創(chuàng)建界面
根據(jù)場景需要,為你的項目創(chuàng)建視頻通話的用戶界面滋捶。我們推薦你在項目中添加如下元素:
- 本地視頻窗口
- 遠端視頻窗口
- 結束通話按鈕
[圖片上傳失敗...(image-a58b8f-1648827994681)]
界面代碼示例:
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".Playing">
<TextureView
android:id="@+id/logView"
android:layout_width="match_parent"
android:layout_height="50dp"
android:layout_alignParentTop="true"/>
<TextureView
android:id="@+id/previewView"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:layout_below="@id/logView"
android:layout_alignParentBottom="true"
android:layout_alignParentLeft="true"/>
<TextView
android:id="@+id/roomIDTextView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text=""
android:layout_margin="10dp"
android:textColor="@color/black"
android:textSize="12sp"
android:layout_below="@+id/logView"/>
<TextView
android:id="@+id/userIDTextView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text=""
android:layout_margin="5dp"
android:textColor="@color/black"
android:textSize="12sp"
android:layout_below="@+id/roomIDTextView"/>
<TextView
android:id="@+id/publishStreamIDTextView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text=""
android:layout_margin="5dp"
android:textColor="@color/black"
android:textSize="12sp"
android:layout_below="@+id/userIDTextView"/>
<Button
android:id="@+id/stopButton"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="Stop"
android:textSize="15sp"
android:layout_alignParentBottom="true"
android:layout_marginBottom="30dp"
android:layout_centerHorizontal="true"/>
<TextureView
android:id="@+id/playView"
android:layout_width="108dp"
android:layout_height="192dp"
android:layout_below="@id/logView"
android:layout_alignParentRight="true"
android:layout_margin="10dp"/>
</RelativeLayout>
2. 創(chuàng)建引擎
調(diào)用 createEngine 接口痛悯,將申請到的 AppID 傳入?yún)?shù) “appID” ,創(chuàng)建引擎單例對象炬太。
注冊回調(diào)灸蟆,可將實現(xiàn)了 IZegoEventHandler 的對象(例如 “self”)傳入?yún)?shù) “eventHandler”。
// 創(chuàng)建引擎亲族,通用場景接入炒考,并注冊 self 為 eventHandler 回調(diào)
// 不需要注冊回調(diào)的話,eventHandler 參數(shù)可以傳 null霎迫,后續(xù)可調(diào)用 "setEventHandler:" 方法設置回調(diào)
ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = ; // 請通過官網(wǎng)注冊獲取斋枢,格式為:1234567890L
profile.scenario = ZegoScenario.GENERAL; // 通用場景接入
profile.application = getApplication();
engine = ZegoExpressEngine.createEngine(profile, null);
6.2 登錄房間
登錄房間時必須 使用 Token 鑒權,否則會登錄失敗知给。
為了方便開發(fā)階段的調(diào)試瓤帚,開發(fā)者可直接在 ZEGO 控制臺獲取臨時 Token(有效期為 24 小時)
來使用,詳情請參考 控制臺(新版) - 項目管理中的 “項目信息”涩赢。
你可以調(diào)用 loginRoom 接口登錄房間戈次。roomID 和 user 的參數(shù)由您本地生成,但是需要滿足以下條件:
- 同一個 AppID 內(nèi)筒扒,需保證 “roomID” 全局唯一怯邪。
- 同一個 AppID 內(nèi),需保證 “userID” 全局唯一花墩,建議開發(fā)者將 “userID” 與自己業(yè)務的賬號系統(tǒng)進行關聯(lián)悬秉。
// ZegoUser 的構造方法 public ZegoUser(String userID) 會將 “userName” 設為與傳的參數(shù) “userID” 一樣”ⅲ“userID” 與 “userName” 不能為 “null” 否則會導致登錄房間失敗和泌。
ZegoUser user = new ZegoUser("user1");
// 只有傳入 “isUserStatusNotify” 參數(shù)取值為 “true” 的 ZegoRoomConfig,才能收到 onRoomUserUpdate 回調(diào)祠肥。
ZegoRoomConfig roomConfig = new ZegoRoomConfig();
//token 由用戶自己的服務端生成武氓,為了更快跑通流程,也可以通過即構控制臺獲取臨時的音視頻 token
roomConfig.token = "xxxx";
roomConfig.isUserStatusNotify = true;
// 登錄房間
engine.loginRoom("room1", user, roomConfig);
登錄狀態(tài)(房間連接狀態(tài))回調(diào)
調(diào)用登錄房間接口之后仇箱,您可通過監(jiān)聽 onRoomStateUpdate 回調(diào)實時監(jiān)控自己在本房間內(nèi)的連接狀態(tài)县恕。
@Override
public void onRoomStateUpdate(String roomID, ZegoRoomState state, int errorCode, JSONObject extendedData) {
super.onRoomStateUpdate(roomID, state, errorCode, extendedData);
if(state == ZegoRoomState.CONNECTED){
//房間連接成功
} else if(state == ZegoRoomState.CONNECTING) {
//房間連接中
} else if(state == ZegoRoomState.DISCONNECTED) {
//未連接或房間連接斷開
}
}
6.3 預覽自己的畫面,并推送到 ZEGO 音視頻云
1. 預覽自己的畫面
如果希望看到本端的畫面工碾,可調(diào)用 startPreview 接口設置預覽視圖,并啟動本地預覽百姓。
// 設置本地預覽視圖并啟動預覽渊额,視圖模式采用 SDK 默認的模式,等比縮放填充整個 View
ZegoCanvas previewCanvas = new ZegoCanvas(previewView);
engine.startPreview(previewCanvas);
2. 將自己的音視頻流推送到 ZEGO 音視頻云
在用戶調(diào)用 loginRoom 接口后,可以直接調(diào)用 startPublishingStream 接口旬迹,傳入 “streamID”火惊,將自己的音視頻流推送到 ZEGO 音視頻云。您可通過監(jiān)聽 onPublisherStateUpdate 回調(diào)知曉推流是否成功奔垦。
“streamID” 由您本地生成屹耐,但是需要保證:
同一個 AppID 下,“streamID” 全局唯一椿猎。如果同一個 AppID 下惶岭,不同用戶各推了一條 “streamID” 相同的流,后推流的用戶推流失敗犯眠。
此處示例在調(diào)用 loginRoom 接口后立即進行推流按灶。在實現(xiàn)具體業(yè)務時,您可選擇其他時機進行推流筐咧,只要保證先調(diào)用 loginRoom 即可鸯旁。
// 用戶調(diào)用 loginRoom 之后再調(diào)用此接口進行推流
// 在同一個 AppID 下,開發(fā)者需要保證“streamID” 全局唯一量蕊,如果不同用戶各推了一條 “streamID” 相同的流铺罢,后推流的用戶會推流失敗。
engine.startPublishingStream("stream1");
6.4 拉取其他用戶的音視頻
進行視頻通話時残炮,我們需要拉取到其他用戶的音視頻韭赘。
在同一房間內(nèi)的其他用戶將音視頻流推送到 ZEGO 音視頻云時,我們會在 onRoomStreamUpdate 回調(diào)中收到音視頻流新增的通知吉殃,并可以通過 ZegoStream 獲取到某條流的 “streamID”辞居。
我們可以在該回調(diào)中,調(diào)用 startPlayingStream蛋勺,傳入 “streamID” 拉取拉取播放該用戶的音視頻瓦灶。您可通過監(jiān)聽 onPlayerStateUpdate 回調(diào)知曉是否成功拉取音視頻。
// 房間內(nèi)其他用戶推流/停止推流時抱完,我們會在這里收到相應流增減的通知
public void onRoomStreamUpdate(String roomID, ZegoUpdateType updateType, ArrayList<ZegoStream> streamList, JSONObject extendedData) {
super.onRoomStreamUpdate(roomID, updateType, streamList, extendedData);
//當 updateType 為 ZegoUpdateType.ADD 時贼陶,代表有音視頻流新增,此時我們可以調(diào)用 startPlayingStream 接口拉取播放該音視頻流
if (updateType == ZegoUpdateType.ADD) {
// 開始拉流巧娱,設置遠端拉流渲染視圖碉怔,視圖模式采用 SDK 默認的模式,等比縮放填充整個 View
// 如下 playView 為 UI 界面上 View.這里為了使示例代碼更加簡潔禁添,我們只拉取新增的音視頻流列表中第的第一條流撮胧,在實際的業(yè)務中,建議開發(fā)者循環(huán)遍歷 streamList 老翘,拉取每一條音視頻流
ZegoStream stream = streamList.get(0);
playStreamID = stream.streamID;
ZegoCanvas playCanvas = new ZegoCanvas(playView);
engine.startPlayingStream(playStreamID, playCanvas);
}
}
7 運行效果
音視頻的基礎功能已完成芹啥,接下來我們運行下效果锻离,1步快速檢驗成果。
step1.與好友一起安裝編譯好的App墓怀,在手機上可以看到對方并進行通話互動汽纠。
完成以上,說明你成功啦傀履!
Enjoy與好友的歡樂時光!
獲取更多文檔虱朵、Demo、技術幫助
- 獲取 SDK 開發(fā)文檔钓账、demo碴犬,可訪問 即構文檔中心.
- 獲取更多商務活動熱門產(chǎn)品,可提交 信息聯(lián)系商務.
注冊即構ZEGO開發(fā)者帳號官扣,快速開始翅敌。