You need to enable JavaScript to run this app.
导航
错误码
最近更新时间:2024.03.12 21:10:23首次发布时间:2022.08.08 10:29:46

UserMessageSendResult
enum bytertc::UserMessageSendResult

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

枚举值

类型说明
kUserMessageSendResultSuccess0发送消息成功
kUserMessageSendResultTimeout1发送超时,没有发送成功
kUserMessageSendResultNetworkDisconnected2通道断开,没有发送
kUserMessageSendResultNoReceiver3找不到接收方
kUserMessageSendResultNoRelayPath4远端用户没有登录或进房
kUserMessageSendResultExceedQPS5超过 QPS 限制
kUserMessageSendResultE2BSSendFailed17消息发送失败。应用服务器未收到客户端发送的消息。
sendServerMessage/sendServerBinaryMessage 触发,通过 onServerMessageSendResult 回调。
kUserMessageSendResultE2BSReturnFailed18消息发送失败。应用服务器接收到了客户端发送的消息,但响应失败。
sendServerMessage/sendServerBinaryMessage 触发,通过 onServerMessageSendResult 回调。
kUserMessageSendResultNotJoin100消息发送方没有加入房间
kUserMessageSendResultInit101连接未完成初始化,没有可用的数据传输通道连接
kUserMessageSendResultNoConnection102没有可用的数据传输通道连接
kUserMessageSendResultExceedMaxLength103消息超过最大长度,当前为 64 KB
kUserMessageSendResultEmptyUser104接收消息的单个用户 id 为空
kUserMessageSendResultNotLogin105房间外或应用服务器消息发送方没有登录
kUserMessageSendResultServerParamsNotSet106发送消息给业务方服务器之前没有设置参数
kUserMessageSendResultUnknown1000未知错误

SingleStreamPushEvent
enum bytertc::SingleStreamPushEvent

单流转推直播错误码

枚举值

类型说明
kSingleStreamPushEventStart1开始推流。
kSingleStreamPushEventSuccess2推流成功。
kSingleStreamPushEventFailed3推流失败。
kSingleStreamPushEventStop4停止推流。
kSingleStreamPushEventTimeout5单流转推直播任务处理超时,请检查网络状态并重试。
kSingleStreamPushEventParamError6参数错误。

SubtitleErrorCode
enum bytertc::SubtitleErrorCode

字幕任务错误码。

枚举值

类型说明
kSubtitleErrorCodeUnknow-1客户端无法识别云端媒体处理发送的错误码。请联系技术支持。
kSubtitleErrorCodeSuccess0字幕已开启。
kSubtitleErrorCodePostProcessError1云端媒体处理内部出现错误,请联系技术支持。
kSubtitleErrorCodeASRConnectionError2第三方服务连接失败,请联系技术支持。
kSubtitleErrorCodeASRServiceError3第三方服务内部出现错误,请联系技术支持。
kSubtitleErrorCodeBeforeJoinRoom4未进房导致调用startSubtitle失败。请加入房间后再调用此方法。
kSubtitleErrorCodeAlreadyOn5重复调用 startSubtitle
kSubtitleErrorCodeUnsupportedLanguage6用户选择的目标语言目前暂不支持。
kSubtitleErrorCodePostProcessTimeout7云端媒体处理超时未响应,请联系技术支持。

StreamMixingErrorCode
enum bytertc::StreamMixingErrorCode

转推直播错误码

枚举值

类型说明
kStreamMixingErrorCodeOK0推流成功。
kStreamMixingErrorCodeBase1090未定义的合流错误
kStreamMixingErrorCodeInvalidParam1091客户端 SDK 检测到无效推流参数。
kStreamMixingErrorCodeInvalidState1092状态错误,需要在状态机正常状态下发起操作
kStreamMixingErrorCodeInvalidOperator1093无效操作
kStreamMixingErrorCodeTimeout1094转推直播任务处理超时,请检查网络状态并重试
kStreamMixingErrorCodeInvalidParamByServer1095服务端检测到错误的推流参数
kStreamMixingErrorCodeSubTimeoutByServer1096对流的订阅超时
kStreamMixingErrorCodeInvalidStateByServer1097合流服务端内部错误。
kStreamMixingErrorCodeAuthenticationByCDN1098合流服务端推 CDN 失败。
kStreamMixingErrorCodeTimeoutBySignaling1099服务端接收信令超时,请检查网络状态并重试。
kStreamMixingErrorCodeMixImageFail1100图片合流失败。
kStreamMixingErrorCodeUnKnownByServer1101服务端未知错误。

