如何基於 ZEGO SDK 實現 Android 一對一音視訊聊天應用

疫情期間，很多線下活動轉為線上舉行，實時音視訊的需求劇增，在視訊會議，線上教育，電商購物等眾多場景成了“生活新常態”。

本文將教你如何通過即構ZEGO sdk在Android端搭建視訊通話能力。即構SDK提供100+種行業解決方案，每月贈送10000分鐘免費時長，提供免費接入體驗。

接下來我們看看完整的實現流程。

1 準備環境

在開始整合 ZEGO Express SDK 前，請確保開發環境滿足以下要求：
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 裝置已經連線到 Internet。

2 專案準備

2.1 建立專案

進入即構官網，在【ZEGO控制檯】 建立專案，並申請有效的 AppID，這一步很關鍵，appid為應用的唯一標識，如身份證號，是應用的身份證明，用於明確你的專案及組織身份。zego提供的服務也是基於APP ID；

App ID的獲取方式很簡單，只需3～5分鐘，在即構官網-我的專案-建立即可。建立的專案資訊可用於SDK的整合和配置；

2.2 Token 鑑權

登入房間時必須 使用 Token 鑑權 ，可參考 Token 鑑權教程。
為了方便開發階段的除錯，開發者可直接在 ZEGO 控制檯獲取臨時 Token（有效期為 24 小時） 來使用，詳情請參考 控制檯（新版） - 專案管理中的 “專案資訊”。

3 整合

3.1 專案設定

開始整合前，可參考如下步驟設定你的專案；
如已有專案，本步驟可忽略。
如需新建專案，可按照以下步驟建立你的新專案：

1.開啟 Android Studio，選擇 “File > New > New Project” 選單。

2.填寫專案名及專案儲存路徑。

3.其它按照預設設定，單擊 “Next”，最後單擊 “Finish” 完成新工程建立。

2.2 匯入 SDK

目前支援的平臺架構包括：armeabi-v7a、arm64-v8a、x86、x86_64。

在實現基本的實時音視訊功能之前，需確保獲取的sdk為最新版本，保證音視訊功能體驗為最優；

• 使用 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 在一些比較重要的許可權上要求必須申請動態許可權，不能只通過 “AndroidMainfest.xml” 檔案申請靜態許可權。因此還需要參考執行如下程式碼，其中 “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);
    }
}

具體的許可權說明如下：

其中非必要許可權 “android.permission.READ_PHONE_STATE” 僅用於實現 SDK 的打斷事件處理，因此只需在 AndroidMainfest.xml 檔案中進行宣告即可，不需要動態申請（業務方有需求則另外處理）。

5 防止混淆程式碼

在 “proguard-rules.pro” 檔案中，為 SDK 新增 -keep 類的配置，防止混淆 SDK 公共類名稱。

-keep class **.zego.**{*;}

至此，我們已經完成了ZEGO Android SDK的自動整合，已實現了音視訊的基礎能力。接下來可在此基礎上實現線上KTV，雲健身，線上劇本殺等當下熱門玩法。

接下來的內容，我將給大家分享音視訊的常用功能，如Token 鑑權，建立房間，一對一視訊通話等；

6 實現流程

使用者通過 ZEGO Express SDK 進行視訊通話的基本流程為：
使用者 A、B 加入房間，使用者 B 預覽並將音視訊流推送到 ZEGO 雲服務（推流），使用者 A 收到使用者 B 推送音視訊流的通知之後，在通知中播放使用者 B 的音視訊流（拉流）。

整個音視訊通話推拉流過程的 API 呼叫時序如下圖：

6.1 初始化

1. 建立介面

根據場景需要，為你的專案建立視訊通話的使用者介面。我們推薦你在專案中新增如下元素：

• 本地視訊視窗
• 遠端視訊視窗
• 結束通話按鈕

介面程式碼示例：

<?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. 建立引擎

呼叫 createEngine 介面，將申請到的 AppID 傳入引數 “appID” ，建立引擎單例物件。
註冊回撥，可將實現了 IZegoEventHandler 的物件（例如 “self”）傳入引數 “eventHandler”。

// 建立引擎，通用場景接入，並註冊 self 為 eventHandler 回撥
// 不需要註冊回撥的話，eventHandler 引數可以傳 null，後續可呼叫 "setEventHandler:" 方法設定回撥
ZegoEngineProfile profile = new ZegoEngineProfile();
profile.appID = ;  // 請通過官網註冊獲取，格式為：1234567890L
profile.scenario = ZegoScenario.GENERAL;  // 通用場景接入
profile.application = getApplication();
engine = ZegoExpressEngine.createEngine(profile, null);

6.2 登入房間

• 登入房間時必須 使用 Token 鑑權，否則會登入失敗。

