错误码
稳定错误码、HTTP/引擎错误映射与处置建议。
错误码
约定(与声网 C++ 一致):
- 方法返回 负值 表示失败,取值为
-ERROR_CODE_TYPE; onError/onRecorderStateChanged携带 正值 错误码;- 本交付无法执行的成员抛
nimeet::recording::NotSupportedException,code() == 4(ERR_NOT_SUPPORTED)。
| 代码 | 名称 | 本 SDK 的使用场景 |
|---|---|---|
| 0 | ERR_OK | 成功 |
| 1 | ERR_FAILED | 产物未通过校验、egress 任务非 completed |
| 2 | ERR_INVALID_ARGUMENT | 参数为空、几何非法、目录不可写 |
| 3 | ERR_NOT_READY | 未初始化/未加入频道时调用录制 |
| 4 | ERR_NOT_SUPPORTED | 显式不支持(见下) |
| 7 | ERR_NOT_INITIALIZED | 未注入 sink |
| 8 | ERR_INVALID_STATE | 状态机非法转换 |
| 10 | ERR_TIMEDOUT | egress 任务未在超时内进入终态 |
| 17 | ERR_JOIN_CHANNEL_REJECTED | 频道参数被拒绝 |
| 18 | ERR_LEAVE_CHANNEL_REJECTED | 未加入时离开频道 |
| 19 | ERR_ALREADY_IN_USE | 重复开始/重复加入 |
| 22 | ERR_RESOURCE_LIMITED | egress 侧配额不足(HTTP 429) |
| 101 | ERR_INVALID_APP_ID | appId 为空 |
| 102 | ERR_INVALID_CHANNEL_NAME | 频道名为空或超过 64 字节 |
| 110 | ERR_INVALID_TOKEN | Token 缺失/为空 |
| 1001 | ERR_LOAD_MEDIA_ENGINE | 找不到 ffmpeg 编码器、编码器异常退出 |
当前版本不支持的成员
setUserBackground、setVideoMixingLayout(两代各一)、updateWatermarkConfigs、enableAndUpdateVideoWatermarks(ByUid)、disableVideoWatermarks(ByUid)、enableEncryption、setAudioVolumeIndicationParameters、setGlobalLocalAccessPoint、setRecorderConfigByUid、startSingleRecordingByUid、stopSingleRecordingByUid、getAgoraParameter。
共同原因:需要真实媒体渲染、加密或多路分流能力,当前 SDK 不包含这些能力;因此明确失败而不是静默成功。