LocalVideoStreamError
enum bytertc::LocalVideoStreamError

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

枚举值

类型说明
kLocalVideoStreamErrorOk0状态正常
kLocalVideoStreamErrorFailure1本地视频流发布失败
kLocalVideoStreamErrorDeviceNoPermission2没有权限启动本地视频采集设备
kLocalVideoStreamErrorDeviceBusy3本地视频采集设备已被占用
kLocalVideoStreamErrorDeviceNotFound4本地视频采集设备不存在
kLocalVideoStreamErrorCaptureFailure5本地视频采集失败,建议检查采集设备是否正常工作
kLocalVideoStreamErrorEncodeFailure6本地视频编码失败
kLocalVideoStreamErrorDeviceDisconnected7通话过程中本地视频采集设备被其他程序抢占,导致设备连接中断

WarningCode
enum bytertc::WarningCode

回调警告码。

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

枚举值

类型说明
kWarningCodeJoinRoomFailed-2001进房失败。通过 onRoomStateChanged 回调。
当你调用初次加入房间或者由于网络状况不佳断网重连时,由于服务器错误导致进房失败。SDK 会自动重试进房。
kWarningCodePublishStreamFailed-2002发布音视频流失败。通过 onStreamStateChanged 回调。
当你在所在房间中发布音视频流时,由于服务器错误导致发布失败。SDK 会自动重试发布。
kWarningCodeSubscribeStreamFailed404-2003订阅音视频流失败。通过 onStreamStateChanged 回调。
当前房间中找不到订阅的音视频流导致订阅失败。SDK 会自动重试订阅,若仍订阅失败则建议你退出重试。
kWarningCodeSubscribeStreamFailed5xx-2004订阅音视频流失败。通过 onStreamStateChanged 回调。
当你订阅所在房间中的音视频流时,由于服务器错误导致订阅失败。SDK 会自动重试订阅。
kWarningCodePublishStreamForbiden-2009当调用 setUserVisibility 将自身可见性设置为 false 后,再尝试发布流会触发此警告。通过 onStreamStateChanged 回调。
kWarningCodeSendCustomMessage-2011发送自定义广播消息失败,当前你未在房间中。
kWarningCodeUserNotifyStop-2013当房间内人数超过 500 人时,停止向房间内已有用户发送 onUserJoinedonUserLeave 回调,并通过广播提示房间内所有用户。通过 onRoomStateChanged 回调。
kWarningCodeUserInPublish-2014用户已经在其他房间发布过流,或者用户正在发布公共流。通过 onStreamStateChanged 回调。
kWarningCodeOldRoomBeenReplaced-2016已存在相同 roomId 的房间,新创建的房间实例已替换旧房间实例。通过 onRoomStateChanged 回调。
kWarningCodeInEchoTestMode-2017当前正在进行回路测试,该接口调用无效
kWarningCodeNoCameraPermission-5001摄像头权限异常,当前应用没有获取摄像头权限。
kWarningCodeNoMicrophonePermission-5002已在 3.33 版本中废弃,使用 MediaDeviceError.kMediaDeviceErrorDeviceNoPermission 代替。
麦克风权限异常,当前应用没有获取麦克风权限。
kWarningCodeRecodingDeviceStartFailed-5003已在 3.33 版本中废弃,使用 MediaDeviceError.kMediaDeviceErrorDeviceFailure 代替。
音频采集设备启动失败,当前设备可能被其他应用占用。
kWarningCodePlayoutDeviceStartFailed-5004已在 3.33 版本中废弃,使用 use MediaDeviceError.kMediaDeviceErrorDeviceFailure 代替。
音频播放设备启动失败警告,可能由于系统资源不足,或参数错误。
kWarningCodeNoRecordingDevice-5005已在 3.33 版本中废弃,使用 MediaDeviceError.kMediaDeviceErrorDeviceNotFound 代替。
无可用音频采集设备,请插入可用的音频采集设备。
kWarningCodeNoPlayoutDevice-5006已在 3.33 版本中废弃,使用 MediaDeviceError.kMediaDeviceErrorDeviceNotFound 代替。
无可用音频播放设备,请插入可用的音频播放设备。
kWarningCodeRecordingSilence-5007已在 3.33 版本中废弃,使用 MediaDeviceWarning.kMediaDeviceWarningCaptureSilence 代替。
当前音频设备没有采集到有效的声音数据,请检查更换音频采集设备。
kWarningCodeMediaDeviceOperationDenied-5008已在 3.33 版本中废弃,使用 MediaDeviceWarning.kMediaDeviceWarningOperationDenied 代替。
媒体设备误操作警告。
使用自定义采集时,不可调用内部采集开关,调用时将触发此警告。
kWarningCodeSetScreenAudioSourceTypeFailed-5009不支持在 publishScreen 之后调用 setScreenAudioSourceType 设置屏幕音频采集类型,请在 publishScreen 之前设置
kWarningCodeSetScreenAudioStreamIndexFailed-5010不支持在 publishScreen 之后, 通过 setScreenAudioStreamIndex 设置屏幕共享时的音频采集方式。
kWarningCodeInvalidVoicePitch-5011设置语音音高不合法
kWarningCodeInvalidAudioFormat-5012设置音频格式不合法
kWarningCodeInvalidCallForExtAudio-5013外部音频源新旧接口混用
kWarningCodeInvalidRemoteStreamKey-5014非法的远端流索引
kWarningCodeInvalidCanvasHandle-6001指定的内部渲染画布句柄无效。
当你调用 setLocalVideoCanvas 时指定了无效的画布句柄,触发此回调。
kWarningLicenseFileExpired-7001鉴权文件失效,当检查鉴权文件状态时,本地文件与远端文件不一致会触发次警告。通过 onRoomStateChanged 回调。
kWarningInvaildSamiAppkeyORToken-7002音频技术 SDK 鉴权失效。联系技术支持人员。
kWarningInvaildSamiResourcePath-7003音频技术 资源加载失败。传入正确的 DAT 路径,或联系技术支持人员。
kWarningLoadSamiLibraryFailed-7004音频技术 库加载失败。使用正确的库,或联系技术支持人员。
kWarningInvaildSamiEffectType-7005音频技术 不支持此音效。联系技术支持人员。
[deprecated] kWarningCodeGetRoomFailed-2000Deprecated since 3.45 and will be deleted in 3.51.
[deprecated] kWarningCodeSubscribeStreamForbiden-2010Deprecated since 3.45 and will be deleted in 3.51.
自动订阅模式未关闭时,尝试开启手动订阅模式会触发此警告。
你需在进房前关闭自动订阅模式,再调用 subscribeStream 方法手动订阅音视频流。

