通话质量监测
2024-01-12
功能简介
在通话或直播的过程中，用户可通过注册相关的回调以监听具体的推拉流的质量。
使用步骤
监控推流质量
开发者可通过注册 onPublisherQualityUpdate 接收推流质量回调。推流成功后每隔三秒会收到此回调。开发者可根据回调返回的质量参数实时监控推送的音视频流的健康情况，以便在设备 UI 界面上实时展示上行网络状况。
- 接口原型：
/**
* 推流质量回调
* 推流成功后每 3 秒会收到此回调
* @param streamID 流 ID
* @param quality 推流质量
*/
virtual void onPublisherQualityUpdate(const std::string& streamID, const ZegoPublishStreamQuality& quality) {
// 请注意，请勿在 SDK 回调线程中调用任何 SDK 接口，需要手动切换为其他线程，否则会产生死锁
}- 调用示例：
class MyEventHandler: public IZegoEventHandler
{
void onPublisherQualityUpdate(const std::string& streamID, const ZegoPublishStreamQuality& quality) {
printf("onPublisherQualityUpdate: streamID=%s", streamID.c_str());
}
};推流质量详解
推流质量 ZegoPublishStreamQuality 包含了采集、编码阶段音视频流的帧率，传输(发送)的音视频流的帧率、码率、延时及丢包率。具体定义如下：
struct ZegoPublishStreamQuality
{
// 视频采集帧率，单位为 f/s
double videoCaptureFPS;
// 视频编码帧率，单位为 f/s
double videoEncodeFPS;
// 视频发送帧率，单位为 f/s
double videoSendFPS;
// 视频码率，单位为 kbps
double videoKBPS;
// 音频采集帧率，单位为 f/s
double audioCaptureFPS;
// 音频发送帧率，单位为 f/s
double audioSendFPS;
// 音频码率，单位为 kbps
double audioKBPS;
// 本端至服务端的延迟，单位为毫秒
int rtt;
// 丢包率，单位为百分比，0.0 ~ 1.0
double packetLostRate;
// 推流质量级别
ZegoStreamQualityLevel level;
// 是否开启硬件编码
bool isHardwareEncode;
// 视频编码格式
ZegoVideoCodecID videoCodecID;
// 已发送的总字节数，包括音频、视频和 SEI 等
double totalSendBytes;
// 已发送的音频字节数
double audioSendBytes;
// 已发送的视频字节数
double videoSendBytes;
}; 推流采集质量
推流采集质量贴近用户预览时的主观感受，推流时 SDK 在采集阶段的音视频质量的相关参数如下：
- audioCaptureFPS：音频采集帧率（fps）
- videoCaptureFPS：视频采集帧率（fps）
推流编码质量
推流时 SDK 在编码阶段的音视频质量的相关参数如下：
- videoEncodeFPS：当前编码器的目标视频编码帧率（fps）
推流发送质量
推流发送质量是实际推流的质量，与实际的网络质量有关，相关成员如下：
- audioSendFPS：实际的音频发送帧率（fps）
- audioKBPS：实际的音频发送码率（Kbps）
- videoSendFPS：实际的视频发送帧率（fps）
- videoKBPS：实际的视频发送码率（Kbps）
- rtt：设备到 ZEGO Server 的往返延时（ms）
- packetLostRate：设备上行丢包率
监控拉流质量
开发者可通过注册 onPlayerQualityUpdate 接收拉流质量回调。拉流成功后每隔三秒会收到此回调。开发者可根据回调返回的质量参数实时监控拉取的音视频流的健康情况，以便在设备 UI 界面上实时展示下行网络状况。
- 接口原型：
/**
* 拉流质量回调
* 拉流成功后每 3 秒会收到此回调
* @param streamID 流 ID
* @param quality 拉流质量
*/
virtual void onPlayerQualityUpdate(const std::string& streamID, const ZegoPlayStreamQuality& quality) {
// 请注意，请勿在 SDK 回调线程中调用任何 SDK 接口，需要手动切换为其他线程，否则会产生死锁
}- 调用示例：
class MyEventHandler: public IZegoEventHandler
{
void onPlayerQualityUpdate(const std::string& streamID, const ZegoPlayStreamQuality& quality) {
printf("onPlayerQualityUpdate: streamID=%s", streamID.c_str());
}
};拉流质量详解
拉流质量 ZegoPlayStreamQuality 包含了接收的音视频流的帧率、码率、延时和丢包率，解码阶段音视频流的帧率，以及渲染阶段的帧率、卡顿率、音视频整体质量。具体定义如下：
struct ZegoPlayStreamQuality
{
// 视频接收帧率，单位为 f/s
double videoRecvFPS;
// 视频抗抖动帧率，单位为 f/s
double videoDejitterFPS;
// 视频解码帧率，单位为 f/s
double videoDecodeFPS;
// 视频渲染帧率，单位为 f/s
double videoRenderFPS;
// 视频码率，单位为 kbps
double videoKBPS;
// 视频卡顿率，单位为（卡顿次数/每 10 秒）
// 超过 500 ms 没有数据播放，即为一次视频卡顿
double videoBreakRate;
// 音频接收帧率，单位为 f/s
double audioRecvFPS;
// 音频抗抖动帧率，单位为 f/s
double audioDejitterFPS;
// 音频解码帧率，单位为 f/s
double audioDecodeFPS;
// 音频渲染帧率，单位为 f/s
double audioRenderFPS;
// 音频码率，单位为 kbps
double audioKBPS;
// 音频卡顿率，单位为（卡顿次数/每 10 秒）
// 连续丢 3 帧且在给定卡顿阈值内无音频数据渲染，即为一次音频卡顿
double audioBreakRate;
// 服务端至本端的延迟，单位为毫秒
int rtt;
// 丢包率，单位为百分比，0.0 ~ 1.0
double packetLostRate;
// 端到端延迟，单位为毫秒
int peerToPeerDelay;
// 端到端丢包率，单位为百分比，0.0 ~ 1.0
double peerToPeerPacketLostRate;
// 拉流质量级别
ZegoStreamQualityLevel level;
// 本端接收到数据后到播放的延迟，单位为毫秒
int delay;
// 视频时间戳相对于音频时间戳的差值，用于反映音画同步情况，单位为毫秒。此值小于 0 表示视频超前音频的毫秒数, 大于 0 表示视频滞后音频的毫秒数, 等于0表示无差别。 当绝对值小于 200，可基本认为音画同步，当绝对值连续 10 秒大于 200 可以认为异常
int avTimestampDiff;
// 是否开启硬件解码
bool isHardwareDecode;
// 视频编码格式
ZegoVideoCodecID videoCodecID;
// 已接收的总字节数，包括音频、视频和 SEI 等
double totalRecvBytes;
// 已接收的音频字节数
double audioRecvBytes;
// 已接收的视频字节数
double videoRecvBytes;
};拉流接收质量
拉流接收质量是实际的拉流质量，与实际的推流质量和当前的网络质量相关。相关参数如下：
- audioRecvFPS：实际接收的音频帧率（fps）
- audioKBPS：实际接收的音频码率（Kbps）
- audioBreakRate：实际接收的音频卡顿率（卡顿次数/每 10 秒）
- videoKBPS：实际接收的视频帧率（fps）
- videoRecvFPS：实际接收的视频码率（Kbps）
- videoBreakRate：实际接收的视频卡顿率（卡顿次数/每 10 秒）
- packetLostRate：设备下行丢包率
- rtt：设备到 ZEGO Server 的往返延时（ms）
拉流渲染质量
拉流渲染质量贴近用户观看音视频的主观感受，该质量受解码器影响可能低于实际接收的拉流质量值。相关参数如下：
- audioRenderFPS：实际的音频渲染帧率
- videoRenderFPS：实际的视频渲染帧率