一、前提条件

在实现 Java 直播前，请确保：

• 已在项目中集成 ZEGO Express SDK，详情请参考 快速开始 - 集成。

• 已在 ZEGO 控制台 创建项目，并申请有效的 AppID 和 AppSign，详情请参考 控制台 - 项目管理。

二、实现流程

本文所介绍的 Java 直播实现流程，是基于 ZEGO Express SDK 来实现的，以下是 API 调用时序图：

1、创建引擎

1）创建界面（可选）

在开始之前，推荐开发者添加以下界面元素，方便实现基本的实时音视频功能。

• 本地预览窗口

• 远端视频窗口

• 结束按钮

2）创建引擎

定义 SDK 引擎对象，调用 createEngine 接口，将申请到的 AppID 和 AppSign 传入参数 “appID” 和 “appSign”，创建引擎单例对象。

如果需要注册回调代理，可将实现了 IZegoEventHandler 的对象传入参数 “eventHandler”。如果不需要注册回调代理，可将 “null” 传入参数 “eventHandler”，创建引擎后仍需要注册回调时可通过调用 setEventHandler 接口设置回调代理。

Plain Text/** 定义 SDK 引擎对象 */ZegoExpressEngine engine;/** 填写 appID 和 appSign */long appID = ; /** 请通过官网注册获取，格式为 123456789L */String appSign = ; /** 64 个字符，请通过官网注册获取，格式为"0123456789012345678901234567890123456789012345678901234567890123" *//** 创建引擎，使用测试环境，通用场景接入 */engine = ZegoExpressEngine.createEngine(appID, appSign, true, ZegoScenario.GENERAL, getApplication(), null);

2、登录房间

1）登录

传入用户 ID 参数 “userID” 创建 ZegoUser 用户对象后，调用 loginRoom 接口，传入房间 ID 参数 “roomID” 和用户参数 “user”，登录房间。

需要注意的是：

• 同一个 AppID 内，需保证 “roomID” 全局唯一。

• 同一个 AppID 内，需保证 “userID” 全局唯一，建议开发者将其设置成一个有意义的值，可将 “userID” 与自己业务账号系统进行关联。

• ZegoUser 的构造方法 public ZegoUser(String userID) 会将 “userName” 设为与传的参数 “userID” 一样。“userID” 与 “userName” 不能为 “null” 否则会导致登录房间失败。

Plain Text /** 创建用户 */ZegoUser user = new ZegoUser("user1");/** 开始登录房间 */engine.loginRoom("room1", user);

2）监听事件回调（可选）

根据实际应用需要，在登录房间后监听想要关注的事件通知，比如房间状态更新、用户状态更新、流状态更新等。

• onRoomStateUpdate：房间状态更新回调，登录房间后，当房间连接状态发生变更（如出现房间断开，登录认证失败等情况），SDK 会通过该回调通知。

• onRoomUserUpdate：用户状态更新回调，登录房间后，当房间内有用户新增或删除时，SDK 会通过该回调通知。

• onRoomStreamUpdate：流状态更新回调，登录房间后，当房间内有用户新推送或删除音视频流时，SDK 会通过该回调通知。

Plain Textengine.setEventHandler(new IZegoEventHandler() { /** 以下为常用的房间相关回调 */ /** 房间状态更新回调 */ @Override public void onRoomStateUpdate(String roomID, ZegoRoomState state, int errorCode, JSONObject extendedData) { /** 根据需要实现事件回调 */ } /** 用户状态更新回调 */ @Override public void onRoomUserUpdate(String roomID, ZegoUpdateType updateType, ArrayList<ZegoUser> userList) { /** 根据需要实现事件回调 */ } /** 流状态更新回调 */ @Override public void onRoomStreamUpdate(String roomID, ZegoUpdateType updateType, ArrayList<ZegoStream> streamList, JSONObject extendedData){ /** 根据需要实现事件回调 */ }});

3、推流

1）开始推流

调用 startPublishingStream 接口，传入流 ID 参数 “streamID”，向远端用户发送本端的音视频流。

