实现音频通话

1 前提条件

在实现基本的实时语音功能之前，请确保：

• 已在项目中集成 ZEGO Express SDK，详情请参考 快速开始 - 集成。
• 已在 ZEGO 控制台 创建项目，并申请有效的 AppID 和 Server 地址，详情请参考 控制台 - 项目管理 中的“项目信息”。

2 使用步骤

本节介绍如何使用 ZEGO Express SDK 实现基本的实时音视频功能，API 调用时序如下图：

2.1 （可选）创建界面

添加界面元素

在创建引擎之前，推荐开发者添加以下界面元素，方便实现基本的实时音频通话功能。

• 本地预览窗口
• 远端视频窗口
• 结束按钮

2.2 创建引擎并监听回调

1. 创建引擎

创建 ZegoExpressEngine 引擎实例，将申请到的 AppID 传入参数 “appID”，将接入服务器地址传入参数 “server”。

// 项目唯一标识 AppID，Number 类型，请从 ZEGO 控制台获取
let appID = ; 
// 接入服务器地址 Server，String 类型，请从 ZEGO 控制台获取（获取方式请参考上文“前提条件”）
let server = "";
// 初始化实例
const zg = new ZegoExpressEngine(appID, server);

2. 监听事件回调

SDK 提供如房间连接状态、音视频流变化、用户进出等通知回调。创建引擎后，您可以通过引擎实例的on方法注册回调。

// 房间状态更新回调
zg.on('roomStateChanged', (roomID, reason, errorCode, extendData) => {
    if (reason == 'LOGINING') {
        // 登录中
    } else if (reason == 'LOGINED') {
        // 登录成功
        //只有当房间状态是登录成功或重连成功时，推流（startPublishingStream）、拉流（startPlayingStream）才能正常收发音视频
        //将自己的音视频流推送到 ZEGO 音视频云
    } else if (reason == 'LOGIN_FAILED') {
        // 登录失败
    } else if (reason == 'RECONNECTING') {
        // 重连中
    } else if (reason == 'RECONNECTED') {
        // 重连成功
    } else if (reason == 'RECONNECT_FAILED') {
        // 重连失败
    } else if (reason == 'KICKOUT') {
        // 被踢出房间
    } else if (reason == 'LOGOUT') {
        // 登出成功
    } else if (reason == 'LOGOUT_FAILED') {
        // 登出失败
    }
});

// 用户状态更新回调
zg.on('roomUserUpdate', (roomID, updateType, userList) => {
    console.warn(
        `roomUserUpdate: room ${roomID}, user ${updateType === 'ADD' ? 'added' : 'left'} `,
        JSON.stringify(userList),
    );
});

// 流状态更新回调
zg.on('roomStreamUpdate', async (roomID, updateType, streamList, extendedData) => {
    if (updateType == 'ADD') {
        // 流新增，开始拉流
    } else if (updateType == 'DELETE') {
        // 流删除，停止拉流
    }
});

2.3 （可选）检测兼容性

const result = await zg.checkSystemRequirements();
// 返回的 result 为兼容性检测结果。 webRTC 为 true 时表示支持 webRTC，其他属性含义可以参考接口 API 文档。
console.log(result);
// {
//   webRTC: true,
//   customCapture: true,
//   camera: true,
//   microphone: true,
//   videoCodec: { H264: true, H265: false, VP8: true, VP9: true },
//   screenSharing: true,
//   errInfo: {}
// }

2.4 登录房间

1. 生成 Token

登录房间需要用于验证身份的 Token，开发者可直接在 ZEGO 控制台获取临时 Token（有效期为 24 小时）来使用，详情请参考 控制台 - 开发辅助。

2. 登录房间

调用 loginRoom 接口，传入房间 ID 参数 “roomID”、“token” 和用户参数 “user”，登录房间。如果房间不存在，调用该接口时会创建并登录此房间。

// 登录房间，成功则返回 true
// userUpdate 设置为 true 会开启监听 roomUserUpdate 回调，默认情况下不会开启该监听
const result = await zg.loginRoom(roomID, token, { userID: userID, userName: userName}, {userUpdate: true});

3. 监听登录房间后的事件回调

