You need to enable JavaScript to run this app.
导航

错误码

最近更新时间2024.01.08 21:09:38

首次发布时间2022.08.08 10:29:46

AudioRecordingErrorCode
enum bytertc::AudioRecordingErrorCode

音频文件录制的错误码

枚举值

类型说明
kAudioRecordingErrorCodeOk录制正常
kAudioRecordingErrorCodeNoPermission没有文件写权限
kAudioRecordingErrorCodeNotInRoom没有进入房间
kAudioRecordingErrorCodeAlreadyStarted录制已经开始
kAudioRecordingErrorCodeNotStarted录制还未开始
kAudioRecordingErrorCodeNotSupport录制失败。文件格式不支持。
kAudioRecordingErrorCodeOther其他异常
ErrorCode
enum bytertc::ErrorCode

回调错误码。

SDK 内部遇到不可恢复的错误时,会通过 onError 回调通知用户。

枚举值

类型说明
kErrorCodeInvalidTokenToken 无效。通过 onRoomStateChanged 回调。
调用 joinRoom 进房时使用的 Token 参数有误或过期失效。需要重新获取 Token,并调用 updateToken 方法更新 Token。
kErrorCodeJoinRoom加入房间错误。通过 onRoomStateChanged 回调。
进房时发生未知错误导致加入房间失败。需要用户重新加入房间。
kErrorCodeNoPublishPermission没有发布音视频流权限。通过 onStreamStateChanged 回调。
用户在所在房间中发布音视频流失败,失败原因为用户没有发布流的权限。
kErrorCodeNoSubscribePermission没有订阅音视频流权限。通过 onStreamStateChanged 回调。
用户订阅所在房间中的音视频流失败,失败原因为用户没有订阅流的权限。
kErrorCodeDuplicateLogin相同用户 ID 的用户加入本房间,当前用户被踢出房间。通过 onRoomStateChanged 回调。
kErrorCodeKickedOut服务端调用 OpenAPI 将当前用户踢出房间。通过 onRoomStateChanged 回调。
kRoomErrorCodeRoomIdIllegal当调用 createRTCRoom ,如果roomid 非法,会返回null,并抛出该error。通过 onCreateRoomStateChanged 回调。
kRoomErrorTokenExpiredToken 过期。加入房间后 Token 过期时,返回此错误码。需使用新的 Token 重新加入房间。通过 onRoomStateChanged 回调。
kRoomErrorUpdateTokenWithInvalidToken调用 updateToken 传入的 Token 无效。通过 onRoomStateChanged 回调。
kErrorCodeRoomDismiss服务端调用 OpenAPI 解散房间,所有用户被移出房间。通过 onRoomStateChanged 回调。
kErrorCodeRoomAlreadyExist通话回路检测已经存在同样 roomId 的房间了。通过 onCreateRoomStateChanged 回调。
kErrorCodeUserIDDifferent加入多个房间时使用了不同的 uid。通过 onRoomStateChanged 回调。
同一个引擎实例中,用户需使用同一个 uid 加入不同的房间。
kErrorCodeJoinRoomRoomForbidden房间被封禁。通过 onRoomStateChanged 回调。
kErrorCodeJoinRoomUserForbidden用户被封禁。通过 onRoomStateChanged 回调。
kErrorCodeOverStreamSubscribeLimit订阅音视频流失败,订阅音视频流总数超过上限。通过 onStreamStateChanged 回调。
游戏场景下,为了保证音视频通话的性能和质量,服务器会限制用户订阅的音视频流总数。当用户订阅的音视频流总数已达上限时,继续订阅更多流时会失败,同时用户会收到此错误通知。
kErrorCodeOverStreamPublishLimit发布流失败,发布流总数超过上限。通过 onStreamStateChanged 回调。
RTC 系统会限制单个房间内发布的总流数,总流数包括视频流、音频流和屏幕流。如果房间内发布流数已达上限时,本地用户再向房间中发布流时会失败,同时会收到此错误通知。
kErrorCodeInvalidAudioSyncUidRepeated音视频同步失败。通过 onStreamStateChanged 回调。
当前音频源已与其他视频源关联同步关系。

