Android实现实时视频聊天功能|源码 Demo 分享


疫情期间,很多线下活动转为线上举行,实时音视频的需求剧增,在视频会议,在线教育,电商购物等众多场景成了“生活新常态”。

本文将教你如何通过即构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” 菜单。

Android实现实时视频聊天功能|源码 Demo 分享_第1张图片

2.填写项目名及项目存储路径。

Android实现实时视频聊天功能|源码 Demo 分享_第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” 文件,添加权限。
































因为 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实现实时视频聊天功能|源码 Demo 分享_第3张图片


其中非必要权限 “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 的音视频流(拉流)。

Android实现实时视频聊天功能|源码 Demo 分享_第4张图片


整个音视频通话推拉流过程的 API 调用时序如下图:


Android实现实时视频聊天功能|源码 Demo 分享_第5张图片


6.1 音视频 SDK 初始化

1. 创建音视频聊天界面

根据场景需要,为你的项目创建视频通话的用户界面。我们推荐你在项目中添加如下元素:

 - 本地视频窗口 

 - 远端视频窗口 

 - 结束通话按钮


Android实现实时视频聊天功能|源码 Demo 分享_第6张图片


界面代码示例:







    

    

    

    

    

    


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 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开发者帐号,快速开始。

你可能感兴趣的:(聊天音视频androidsdk)