共计 8570 个字符,预计需要花费 22 分钟才能阅读完成。
疫情期间,很多线下流动转为线上举办,实时音视频的需要剧增,在视频会议,在线教育,电商购物等泛滥场景成了“生存新常态”。
本文将教你如何通过即构 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 控制台】创立我的项目,找到左侧导航栏单击“概览”,按如下场景操作:
- 首次创立:单击“我的我的项目”栏目中的“创立第一个我的项目,收费试用”。
- 非首次创立:在“我的我的项目”栏目中,单击右上角的“创立我的项目”。
整个我的项目创立预计只需 3~5 分钟,创立过程同时也获取了 App ID,这一步很要害,可用于 SDK 的集成和配置;
实现我的项目创立后,能够在该我的项目下“查看”的相干信息,包含根本信息、配置信息和辅助工具。
2.2 Token 鉴权
登录房间时必须 应用 Token 鉴权,可参考 Token 鉴权教程。
为了不便开发阶段的调试,开发者可间接在 ZEGO 控制台获取长期 Token(有效期为 24 小时)来应用,详情请参考 控制台(新版)– 项目管理中的“我的项目信息”。
音视频长期 Token:开发者在登录房间时必须带上 Token 参数,来验证用户的合法性,为不便您体验和测试,可在控制台间接获取长期 Token 来应用。
- 单击“点击生成”。
- 在弹出的“生成长期 Token”窗口中输出“RoomId”和“UserId”后,单击“生成”即可疾速生成长期 Token,不便开发阶段进行调试。
3 集成
3.1 我的项目设置
开始集成前,可参考如下步骤设置你的我的项目;
如已有我的项目,本步骤可疏忽。
如需新建我的项目,可依照以下步骤创立你的新我的项目:
1. 关上 Android Studio,抉择“File > New > New Project”菜单。
2. 填写我的项目名及我的项目存储门路。
3. 其它依照默认设置,单击“Next”,最初单击“Finish”实现新工程创立。
3.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 开发者帐号,疾速开始;