Android實現實時視頻聊天功能｜源碼 Demo 分享

来源:https://www.cnblogs.com/zegodeveloper/archive/2022/08/09/16567055.html
-Advertisement-
Play Games

疫情期間，很多線下活動轉為線上舉行，實時音視頻的需求劇增，在視頻會議，線上教育，電商購物等眾多場景成了“生活新常態”。 本文將教你如何通過即構ZEGO 音視頻 SDK 在Android端搭建實時視頻通話能力。即構音視頻SDK提供100+種行業解決方案，RTC 每月贈送10000分鐘免費時長，提供免費 ...



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

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

接下來我們看看完整的Android實時視頻聊天實現流程。


1 Android端音視頻SDK準備環境

在開始集成 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 ZEGO 音視頻 SDK 集成

3.1 項目設置

開始集成前，可參考如下步驟設置你的項目；

如已有項目，本步驟可忽略。

如需新建項目，可按照以下步驟創建你的新項目：

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

在這裡插入圖片描述

2.填寫項目名及項目存儲路徑。

在這裡插入圖片描述

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


3.2 導入 ZEGO 音視頻 SDK

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

在實現基本的實時音視頻功能之前，需確保獲取的ZEGO 音視頻 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 設置許可權

以上步驟集成已完成，為保證音視頻 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.**{*;}

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

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


6 Android端視頻通話實現流程

用戶通過 ZEGO Express SDK 進行視頻通話的基本流程為：

用戶 A、B 加入房間，用戶 B 預覽並將音視頻流推送到 ZEGO 雲服務（推流），用戶 A 收到用戶 B 推送音視頻流的通知之後，在通知中播放用戶 B 的音視頻流（拉流）。

在這裡插入圖片描述


整個音視頻通話推拉流過程的 API 調用時序如下圖：


在這裡插入圖片描述


6.1 音視頻 SDK 初始化

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與好友的歡樂時光!


獲取音視頻SDK開發文檔、Demo、技術幫助

- 獲取 音視頻SDK 開發文檔、Demo，可訪問 即構文檔中心.

-  獲取更多音視頻SDK優惠活動熱門產品，可提交 信息聯繫商務.

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

音視頻場景解決方案分享，更多詳情可搜索官網（https://zegoguanwang.datasink.sensorsdata.cn/t/pB）
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Java學習路線之redis
    1、redis 大數據時代三V：海量Volume、多樣Variety、實時Velocity 大數據時代三高：高併發、高可用（無限套娃+彼此監控）、高性能 - Redis（Remote Dictionary Server )，即遠程字典服務，是一個開源的使用ANSI C語言編寫、支持網路、可基於記憶體亦 ...
  • 從SQL Server到MySQL，攜程核心系統無感遷移實戰
    攜程酒店訂單系統的存儲設計從1999年收錄第一單以來，已經完成了從單一SQLServer資料庫到多IDC容災、完成分庫分表等多個階段，在見證了大量業務奇跡的同時，也開始逐漸暴露出老驥伏櫪的心有餘而力不足之態。基於更高穩定性與高效成本控制而設計的訂單存儲系統，已經是攜程在疫情後恢復業務的必然訴求。 目... ...
  • 袋鼠雲申杭：數雁EasyDigit，致力成為金融行業數據洞察平臺供應商的“領頭雁”
    7月28日，以“數智進化，現在即未來”為主題的袋鼠雲2022產品發佈會於線上正式開幕。發佈會上，袋鼠雲宣佈將集團進行全新升級：從“數字化基礎設施供應商”，升級為“全鏈路數字化技術與服務提供商”，併發布了全新的四大產品體系：數據智能分析與洞察平臺“數雁EasyDigit”、低代碼數字孿生平臺EasyV ...
  • MySQL中實現中文轉拼音
    前言： 今天有個業務需求，需要將用戶的密碼統一進行設置，現在只有用戶的昵稱(nickname)， 用戶的username跟password欄位為空。遂就用到了中文轉拼音~ 1、先將nickname轉拼音並賦值給username欄位 2、使用username欄位配合加密函數，對該用戶的密碼進行賦值 - ...
  • 自研能力再獲認可，騰訊雲資料庫入選 Forrester Translytical 報告
    好消息！國際權威行業研究與咨詢機構Forrester發佈全球Translytical數據平臺廠商選型報告《The Translytical Data Platforms Landscape, Q3 2022》，騰訊雲資料庫成功入選。 Forrester是全球最具影響力的獨立第三方研究咨詢公司之一，提 ...
  • MySQL查詢性能優化七種武器之索引潛水
    有讀者可能會一臉懵逼？ 啥是索引潛水？ 你給起的名字的嗎？有沒有索引蛙泳？ 這個名字還真不是我起的，今天要講的知識點就叫索引潛水（Index dive）。 先要從一件怪事說起： ...
  • SQL Server查詢優化
    定義： 刪除數據表就是將資料庫中已經存在的表從資料庫中刪除。註意，在刪除表的同時，表的定義和表中所有的數據均會被刪除。因此，在進行刪除操作前，最好對錶中的數據做一個備份，以免造成無法輓回的後果。本節將詳細講解資料庫表的刪除方法。 1 刪除一個或多個沒有被其他表關聯的數據表 如果一個數據表沒有和其它表 ...
  • 微信小程式day04基礎加強
    一.自定義組件 1.1 組件的創建與引用 首先創建組件 然後我們組件的引用分為局部和全局引用 局部引用就是在當前頁面能使用，在當前頁面的json文件裡面配置 全局引用同樣的道理，==註意跟page等是同級的== 組件與頁面的不同： 雖然都有相應的四個文件 1.2 組件樣式 首先，預設情況下 ==組件 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類