需要注意的是：

同一个 AppID 内，需保证 “streamID” 全局唯一。如果同一个 AppID 内，不同用户各推了一条 “streamID” 相同的流，会导致后推流的用户推流失败。

Plain Text/** 开始推流 */engine.startPublishingStream("stream1");

2）启用本地预览（可选）

如果希望看到本端的画面，可调用 startPreview 接口设置预览视图，并启动本地预览。

Plain Text/** * 启动预览，设置本地预览视图，视图模式采用 SDK 默认的模式，等比缩放填充整个 View * 如下 preview_view 为 UI 界面上的 SurfaceView/TextureView/SurfaceTexture 对象 */engine.startPreview(new ZegoCanvas(preview_view));

3）监听事件回调（可选）

根据实际应用需要，在推流后监听想要关注的事件通知，比如推流状态更新等。

onPublisherStateUpdate：推流状态更新回调，调用推流接口成功后，当推流状态发生变更，如出现网络中断导致推流异常等情况，SDK 在重试推流的同时，会通过该回调通知。

Plain Textengine.setEventHandler(new IZegoEventHandler() { /** 常用的推流相关回调 */ /** 推流状态更新回调 */ @Override public void onPublisherStateUpdate(String streamID, ZegoPublisherState state, int errorCode, JSONObject extendedData){ /** 根据需要实现事件回调 */ }});

4、拉流

1）开始拉流

调用 startPlayingStream 接口，根据传入的流 ID 参数 “streamID”，拉取远端推送的音视频流。

远端用户推送的 “streamID” 可以从 IZegoEventHandler 代理中的 onRoomStreamUpdate 回调中获得。

支持以下类型的控件进行拉流播放：SurfaceView、TextureView 和 SurfaceTexture。

Plain Text/** * 开始拉流，设置远端拉流渲染视图，视图模式采用 SDK 默认的模式，等比缩放填充整个 View * 如下 play_view 为 UI 界面上的 SurfaceView/TextureView/SurfaceTexture 对象 */engine.startPlayingStream("stream1", new ZegoCanvas(play_view));

2）监听事件回调（可选）

根据实际应用需要，在拉流后监听想要关注的事件通知，比如拉流状态更新等。

onPlayerStateUpdate：拉流状态更新回调，调用拉流接口成功后，当拉流状态发生变更，如出现网络中断导致推流异常等情况，SDK 在重试拉流的同时，会通过该回调通知。

Plain Textengine.setEventHandler(new IZegoEventHandler() { /** 常用的拉流相关回调 */ /** 拉流状态相关回调 */ @Override public void onPlayerStateUpdate(String streamID, ZegoPlayerState state, int errorCode, JSONObject extendedData){ /** 根据需要实现事件回调 */ }});

5、停止推拉流

1）停止推流预览

调用 stopPublishingStream 接口停止向远端用户发送本端的音视频流。

Plain Text/** 停止推流 */engine.stopPublishingStream();

如果启用了本地预览，调用 stopPreview 接口停止预览。

Plain Text/** 停止本地预览 */engine.stopPreview();

2）停止拉流

调用 stopPlayingStream 接口停止拉取远端推送的音视频流。

Plain Text/** 停止拉流 */engine.stopPlayingStream(streamID);

6、退出房间

调用 logoutRoom 接口退出房间。

Plain Text/** 退出房间 */engine.logoutRoom("room1");

7、销毁引擎

调用 destroyEngine 接口销毁引擎，用于释放 SDK 使用的资源。

根据实际需要，可在销毁引擎时传入参数 “callback”，监听回调以确保设备硬件资源被释放完成。该回调只用于发送通知，开发者不可以在回调内释放与引擎相关的资源。如果开发者不需要监听回调，可将 “null” 传入 “callback”。

Plain Text/** 销毁 SDK */ZegoExpressEngine.destroyEngine(null);

以上就是 Java 直播实现的全流程，看完后大家不妨自己创建一个新项目实际操作下，有任何问题也可以私信或者是评论与我讨论哦~~~~