本文将介绍基于 ZEGO 超低延迟直播 SDK,通过 Java 开发如何快速实现直播功能。ZEGO 超低延迟直播(Low-Latency Live Streaming,L3)为高质量体验而生,可打造超低延迟、超强同步、抗极端弱网、超低卡顿、超清画质、首帧秒开的极致直播体验。
java直播开发准备环境
在开始集成 ZEGO 超低延迟直播 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。
集成条件:
- 在项目中集成 SDK,实现基本的实时音视频功能,详情请参考 快速开始 – 集成。
- 已在 ZEGO 控制台 创建项目,并申请有效的 AppID,详情请参考 控制台 – 项目管理 中的“项目信息”。
java直播实现流程
通过 ZEGO 直播 SDK 进行直播的基本流程为:
用户 A、B 加入房间,用户 B 预览并将音视频流推送到 ZEGO 云服务(推流),用户 A 收到用户 B 推送音视频流的通知之后,在通知中播放用户 B 的音视频流(拉流)。
开通服务
超低延迟直播功能及CDN 直播功能不是默认开启的,使用前请在ZEGO 控制台自助开通(开通步骤请参考 项目管理 – 服务配置 ),或联系 ZEGO 技术支持开通。
初始化
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.DEFAULT; // 通用场景接入
profile.application = getApplication();
engine = ZegoExpressEngine.createEngine(profile, null);
登录房间
- 生成 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, (int error, JSONObject extendedData)->{
// (可选回调) 登录房间结果,如果仅关注登录结果,关注此回调即可
});
登录状态(房间连接状态)回调
调用登录房间接口之后,您可通过监听 onRoomStateChanged 回调实时监控自己在本房间内的连接状态。
@Override
public void onRoomStateChanged(String roomID, ZegoRoomStateChangedReason reason, int errorCode, JSONObject extendedData) {
if(reason == ZegoRoomStateChangedReason.LOGINING)
{
// 登录中
}
else if(reason == ZegoRoomStateChangedReason.LOGINED)
{
// 登录成功
//只有当房间状态是登录成功或重连成功时,推流(startPublishingStream)、拉流(startPlayingStream)才能正常收发音视频
//将自己的音视频流推送到 ZEGO 音视频云
}
else if(reason == ZegoRoomStateChangedReason.LOGIN_FAILED)
{
// 登录失败
}
else if(reason == ZegoRoomStateChangedReason.RECONNECTING)
{
// 重连中
}
else if(reason == ZegoRoomStateChangedReason.RECONNECTED)
{
// 重连成功
}
else if(reason == ZegoRoomStateChangedReason.RECONNECT_FAILED)
{
// 重连失败
}
else if(reason == ZegoRoomStateChangedReason.KICK_OUT)
{
// 被踢出房间
}
else if(reason == ZegoRoomStateChangedReason.LOGOUT)
{
// 登出成功
}
else if(reason == ZegoRoomStateChangedReason.LOGOUT_FAILED)
{
// 登出失败
}
}
主播预览自己的画面,并推送到 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");
拉取主播的音视频
进行直播时,我们需要主播的音视频。
在同一房间内的其他用户将音视频流推送到 ZEGO 音视频云时,我们会在 onRoomStreamUpdate 回调中收到音视频流新增的通知,并可以通过 ZegoStream 获取到某条流的 “streamID”。
我们可以在该回调中,调用 startPlayingStream 接口,传入 “streamID” 拉取播放该用户的音视频。您可通过监听 onPlayerStateUpdate 回调知晓是否成功拉取音视频。
以超低延迟直播拉流方式为例:
调用 startPlayingStream 接口,并将 resourceMode 参数设置为 “ZegoStreamResourceMode.ONLY_L3”,表示超低延迟直播拉流。
// 房间内其他用户推流/停止推流时,我们会在这里收到相应流增减的通知
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);
ZegoPlayerConfig playerConfig = new ZegoPlayerConfig();
playerConfig.resourceMode = ZegoStreamResourceMode.ONLY_L3;
engine.startPlayingStream(playStreamID, playCanvas, playerConfig);
}
}
停止直播
停止推送/拉取音视频流
1. 停止推流,停止预览
调用 stopPublishingStream 接口停止向远端用户发送本端的音视频流。
// 停止推流
engine.stopPublishingStream();
如果启用了本地预览,调用 stopPreview 接口停止预览。
// 停止本地预览
engine.stopPreview();
2. 停止拉流
调用 stopPlayingStream 接口停止拉取远端推送的音视频流。
// 停止拉流
engine.stopPlayingStream("stream1");
退出房间
调用 logoutRoom 接口退出房间。
// 退出房间
engine.logoutRoom();
销毁引擎
如果用户彻底不使用音视频功能时,可调用 destroyEngine 接口销毁引擎,释放麦克风、摄像头、内存、CPU 等资源。
- 如果需要监听回调,来确保设备硬件资源释放完成,可在销毁引擎时传入 “callback”。该回调只用于发送通知,开发者不可以在回调内释放与引擎相关的资源。
- 如果不需要监听回调,可传入 “null”。
ZegoExpressEngine.destroyEngine(null);
调试直播功能
在真机中运行项目,运行成功后,可以看到本端视频画面。
为方便体验,ZEGO 提供了一个 Web 端调试示例,在该页面下,输入相同的 AppID、RoomID、Server 地址和 Token,即可加入同一房间与真机设备互通。当成功开直播时,可以听到远端的音频,看到远端的视频画面。
直播 API 调用时序
以上就是java直播开发的步骤,详细开发文档参考:https://doc-zh.zego.im/article/13395
本文为原创稿件,版权归作者所有,如需转载,请注明出处:https://www.nxrte.com/jishu/yinshipin/22725.html