您可以监听 roomStateChanged 回调实时监控自己与房间的连接状态。只有当房间状态是连接成功时，才能进行推流、拉流等操作。如果登录房间失败，可参考 错误码 进行操作。

2.5 推流

1. 创建流

a. 开始推流前需要创建本端的音视频流，调用 createZegoStream 接口，默认会采集摄像头画面和麦克风声音。

通过 localStream 的 playAudio 接口，创建本地媒体流播放组件，播放待推送或者已经成功推流的音频；也可以通过 video 元素 srcObject 属性赋值 localStream.stream 进行播放。

// 调用 createZegoStream 接口后，需要等待 ZEGO 服务器返回 ZegoLocalStream 实例对象才能执行后续操作
const localStream = await zg.createZegoStream({camera :{audio:true,video:false}});
// 调用 localStream 实例上 playAudio 方法播放推流前或者推流中音频预览
localStream.playAudio();

b. （可选）设置音频采集参数

c. （可选）在页面上渲染 MediaStream（媒体流）

2. 开始推流

调用 startPublishingStream 接口，传入流 ID 参数 “streamID” 和创建流得到的流对象 “localStream”，向远端用户发送本端的音视频流。

// localStream 为创建流获取的 MediaStream 对象
zg.startPublishingStream(streamID, localStream)

3. 监听推流后的事件回调

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

• publisherStateUpdate：推流状态更新回调。调用推流接口成功后，当推流状态发生变更（如出现网络中断导致推流异常等情况），SDK 在重试推流的同时，会通过该回调通知。
• publishQualityUpdate：推流质量回调。调用推流接口成功后，定时回调音视频流质量数据（如分辨率、帧率、码率等）。

zg.on('publisherStateUpdate', result => {
    // 推流状态更新回调
    // ... 
})

zg.on('publishQualityUpdate', (streamID, stats) => {
    // 推流质量回调
    // ... 
})

2.6 拉流

1. 开始拉流

a. 调用 startPlayingStream 接口，根据传入的流 ID 参数 “streamID”，拉取远端已推送到 ZEGO 服务器的音视频画面。

远端用户推送的 “streamID” 可以从 roomStreamUpdate 回调中获得。

const remoteStream = await zg.startPlayingStream(streamID);

// remoteAudio为本地<video>或<audio>对象
remoteAudio.srcObject = remoteStream;

b. （可选）在页面上渲染 MediaStream（媒体流）

2. 监听拉流后的事件回调

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

• playerStateUpdate：拉流状态更新回调。调用拉流接口成功后，当拉流状态发生变更（如出现网络中断导致推流异常等情况），SDK 在重试推流的同时，会通过该回调通知。
• playQualityUpdate：拉流质量回调。调用拉流接口成功后，定时回调音视频流质量数据（如分辨率、帧率、码率等）。

zg.on('playerStateUpdate', result => {
    // 拉流状态更新回调
    // ...
})

zg.on('playQualityUpdate', (streamID,stats) => {
    // 拉流质量回调
})

2.7 体验实时音视频功能

在真机中运行项目，运行成功后，可以看到本端视频画面。

为方便体验，ZEGO 提供了一个 Web 端调试示例 ，在该页面下，输入相同的 AppID、RoomID，输入不同的 UserID、以及对应的 Token，即可加入同一房间与真机设备互通。当成功开始音视频通话时，可以听到远端的音频，看到远端的视频画面。

2.8 停止音视频通话

1. 停止推流

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

zg.stopPublishingStream(streamID)

2. 销毁流

调用 destroyStream 接口销毁创建的流数据，销毁流后开发需自行销毁 audio（停止采集）。

// localStream 是调用 createZegoStream 接口获取的 ZegoLocalStream 实例对象
zg.destroyStream(localStream)

3. 停止拉流

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

zg.stopPlayingStream(streamID)

4. 退出房间

调用 logoutRoom 接口退出房间。

zg.logoutRoom(roomID)

5. 销毁引擎

如果用户彻底不使用音视频功能时，可调用 destroyEngine 接口销毁引擎，释放麦克风、摄像头、内存、CPU 等资源。

zg.destroyEngine()
zg = null