常见错误码

---

简介

当 SDK 运行出现网络、媒体相关等错误时，SDK 无法自动恢复，需要 App 干预或进行用户提示。调用接口后返回结果存在错误信息、事件回调中有错误信息或 console 日志中出现错误日志，则表示该接口调用异常。

• 调用接口后返回错误信息示例代码：

const { errorCode, extendedData } = await zg.setCaptureVolume(stream, result);
// errorCode 为错误码，extendedData 为错误描述信息
console.log(errorCode, extendedData); 

• 调用接口后抛出错误信息示例代码：

try {
    await zg.setCaptureVolume(stream, result);
} catch (error) {
    // errorCode 为错误码，extendedData 为错误描述信息
    const { errorCode, extendedData } = error;
    console.log(errorCode, extendedData); 
}

• 事件回调中错误信息示例代码：

zg.on('roomStateChanged', (roomID, reason, errorCode, extendedData) => {
    if (errorCode !== 0) {
      // errorCode 为错误码，extendedData 为错误描述信息
      console.log(errorCode, extendedData); 
    }
})

1000xxx/1100xxx 通用错误码

通用类错误码为接口通用错误的错误码，通常在调用 startPublishingStream、startPlayingStream 接口会出现，请根据以下错误码并进行相应处理。

1101xxx 调试阶段错误码

调试阶段错误码指的是开发者在开发应用期间容易出现的错误，一般表现为接口参数出错等。

1002xxx/1102xxx 房间相关错误码

调用 loginRoom 接口时出错，通常为登录房间参数错误，以及 SDK 与 ZEGO 房间服务端通讯出现的异常。

1003xxx/1103xxx 推流相关的错误码

调用推流接口后，或者在推流过程中出现异常，开发者可从 publisherStateUpdate 回调获取相关错误码，请根据以下错误码进行相应处理。

处理推流回调错误码非 0 的情况：

1. 当 “state” 为 “NO_PUBLISH” 时，且 “errorCode” 非 0，表示推流失败，同时不会再进行重试推流了，此时可在界面作出推流失败提示。
2. 当 “state” 为 “PUBLISH_REQUESTING” 时，且 “errorCode” 非 0，表示在重试推流，此时如果超出重试时间未成功推流会抛出推流失败通知。

1104xxx 拉流相关错误码

调用拉流接口后，或者在拉流中途出现异常，开发者可从 playerStateUpdate 拉流状态回调获取相关错误码，请根据以下错误码进行相应的处理。

1005xxx 混流相关错误码

调用开始混流 startMixerTask 和停止混流 stopMixerTask 接口返回结果可能出现的错误。

1006xxx 设备错误

推流、拉流过程可能会造成使用的音视频设备出错，当开发者收到 deviceError 设备异常回调参数的 “errorCode” 不为 0 时，请根据以下错误码进行相应的处理。

1009xxx/1109xxx IM 错误

发送 IM 消息过程中出现的错误。

1017xxx 版权音乐相关错误

使用 SDK 版权音乐相关 API 过程相关的错误码如下：

播放器插件相关错误码

其他错误码