单个音频源不支持与多个视频源同时同步。
kErrorCodeAbnormalServerStatus服务端异常状态导致退出房间。通过 onRoomStateChanged 回调。
SDK与信令服务器断开,并不再自动重连,可联系技术支持。
[deprecated] kErrorCodeOverScreenPublishLimit发布屏幕流失败,发布流总数超过上限。
RTC 系统会限制单个房间内发布的总流数,总流数包括视频流、音频流和屏幕流。如果房间内发布流数已达上限时,本地用户再向房间中发布流时会失败,同时会收到此错误通知。
[deprecated] kErrorCodeOverVideoPublishLimit发布视频流总数超过上限。
RTC 系统会限制单个房间内发布的视频流数。如果房间内发布视频流数已达上限时,本地用户再向房间中发布视频流时会失败,同时会收到此错误通知。
WarningCode
enum bytertc::WarningCode

回调警告码。
警告码说明 SDK 内部遇到问题正在尝试恢复。警告码仅起通知作用。

枚举值

类型说明
kWarningCodeJoinRoomFailed进房失败。通过 onRoomStateChanged 回调。
当你调用初次加入房间或者由于网络状况不佳断网重连时,由于服务器错误导致进房失败。SDK 会自动重试进房。
kWarningCodePublishStreamFailed发布音视频流失败。通过 onStreamStateChanged 回调。
当你在所在房间中发布音视频流时,由于服务器错误导致发布失败。SDK 会自动重试发布。
kWarningCodeSubscribeStreamFailed404订阅音视频流失败。通过 onStreamStateChanged 回调。
当前房间中找不到订阅的音视频流导致订阅失败。SDK 会自动重试订阅,若仍订阅失败则建议你退出重试。
kWarningCodeSubscribeStreamFailed5xx订阅音视频流失败。通过 onStreamStateChanged 回调。
当你订阅所在房间中的音视频流时,由于服务器错误导致订阅失败。SDK 会自动重试订阅。
kWarningCodePublishStreamForbiden当调用 setUserVisibility 将自身可见性设置为 false 后,再尝试发布流会触发此警告。通过 onStreamStateChanged 回调。
kWarningCodeSendCustomMessage发送自定义广播消息失败,当前你未在房间中。
kWarningCodeUserNotifyStop当房间内人数超过 500 人时,停止向房间内已有用户发送 onUserJoinedonUserLeave 回调,并通过广播提示房间内所有用户。通过 onRoomStateChanged 回调。
kWarningCodeUserInPublish用户已经在其他房间发布过流,或者用户正在发布公共流。通过 onStreamStateChanged 回调。
kWarningCodeOldRoomBeenReplaced已存在相同 roomId 的房间,新创建的房间实例已替换旧房间实例。通过 onRoomStateChanged 回调。
kWarningCodeInEchoTestMode当前正在进行回路测试,该接口调用无效
kWarningCodeNoCameraPermission摄像头权限异常,当前应用没有获取摄像头权限。
kWarningCodeNoMicrophonePermission已在 3.33 版本中废弃,使用 MediaDeviceError.kMediaDeviceErrorDeviceNoPermission 代替。

麦克风权限异常,当前应用没有获取麦克风权限。
kWarningCodeRecodingDeviceStartFailed已在 3.33 版本中废弃,使用 MediaDeviceError.kMediaDeviceErrorDeviceFailure 代替。

音频采集设备启动失败,当前设备可能被其他应用占用。
kWarningCodePlayoutDeviceStartFailed已在 3.33 版本中废弃,使用 use MediaDeviceError.kMediaDeviceErrorDeviceFailure 代替。

音频播放设备启动失败警告,可能由于系统资源不足,或参数错误。
kWarningCodeNoRecordingDevice已在 3.33 版本中废弃,使用 MediaDeviceError.kMediaDeviceErrorDeviceNotFound 代替。

无可用音频采集设备,请插入可用的音频采集设备。
kWarningCodeNoPlayoutDevice已在 3.33 版本中废弃,使用 MediaDeviceError.kMediaDeviceErrorDeviceNotFound 代替。

