本文以Android Java为例,分享如何集成即构实时语音SDK,快速实现语音对讲、语音通话等功能。
即构实时语音SDK(Express SDK)是一款实时的音频互动服务产品,能够为开发者提供便捷接入、高可靠、多平台互通的音频服务。通过低至 200 ms 的端到端平均时延,业内领先的保障弱网质量的 QoS 策略,并结合强大的 3A 处理能力,完美支持一对多、多对多的实时语音通话、直播、会议等场景。
Java实现语音对讲前提条件
- 已在项目中集成 ZEGO Express SDK,实现基本的音视频功能,详情请参考 快速开始 – 集成。
- 已在 ZEGO 控制台 创建项目,并申请有效的 AppID 和 AppSign,详情请参考 控制台 – 项目管理 中的“项目信息”。
Java实现语音对讲步骤
本节介绍如何使用 ZEGO Express SDK 实现基本的实时语音功能,API 调用时序如下图:
创建引擎
1. (可选)创建界面
2. 创建引擎
定义 SDK 引擎对象,调用 createEngine 接口,将申请到的 AppID 和 AppSign 传入参数 “appID” 和 “appSign”。
根据 App 实际的音视频业务选择一个合适的场景,请参考 场景化音视频配置 文档,把选择好的场景枚举传入参数 “scenario”。
如果需要注册回调,可将实现了 IZegoEventHandler 的对象传入参数 “eventHandler”。如果不需要注册回调,可将 “null” 传入参数 “eventHandler”,创建引擎后仍需要注册回调时可通过调用 setEventHandler 接口设置回调。
/** 定义 SDK 引擎对象 */
ZegoExpressEngine engine;
ZegoEngineProfile profile = new ZegoEngineProfile();
/** 请通过官网注册获取,格式为 123456789L */
profile.appID = appID;
/** 请通过官网注册获取,格式为:@"0123456789012345678901234567890123456789012345678901234567890123"(共64个字符)*/
profile.appSign = appSign;
/** 指定使用直播场景 (请根据实际情况填写适合你业务的场景) */
profile.scenario = ZegoScenario.BROADCAST;
/** 设置app的application 对象 */
profile.application = getApplication();
/** 创建引擎 */
engine = ZegoExpressEngine.createEngine(profile, null);
登录房间
1. 登录
传入用户 ID 参数 “userID” 创建 ZegoUser 用户对象后,调用 loginRoom 接口,传入房间 ID 参数 “roomID” 和用户参数 “user”,登录房间。如果房间不存在,调用该接口时会创建并登录此房间。
- 同一个 AppID 内,需保证 “roomID” 全局唯一。
- 同一个 AppID 内,需保证 “userID” 全局唯一,建议开发者将其设置成一个有意义的值,可将 “userID” 与自己业务账号系统进行关联。
- ZegoUser 的构造方法
public ZegoUser(String userID)
会将 “userName” 设为与传的参数 “userID” 一样。“userID” 与 “userName” 不能为 “null” 否则会导致登录房间失败。
// ZegoUser 的构造方法 public ZegoUser(String userID) 会将 “userName” 设为与传的参数 “userID” 一样。“userID” 与 “userName” 不能为 “null” 否则会导致登录房间失败。
ZegoUser user = new ZegoUser("user1");
// 只有传入 “isUserStatusNotify” 参数取值为 “true” 的 ZegoRoomConfig,才能收到 onRoomUserUpdate 回调。
ZegoRoomConfig roomConfig = new ZegoRoomConfig();
// 如果您使用 appsign 的方式鉴权,token 参数不需填写;如果需要使用更加安全的 鉴权方式: token 鉴权,请参考[如何从 AppSign 鉴权升级为 Token 鉴权](https://doc-zh.zego.im/faq/token_upgrade?product=ExpressVideo&platform=all)
// roomConfig.token = "xxxx";
roomConfig.isUserStatusNotify = true;
// 登录房间
engine.loginRoom("room1", user, roomConfig, (int error, JSONObject extendedData)->{
// 登录房间结果,如果仅关注登录结果,关注此回调即可
});
2. 监听登录房间后的事件回调
根据实际应用需要,在登录房间后监听想要关注的事件通知,比如房间状态更新、用户状态更新、流状态更新等。
- onRoomStateChanged:房间状态更新回调。登录房间后,当房间连接状态发生变更(如出现房间断开,登录认证失败等情况),SDK 会通过该回调通知。
- onRoomUserUpdate:用户状态更新回调。登录房间后,当房间内有用户新增或删除时,SDK 会通过该回调通知。 只有调用 loginRoom 接口登录房间时传入 ZegoRoomConfig 配置,且 “isUserStatusNotify” 参数取值为 “true” 时,用户才能收到 onRoomUserUpdate 回调。
- onRoomStreamUpdate:流状态更新回调。登录房间后,当房间内有用户新推送或删除音频流时,SDK 会通过该回调通知。
注意
只有调用 loginRoom 接口登录房间时传入 ZegoRoomConfig 配置,且 “isUserStatusNotify” 参数取值为 “true” 时,用户才能收到 onRoomUserUpdate 回调。
通常情况下,如果某个用户想要播放其他用户推送的视频,可以在收到流状态更新(新增)的回调中,调用 startPlayingStream 接口拉取远端推送的音视频流。
engine.setEventHandler(new IZegoEventHandler() {
/** 以下为常用的房间相关回调 */
/** 房间状态更新回调 */
@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)
{
// 登出失败
}
}
/** 用户状态更新 */
@Override
public void onRoomUserUpdate(String roomID, ZegoUpdateType updateType, ArrayList<ZegoUser> userList) {
/** 根据需要实现事件回调 */
}
/** 流状态更新 */
@Override
public void onRoomStreamUpdate(String roomID, ZegoUpdateType updateType, ArrayList<ZegoStream> streamList, JSONObject extendedData){
/** 根据需要实现事件回调 */
}
});
推流
1. 开始推流
调用 startPublishingStream 接口,传入流 ID 参数 “streamID”,向远端用户发送本端的音频流。
注意:同一个 AppID 内,需保证 “streamID” 全局唯一。如果同一个 AppID 内,不同用户各推了一条 “streamID” 相同的流,会导致后推流的用户推流失败。
/** 开始推流 */
engine.startPublishingStream("stream1");
2. 监听推流后的事件回调
根据实际应用需要,在推流后监听想要关注的事件通知,比如推流状态更新等。
onPublisherStateUpdate:推流状态更新回调。调用推流接口成功后,当推流状态发生变更(如出现网络中断导致推流异常等情况),SDK 在重试推流的同时,会通过该回调通知。
engine.setEventHandler(new IZegoEventHandler() {
/** 常用的推流相关回调 */
/** 推流状态更新回调 */
@Override
public void onPublisherStateUpdate(String streamID, ZegoPublisherState state, int errorCode, JSONObject extendedData){
/** 根据需要实现事件回调 */
}
});
拉流
1. 开始拉流
调用 startPlayingStream 接口,根据传入的流 ID 参数 “streamID”,拉取远端推送的音频流。
远端用户推送的 “streamID” 可以从 IZegoEventHandler 中的 onRoomStreamUpdate 回调中获得。
/**
* 开始拉流
*/
engine.startPlayingStream("stream1");
2. 监听拉流后的事件回调
根据实际应用需要,在拉流后监听想要关注的事件通知,比如拉流状态更新等。
onPlayerStateUpdate:拉流状态更新回调。调用拉流接口成功后,当拉流状态发生变更(如出现网络中断导致推流异常等情况),SDK 在重试拉流的同时,会通过该回调通知。
engine.setEventHandler(new IZegoEventHandler() {
/** 常用的拉流相关回调 */
/** 拉流状态相关回调 */
@Override
public void onPlayerStateUpdate(String streamID, ZegoPlayerState state, int errorCode, JSONObject extendedData){
/** 根据需要实现事件回调 */
}
});
体验语音通话功能
在真机中运行项目,运行成功后,可以看到本端视频画面。
为方便体验,ZEGO 提供了一个 Web 端调试示例,在该页面下,输入相同的 AppID、RoomID,输入一个不同的 UserID,即可加入同一房间与真机设备互通。当成功开始音视频通话时,可以听到远端的音频,看到远端的视频画面。
停止推拉流
1. 停止推流
调用 stopPublishingStream 接口停止向远端用户发送本端的音频流。
/** 停止推流 */
engine.stopPublishingStream();
2. 停止拉流
调用 stopPlayingStream 接口停止拉取远端推送的音频流。
/** 停止拉流 */
engine.stopPlayingStream(streamID);
退出房间
调用 logoutRoom 接口退出房间。
/** 退出房间 */
engine.logoutRoom("room1");
销毁引擎
调用 destroyEngine 接口销毁引擎,用于释放 SDK 使用的资源。
- 如果需要监听回调,来确保设备硬件资源释放完成,可在销毁引擎时传入 “callback”。该回调只用于发送通知,开发者不可以在回调内释放与引擎相关的资源。
- 如果不需要监听回调,可传入 “null”。
/** 销毁 SDK */
ZegoExpressEngine.destroyEngine(null);
以上就是java实现语音对讲/通话功能的步骤的讲解,详细文档请查看https://doc-zh.zego.im/article/7636。
本文为原创稿件,版权归作者所有,如需转载,请注明出处:https://www.nxrte.com/jishu/yinshipin/5664.html