• 為了方便開發階段的除錯，開發者可直接在 ZEGO 控制檯獲取臨時 Token（有效期為 24 小時）
  來使用，詳情請參考 控制檯（新版） - 專案管理中的 “專案資訊”。

你可以呼叫 loginRoom 介面登入房間。roomID 和 user 的引數由您本地生成，但是需要滿足以下條件：

• 同一個 AppID 內，需保證 “roomID” 全域性唯一。
• 同一個 AppID 內，需保證 “userID” 全域性唯一，建議開發者將 “userID” 與自己業務的賬號系統進行關聯。
  
  

// ZegoUser 的構造方法 public ZegoUser(String userID) 會將 “userName” 設為與傳的引數 “userID” 一樣。“userID” 與 “userName” 不能為 “null” 否則會導致登入房間失敗。 
ZegoUser user = new ZegoUser("user1");
// 只有傳入 “isUserStatusNotify” 引數取值為 “true” 的 ZegoRoomConfig，才能收到 onRoomUserUpdate 回撥。
ZegoRoomConfig roomConfig = new ZegoRoomConfig();
//token 由使用者自己的服務端生成，為了更快跑通流程，也可以通過即構控制檯獲取臨時的音視訊 token
roomConfig.token = "xxxx";
roomConfig.isUserStatusNotify = true;
// 登入房間
engine.loginRoom("room1", user, roomConfig);

登入狀態（房間連線狀態）回撥

呼叫登入房間介面之後，您可通過監聽 onRoomStateUpdate 回撥實時監控自己在本房間內的連線狀態。

@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. 預覽自己的畫面

如果希望看到本端的畫面，可呼叫 startPreview 介面設定預覽檢視，並啟動本地預覽。

// 設定本地預覽檢視並啟動預覽，檢視模式採用 SDK 預設的模式，等比縮放填充整個 View
ZegoCanvas previewCanvas = new ZegoCanvas(previewView);
engine.startPreview(previewCanvas);

2. 將自己的音視訊流推送到 ZEGO 音視訊雲

在使用者呼叫 loginRoom 介面後，可以直接呼叫 startPublishingStream 介面，傳入 “streamID”，將自己的音視訊流推送到 ZEGO 音視訊雲。您可通過監聽 onPublisherStateUpdate 回撥知曉推流是否成功。
“streamID” 由您本地生成，但是需要保證：
同一個 AppID 下，“streamID” 全域性唯一。如果同一個 AppID 下，不同使用者各推了一條 “streamID” 相同的流，後推流的使用者推流失敗。
此處示例在呼叫 loginRoom 介面後立即進行推流。在實現具體業務時，您可選擇其他時機進行推流，只要保證先呼叫 loginRoom 即可。

// 使用者呼叫 loginRoom 之後再呼叫此介面進行推流
// 在同一個 AppID 下，開發者需要保證“streamID” 全域性唯一，如果不同使用者各推了一條 “streamID” 相同的流，後推流的使用者會推流失敗。 
engine.startPublishingStream("stream1");

6.4 拉取其他使用者的音視訊

進行視訊通話時，我們需要拉取到其他使用者的音視訊。

在同一房間內的其他使用者將音視訊流推送到 ZEGO 音視訊雲時，我們會在 onRoomStreamUpdate 回撥中收到音視訊流新增的通知，並可以通過 ZegoStream 獲取到某條流的 “streamID”。

我們可以在該回撥中，呼叫 startPlayingStream，傳入 “streamID” 拉取拉取播放該使用者的音視訊。您可通過監聽 onPlayerStateUpdate 回撥知曉是否成功拉取音視訊。

// 房間內其他使用者推流/停止推流時，我們會在這裡收到相應流增減的通知
public void onRoomStreamUpdate(String roomID, ZegoUpdateType updateType, ArrayList<ZegoStream> streamList, JSONObject extendedData) {
    super.onRoomStreamUpdate(roomID, updateType, streamList, extendedData);
    //當 updateType 為 ZegoUpdateType.ADD 時，代表有音視訊流新增，此時我們可以呼叫 startPlayingStream 介面拉取播放該音視訊流
    if (updateType == ZegoUpdateType.ADD) {
         // 開始拉流，設定遠端拉流渲染檢視，檢視模式採用 SDK 預設的模式，等比縮放填充整個             View
        // 如下 playView 為 UI 介面上 View.這裡為了使示例程式碼更加簡潔，我們只拉取新增的音視訊流列表中第的第一條流，在實際的業務中，建議開發者迴圈遍歷 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 開發文件、demo，可訪問 即構文件中心.
• 獲取更多商務活動熱門產品，可提交 資訊聯絡商務.

註冊即構ZEGO開發者帳號，快速開始。