无可用音频播放设备,请插入可用的音频播放设备。
kWarningCodeRecordingSilence已在 3.33 版本中废弃,使用 MediaDeviceWarning.kMediaDeviceWarningCaptureSilence 代替。

当前音频设备没有采集到有效的声音数据,请检查更换音频采集设备。
kWarningCodeMediaDeviceOperationDenied已在 3.33 版本中废弃,使用 MediaDeviceWarning.kMediaDeviceWarningOperationDenied 代替。

媒体设备误操作警告。

使用自定义采集时,不可调用内部采集开关,调用时将触发此警告。
kWarningCodeSetScreenAudioSourceTypeFailed不支持在 publishScreen 之后调用 setScreenAudioSourceType 设置屏幕音频采集类型,请在 publishScreen 之前设置
kWarningCodeSetScreenAudioStreamIndexFailed不支持在 publishScreen 之后, 通过 setScreenAudioStreamIndex 设置屏幕共享时的音频采集方式。
kWarningCodeInvalidVoicePitch设置语音音高不合法
kWarningCodeInvalidAudioFormat设置音频格式不合法
kWarningCodeInvalidCallForExtAudio外部音频源新旧接口混用
kWarningCodeInvalidRemoteStreamKey非法的远端流索引
kWarningCodeInvalidCanvasHandle指定的内部渲染画布句柄无效。

当你调用 setLocalVideoCanvas 时指定了无效的画布句柄,触发此回调。
kWarningLicenseFileExpired鉴权文件失效,当检查鉴权文件状态时,本地文件与远端文件不一致会触发次警告。
kWarningInvaildSamiAppkeyORToken音频技术 SDK 鉴权失效。联系技术支持人员。
kWarningInvaildSamiResourcePath音频技术 资源加载失败。传入正确的 DAT 路径,或联系技术支持人员。
kWarningLoadSamiLibraryFailed音频技术 库加载失败。使用正确的库,或联系技术支持人员。
kWarningInvaildSamiEffectType音频技术 不支持此音效。联系技术支持人员。
[deprecated] kWarningCodeGetRoomFailed
[deprecated] kWarningCodeSubscribeStreamForbiden自动订阅模式未关闭时,尝试开启手动订阅模式会触发此警告。

你需在进房前关闭自动订阅模式,再调用 subscribeStream 方法手动订阅音视频流。
LocalVideoStreamError
enum bytertc::LocalVideoStreamError

本地视频状态改变时的错误码

枚举值

类型说明
kLocalVideoStreamErrorOk状态正常
kLocalVideoStreamErrorFailure本地视频流发布失败
kLocalVideoStreamErrorDeviceNoPermission没有权限启动本地视频采集设备
kLocalVideoStreamErrorDeviceBusy本地视频采集设备已被占用
kLocalVideoStreamErrorDeviceNotFound本地视频采集设备不存在
kLocalVideoStreamErrorCaptureFailure本地视频采集失败,建议检查采集设备是否正常工作
kLocalVideoStreamErrorEncodeFailure本地视频编码失败
kLocalVideoStreamErrorDeviceDisconnected通话过程中本地视频采集设备被其他程序抢占,导致设备连接中断
NetworkDetectionStartReturn
enum bytertc::NetworkDetectionStartReturn

开始探测的返回值
startNetworkDetection 返回对象类型

枚举值

类型说明
kNetworkDetectionStartReturnSuccess成功开启网络探测。
kNetworkDetectionStartReturnParamErr开始探测失败。参数错误,上下行探测均为 false,或期望带宽超过了范围 [100,10000]
kNetworkDetectionStartReturnStreaming开始探测失败。失败原因为,本地已经开始推拉流
kNetworkDetectionStartReturnStarted已经开始探测,无需重复开启
kNetworkDetectionStartReturnNotSupport不支持该功能
SubtitleErrorCode
enum bytertc::SubtitleErrorCode

字幕任务错误码。

枚举值