LoginErrorCode
enum bytertc::LoginErrorCode

登录结果

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

枚举值

类型说明
kLoginErrorCodeSuccess0调用 login 方法登录成功
kLoginErrorCodeInvalidToken-1000调用 login 方法时使用的 Token 无效或过期失效,需要用户重新获取 Token。
kLoginErrorCodeLoginFailed-1001登录错误
调用 login 方法时发生未知错误导致登录失败,需要重新登录。
kLoginErrorCodeInvalidUserId-1002调用 login 方法时传入的用户 ID 有问题。
kLoginErrorCodeServerError-1003调用 login 登录时服务端出错。

RtsWarningCode
enum bytertc::RtsWarningCode

回调警告码。

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

枚举值

类型说明
kRtsWarningCodeJoinRoomFailed-2001进房失败。
当你调用初次加入房间或者由于网络状况不佳断网重连时,由于服务器错误导致进房失败。SDK 会自动重试进房。
kRtsWarningCodePublishStreamFailed-2002发布音视频流失败。
当你在所在房间中发布音视频流时,由于服务器错误导致发布失败。SDK 会自动重试发布。
kRtsWarningCodeSendCustomMessage-2011发送自定义广播消息失败,当前你未在房间中。
kRtsWarningCodeUserNotifyStop-2013当房间内人数超过 500 人时,停止向房间内已有用户发送 onUserJoinedonUserLeave 回调,并通过广播提示房间内所有用户。
kRtsWarningCodeOldRoomBeenReplaced-2016新生成的房间已经替换了同样 roomId 的旧房间