类型说明
kSubtitleErrorCodeUnknow客户端无法识别云端媒体处理发送的错误码。请联系技术支持。
kSubtitleErrorCodeSuccess字幕已开启。
kSubtitleErrorCodePostProcessError云端媒体处理内部出现错误,请联系技术支持。
kSubtitleErrorCodeASRConnectionError第三方服务连接失败,请联系技术支持。
kSubtitleErrorCodeASRServiceError第三方服务内部出现错误,请联系技术支持。
kSubtitleErrorCodeBeforeJoinRoom未进房导致调用startSubtitle失败。请加入房间后再调用此方法。
kSubtitleErrorCodeAlreadyOn重复调用 startSubtitle
kSubtitleErrorCodeUnsupportedLanguage用户选择的目标语言目前暂不支持。
kSubtitleErrorCodePostProcessTimeout云端媒体处理超时未响应,请联系技术支持。
LoginErrorCode
enum bytertc::LoginErrorCode

登录结果

调用 login 登录的结果,会通过 onLoginResult 回调通知用户。

枚举值

类型说明
kLoginErrorCodeSuccess调用 login 方法登录成功
kLoginErrorCodeInvalidToken调用 login 方法时使用的 Token 无效或过期失效,需要用户重新获取 Token。
kLoginErrorCodeLoginFailed登录错误

调用 login 方法时发生未知错误导致登录失败,需要重新登录。
kLoginErrorCodeInvalidUserId调用 login 方法时传入的用户 ID 有问题。
kLoginErrorCodeServerError调用 login 登录时服务端出错。
UserMessageSendResult
enum bytertc::UserMessageSendResult

发送消息结果,成功或失败,及失败原因

枚举值

类型说明
kUserMessageSendResultSuccess发送消息成功
kUserMessageSendResultTimeout发送超时,没有发送成功
kUserMessageSendResultNetworkDisconnected通道断开,没有发送
kUserMessageSendResultNoReceiver找不到接收方
kUserMessageSendResultNoRelayPath远端用户没有登录或进房
kUserMessageSendResultExceedQPS超过 QPS 限制
kUserMessageSendResultE2BSSendFailed消息发送失败。应用服务器未收到客户端发送的消息。

sendServerMessage/sendServerBinaryMessage 触发,通过 onServerMessageSendResult 回调。
kUserMessageSendResultE2BSReturnFailed消息发送失败。应用服务器接收到了客户端发送的消息,但响应失败。

sendServerMessage/sendServerBinaryMessage 触发,通过 onServerMessageSendResult 回调。
kUserMessageSendResultNotJoin消息发送方没有加入房间
kUserMessageSendResultInit连接未完成初始化,没有可用的数据传输通道连接
kUserMessageSendResultNoConnection没有可用的数据传输通道连接
kUserMessageSendResultExceedMaxLength消息超过最大长度,当前为 64 KB
kUserMessageSendResultEmptyUser接收消息的单个用户 id 为空
kUserMessageSendResultNotLogin房间外或应用服务器消息发送方没有登录
kUserMessageSendResultServerParamsNotSet发送消息给业务方服务器之前没有设置参数
kUserMessageSendResultUnknown未知错误
RtsErrorCode
enum bytertc::RtsErrorCode

回调错误码。

SDK 内部遇到不可恢复的错误时,会通过 onError 回调通知用户。

枚举值

类型说明
kRtsErrorCodeInvalidTokenToken 无效。
进房时使用的 Token 无效或过期失效。需要用户重新获取 Token,并调用 updateToken 方法更新 Token。
kRtsErrorCodeJoinRoom加入房间错误。
进房时发生未知错误导致加入房间失败。需要用户重新加入房间。
kRtsErrorCodeDuplicateLogin相同用户 ID 的用户加入本房间,当前用户被踢出房间
kRtsErrorCodeKickedOut服务端调用 OpenAPI 将当前用户踢出房间
kRtsRoomErrorCodeRoomIdIllegal当调用 createRTCRoom ,如果roomid 非法,会返回null,并抛出该error
kRtsRoomErrorTokenExpiredToken 过期。调用 joinRoom 使用新的 Token 重新加入房间。
kRtsRoomErrorUpdateTokenWithInvalidToken调用 updateToken 传入的 Token 无效
kRtsErrorCodeRoomDismiss服务端调用 OpenAPI 解散房间,所有用户被移出房间。
kRtsErrorCodeRoomAlreadyExist通话回路检测已经存在同样 roomId 的房间了
kRtsErrorCodeUserIDDifferent同一个引擎实例在进入多个房间时设置的用户名必须相同
kRtsErrorCodeAbnormalServerStatus服务端异常状态导致退出房间。

SDK与信令服务器断开,并不再自动重连,可联系技术支持。
RtsWarningCode
enum bytertc::RtsWarningCode

回调警告码。
警告码说明 SDK 内部遇到问题正在尝试恢复。警告码仅起通知作用。

枚举值

类型说明
kRtsWarningCodeJoinRoomFailed进房失败。

当你调用初次加入房间或者由于网络状况不佳断网重连时,由于服务器错误导致进房失败。SDK 会自动重试进房。
kRtsWarningCodePublishStreamFailed发布音视频流失败。

当你在所在房间中发布音视频流时,由于服务器错误导致发布失败。SDK 会自动重试发布。
kRtsWarningCodeSendCustomMessage发送自定义广播消息失败,当前你未在房间中。
kRtsWarningCodeUserNotifyStop当房间内人数超过 500 人时,停止向房间内已有用户发送 onUserJoinedonUserLeave 回调,并通过广播提示房间内所有用户。
kRtsWarningCodeOldRoomBeenReplaced新生成的房间已经替换了同样roomId的旧房间
SingleStreamPushEvent
enum bytertc::SingleStreamPushEvent

单流转推直播错误码

枚举值

类型说明
kSingleStreamPushEventStart开始推流。
kSingleStreamPushEventSuccess推流成功。
kSingleStreamPushEventFailed推流失败。
kSingleStreamPushEventStop停止推流。
kSingleStreamPushEventTimeout单流转推直播任务处理超时,请检查网络状态并重试。
kSingleStreamPushEventParamError参数错误。
StreamMixingErrorCode
enum bytertc::StreamMixingErrorCode

转推直播错误码

枚举值

类型说明
kStreamMixingErrorCodeOK推流成功。
kStreamMixingErrorCodeBase未定义的合流错误
kStreamMixingErrorCodeInvalidParam客户端 SDK 检测到无效推流参数。
kStreamMixingErrorCodeInvalidState状态错误,需要在状态机正常状态下发起操作
kStreamMixingErrorCodeInvalidOperator无效操作
kStreamMixingErrorCodeTimeout转推直播任务处理超时,请检查网络状态并重试
kStreamMixingErrorCodeInvalidParamByServer服务端检测到错误的推流参数
kStreamMixingErrorCodeSubTimeoutByServer对流的订阅超时
kStreamMixingErrorCodeInvalidStateByServer合流服务端内部错误。
kStreamMixingErrorCodeAuthenticationByCDN合流服务端推 CDN 失败。
kStreamMixingErrorCodeTimeoutBySignaling服务端接收信令超时,请检查网络状态并重试。
kStreamMixingErrorCodeMixImageFail图片合流失败。
kStreamMixingErrorCodeUnKnownByServer服务端未知错误。
PublicStreamErrorCode
enum bytertc::PublicStreamErrorCode

公共流状态码

枚举值

类型说明
kPublicStreamErrorCodeOK发布或订阅成功。
kPublicStreamErrorCodePushInvalidParam公共流的参数异常,请修改参数后重试。
kPublicStreamErrorCodePushInvalidStatus服务端状态异常,将自动重试。
kPublicStreamErrorCodePushInternalError内部错误,不可恢复,请重试。
kPublicStreamErrorCodePushFailed发布失败,将自动重试,请关注重试结果。
kPublicStreamErrorCodePushTimeout发布失败,10 s 后会重试,重试 3 次后自动停止。
kPublicStreamErrorCodePullNoPushStream订阅失败,发布端未开始发布流。