NetworkDetectionStartReturn
enum bytertc::NetworkDetectionStartReturn

开始探测的返回值

startNetworkDetection 返回对象类型

枚举值

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

ErrorCode
enum bytertc::ErrorCode

回调错误码。

枚举值

类型说明
kErrorCodeInvalidToken-1000Token 无效。通过 onRoomStateChanged 回调。
调用 joinRoom 进房时使用的 Token 参数有误或过期失效。需要重新获取 Token,并调用 updateToken 方法更新 Token。
kErrorCodeJoinRoom-1001加入房间错误。通过 onRoomStateChanged 回调。
进房时发生未知错误导致加入房间失败。需要用户重新加入房间。
kErrorCodeNoPublishPermission-1002没有发布音视频流权限。通过 onStreamStateChanged 回调。
用户在所在房间中发布音视频流失败,失败原因为用户没有发布流的权限。
kErrorCodeNoSubscribePermission-1003没有订阅音视频流权限。通过 onStreamStateChanged 回调。
用户订阅所在房间中的音视频流失败,失败原因为用户没有订阅流的权限。
kErrorCodeDuplicateLogin-1004相同用户 ID 的用户加入本房间,当前用户被踢出房间。通过 onRoomStateChanged 回调。
kErrorCodeKickedOut-1006服务端调用 OpenAPI 将当前用户踢出房间。通过 onRoomStateChanged 回调。
kRoomErrorCodeRoomIdIllegal-1007当调用 createRTCRoom ,如果 roomid 非法,会返回 null,并抛出该 error。通过 onCreateRoomStateChanged 回调。
kRoomErrorTokenExpired-1009Token 过期。加入房间后 Token 过期时,返回此错误码。需使用新的 Token 重新加入房间。通过 onRoomStateChanged 回调。
kRoomErrorUpdateTokenWithInvalidToken-1010调用 updateToken 传入的 Token 无效。通过 onRoomStateChanged 回调。
kErrorCodeRoomDismiss-1011服务端调用 OpenAPI 解散房间,所有用户被移出房间。通过 onRoomStateChanged 回调。
kErrorCodeRoomAlreadyExist-1013通话回路检测已经存在同样 roomId 的房间了。通过 onCreateRoomStateChanged 回调。
kErrorCodeUserIDDifferent-1014加入多个房间时使用了不同的 uid。通过 onRoomStateChanged 回调。
同一个引擎实例中,用户需使用同一个 uid 加入不同的房间。
kErrorCodeJoinRoomRoomForbidden-1025房间被封禁。通过 onRoomStateChanged 回调。
kErrorCodeJoinRoomUserForbidden-1026用户被封禁。通过 onRoomStateChanged 回调。
kErrorCodeOverStreamSubscribeLimit-1070订阅音视频流失败,订阅音视频流总数超过上限。通过 onStreamStateChanged 回调。
游戏场景下,为了保证音视频通话的性能和质量,服务器会限制用户订阅的音视频流总数。当用户订阅的音视频流总数已达上限时,继续订阅更多流时会失败,同时用户会收到此错误通知。
kErrorCodeOverStreamPublishLimit-1080发布流失败,发布流总数超过上限。通过 onStreamStateChanged 回调。
RTC 系统会限制单个房间内发布的总流数,总流数包括视频流、音频流和屏幕流。如果房间内发布流数已达上限时,本地用户再向房间中发布流时会失败,同时会收到此错误通知。
kErrorCodeInvalidAudioSyncUidRepeated-1083音视频同步失败。通过 onStreamStateChanged 回调。
当前音频源已与其他视频源关联同步关系。
单个音频源不支持与多个视频源同时同步。
kErrorCodeAbnormalServerStatus-1084服务端异常状态导致退出房间。通过 onRoomStateChanged 回调。
SDK 与信令服务器断开,并不再自动重连,可联系技术支持。
[deprecated] kErrorCodeOverScreenPublishLimit-1081Deprecated since 3.52, use kErrorCodeOverStreamPublishLimit(-1080)instead
发布屏幕流失败,发布流总数超过上限。通过 onRoomStateChanged 回调。
RTC 系统会限制单个房间内发布的总流数,总流数包括视频流、音频流和屏幕流。如果房间内发布流数已达上限时,本地用户再向房间中发布流时会失败,同时会收到此错误通知。
[deprecated] kErrorCodeOverVideoPublishLimit-1082Deprecated since 3.52, use kErrorCodeOverStreamPublishLimit(-1080)instead
发布视频流总数超过上限。通过 onRoomStateChanged 回调。
RTC 系统会限制单个房间内发布的视频流数。如果房间内发布视频流数已达上限时,本地用户再向房间中发布视频流时会失败,同时会收到此错误通知。

PublicStreamErrorCode
enum bytertc::PublicStreamErrorCode

公共流状态码

枚举值

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

AudioRecordingErrorCode
enum bytertc::AudioRecordingErrorCode

音频文件录制的错误码

枚举值

类型说明
kAudioRecordingErrorCodeOk0录制正常
kAudioRecordingErrorCodeNoPermission-1没有文件写权限
kAudioRecordingErrorCodeNotInRoom-2没有进入房间
kAudioRecordingErrorCodeAlreadyStarted-3录制已经开始
kAudioRecordingErrorCodeNotStarted-4录制还未开始
kAudioRecordingErrorCodeNotSupport-5录制失败。文件格式不支持。
kAudioRecordingErrorCodeOther-6其他异常

RtsErrorCode
enum bytertc::RtsErrorCode

回调错误码。

枚举值

类型说明
kRtsErrorCodeInvalidToken-1000Token 无效。
进房时使用的 Token 无效或过期失效。需要用户重新获取 Token,并调用 updateToken 方法更新 Token。
kRtsErrorCodeJoinRoom-1001加入房间错误。
进房时发生未知错误导致加入房间失败。需要用户重新加入房间。
kRtsErrorCodeDuplicateLogin-1004相同用户 ID 的用户加入本房间,当前用户被踢出房间
kRtsErrorCodeKickedOut-1006服务端调用 OpenAPI 将当前用户踢出房间
kRtsRoomErrorCodeRoomIdIllegal-1007当调用 createRTCRoom ,如果 roomid 非法,会返回 null,并抛出该 error
kRtsRoomErrorTokenExpired-1009Token 过期。调用 joinRoom 使用新的 Token 重新加入房间。
kRtsRoomErrorUpdateTokenWithInvalidToken-1010调用 updateToken 传入的 Token 无效
kRtsErrorCodeRoomDismiss-1011服务端调用 OpenAPI 解散房间,所有用户被移出房间。
kRtsErrorCodeRoomAlreadyExist-1013通话回路检测已经存在同样 roomId 的房间了
kRtsErrorCodeUserIDDifferent-1014同一个引擎实例在进入多个房间时设置的用户名必须相同
kRtsErrorCodeAbnormalServerStatus-1084服务端异常状态导致退出房间。
SDK 与信令服务器断开,并不再自动重连,可联系技术支持。