文档中心

实时音视频

Electron 3.60.1

错误码

UserVisibilityChangeError

类型：enum
说明：用户可见性状态改变错误码。
成员
属性值描述
kUserVisibilityChangeErrorOk 0 成功。
kUserVisibilityChangeErrorUnknown 1 未知错误。
kUserVisibilityChangeErrorTooManyVisibleUser 2 房间内可见用户达到上限。

属性	值	描述
kUserVisibilityChangeErrorOk	`0`	成功。
kUserVisibilityChangeErrorUnknown	`1`	未知错误。
kUserVisibilityChangeErrorTooManyVisibleUser	`2`	房间内可见用户达到上限。

ForwardStreamError

类型：enum
说明：媒体流跨房间转发过程中抛出的错误码。

成员

属性	值	描述
kForwardStreamErrorOK	`0`	正常。
kForwardStreamErrorInvalidArgument	`1201`	参数异常。
kForwardStreamErrorInvalidToken	`1202`	token 错误。
kForwardStreamErrorResponse	`1203`	服务端异常。
kForwardStreamErrorRemoteKicked	`1204`	目标房间有相同 user id 的用户加入，转发中断。
kForwardStreamErrorNotSupport	`1205`	服务端不支持转发功能。

SubtitleErrorCode

类型：enum
说明：字幕任务错误码。

成员

属性	值	描述
kSubtitleErrorCodeUnknow	`-1`	客户端无法识别云端媒体处理发送的错误码。请联系技术支持。
kSubtitleErrorCodeSuccess	`0`	字幕已开启。
kSubtitleErrorCodePostProcessError	`1`	云端媒体处理内部出现错误，请联系技术支持。
kSubtitleErrorCodeASRConnectionError	`2`	第三方服务连接失败，请联系技术支持。
kSubtitleErrorCodeASRServiceError	`3`	第三方服务内部出现错误，请联系技术支持。
kSubtitleErrorCodeBeforeJoinRoom	`4`	未进房导致调用startSubtitle失败。请加入房间后再调用此方法。
kSubtitleErrorCodeAlreadyOn	`5`	重复调用 startSubtitle。
kSubtitleErrorCodeUnsupportedLanguage	`6`	用户选择的目标语言目前暂不支持。
kSubtitleErrorCodePostProcessTimeout	`7`	云端媒体处理超时未响应，请联系技术支持。

AudioRecordingErrorCode

类型：enum
说明：音频文件录制的错误码。

成员

属性	值	描述
kAudioRecordingErrorCodeOk	`0`	录制正常。
kAudioRecordingErrorCodeNoPermission	`-1`	没有文件写权限。
kAudioRecordingErrorCodeNotInRoom	`-2`	没有进入房间。
kAudioRecordingErrorCodeAlreadyStarted	`-3`	录制已经开始。
kAudioRecordingErrorCodeNotStarted	`-4`	录制还未开始。
kAudioRecordingErrorCodeNotSupport	`-5`	录制失败。文件格式不支持。
kAudioRecordingErrorCodeOther	`-6`	其他异常。

LocalProxyError

类型：enum
说明：本地代理错误信息。

成员

属性	值	描述
kLocalProxyErrorOK	`0`	代理无错误。
kLocalProxyErrorSocks5VersionError	`1`	代理服务器回复的版本号错误，导致 socks5 连接失败。
kLocalProxyErrorSocks5FormatError	`2`	代理服务器回复的格式错误，导致 socks5 连接失败。
kLocalProxyErrorSocks5InvalidValue	`3`	代理服务器回复的字段值错误，导致 socks5 连接失败。
kLocalProxyErrorSocks5UserPassNotGiven	`4`	未提供本地代理的用户名及密码，导致 socks5 连接失败。
kLocalProxyErrorSocks5TcpClosed	`5`	TCP 关闭，导致 socks5 连接失败。
kLocalProxyErrorHttpTunnelFailed	`6`	http隧道代理错误。

MixedStreamTaskErrorCode

类型：enum
说明：合流转推任务错误码。

成员

属性	值	描述
kMixedStreamTaskErrorCodeOK	`0`	推流成功。
kMixedStreamTaskErrorCodeTimeout	`1091`	任务处理超时，请检查网络状态并重试。
kMixedStreamTaskErrorCodeInvalidParamByServer	`1092`	服务端检测到错误的推流参数。
kMixedStreamTaskErrorCodeSubTimeoutByServer	`1093`	对流的订阅超时。
kMixedStreamTaskErrorCodeInvalidStateByServer	`1094`	合流服务端内部错误。
kMixedStreamTaskErrorCodeAuthenticationByCDN	`1095`	合流服务端推 CDN 失败。
kMixedStreamTaskErrorCodeUnKnownByServer	`1096`	服务端未知错误。
kMixedStreamTaskErrorCodeSignalRequestTimeout	`1097`	服务端接收信令超时，请检查网络状态并重试。
kMixedStreamTaskErrorCodeMixImageFailed	`1098`	图片合流失败。
kMixedStreamTaskErrorCodePushWTNFailed	`1195`	发布 WTN 流失败。

WarningCode

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

成员

属性	值	描述
kWarningCodeJoinRoomFailed	`-2001`	进房失败。当你调用初次加入房间或者由于网络状况不佳断网重连时，由于服务器错误导致进房失败。SDK 会自动重试进房。
kWarningCodePublishStreamFailed	`-2002`	发布音视频流失败。当你在所在房间中发布音视频流时，由于服务器错误导致发布失败。SDK 会自动重试发布。
kWarningCodeSubscribeStreamFailed404	`-2003`	订阅音视频流失败。当前房间中找不到订阅的音视频流导致订阅失败。SDK 会自动重试订阅，若仍订阅失败则建议你退出重试。
kWarningCodeSubscribeStreamFailed5xx	`-2004`	订阅音视频流失败。当你订阅所在房间中的音视频流时，由于服务器错误导致订阅失败。SDK 会自动重试订阅。
kWarningCodePublishStreamForbidden	`-2009`	当调用 `setUserVisibility` 将自身可见性设置为 false 后，再尝试发布流会触发此警告。
kWarningCodeSubscribeStreamForbidden	`-2010`	自动订阅模式未关闭时，尝试开启手动订阅模式会触发此警告。你需在进房前关闭自动订阅模式，再调用 subscribeStreamVideo/subscribeStreamAudio 方法手动订阅音视频流。
kWarningCodeSendCustomMessage	`-2011`	发送自定义广播消息失败，当前你未在房间中。
kWarningCodeUserNotifyStop	`-2013`	当房间内人数超过 500 人时，停止向房间内已有用户发送 onUserJoined 和 onUserLeave 回调，并通过广播提示房间内所有用户。
kWarningCodeUserInPublish	`-2014`	用户已经在其他房间发布过流，或者用户正在发布公共流。
kWarningCodeOldRoomBeenReplaced	`-2016`	新生成的房间已经替换了同样roomId的旧房间。
kWarningCodeInEchoTestMode	`-2017`	当前正在进行回路测试，该接口调用无效。
kWarningCodeNoCameraPermission	`-5001`	摄像头权限异常，当前应用没有获取摄像头权限。
kWarningCodeSetScreenAudioSourceTypeFailed	`-5009`	不支持在屏幕音频发布之后设置屏幕音频采集类型 setScreenAudioSourceType，请在发布之前设置。
kWarningCodeSetScreenAudioStreamIndexFailed	`-5010`	不支持在屏幕音频发布之后设置屏幕共享时的音频采集方式。
kWarningCodeInvalidVoicePitch	`-5011`	设置语音音高不合法。
kWarningCodeInvalidAudioFormat	`-5012`	设置音频格式不合法。
kWarningCodeInvalidCallForExtAudio	`-5013`	外部音频源新旧接口混用。
kWarningCodeInvalidCanvasHandle	`-6001`	指定的内部渲染画布句柄无效。当你调用 setupLocalVideo 或 setupRemoteVideo 时指定了无效的画布句柄，触发此回调。
kWarningLicenseFileExpired	`-7001`	鉴权文件失效，当检查鉴权文件状态时，本地文件与远端文件不一致会触发此警告。
kWarningInvaildSamiAppkeyORToken	`-7002`	音频技术 SDK 鉴权失效。联系技术支持人员。
kWarningInvaildSamiResourcePath	`-7003`	音频技术资源加载失败。传入正确的 DAT 路径，或联系技术支持人员。
kWarningLoadSamiLibraryFailed	`-7004`	音频技术库加载失败。使用正确的库，或联系技术支持人员。
kWarningInvaildSamiEffectType	`-7005`	音频技术不支持此音效。联系技术支持人员。

ErrorCode

类型：enum
说明：回调错误码。SDK 内部遇到不可恢复的错误时，会通过 onError 回调通知用户。

成员

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

LocalAudioStreamError

类型：enum
说明：本地音频流状态改变时的错误码。

成员

属性	值	描述
kLocalAudioStreamErrorOk	`0`	本地音频状态正常。
kLocalAudioStreamErrorFailure	`1`	本地音频出错原因未知。
kLocalAudioStreamErrorDeviceNoPermission	`2`	没有权限启动本地音频录制设备。
kLocalAudioStreamErrorRecordFailure	`4`	本地音频录制失败，建议你检查录制设备是否正常工作。
kLocalAudioStreamErrorEncodeFailure	`5`	本地音频编码失败。
kLocalAudioStreamErrorNoRecordingDevice	`6`	没有可用的音频录制设备。

LocalVideoStreamError

类型：enum
说明：本地视频状态改变时的错误码。

成员

属性	值	描述
kLocalVideoStreamErrorOk	`0`	状态正常。
kLocalVideoStreamErrorFailure	`1`	本地视频流发布失败。
kLocalVideoStreamErrorDeviceNoPermission	`2`	没有权限启动本地视频采集设备。
kLocalVideoStreamErrorDeviceBusy	`3`	本地视频采集设备被占用。
kLocalVideoStreamErrorDeviceNotFound	`4`	本地视频采集设备不存在。
kLocalVideoStreamErrorCaptureFailure	`5`	本地视频采集失败，建议检查采集设备是否正常工作。
kLocalVideoStreamErrorEncodeFailure	`6`	本地视频编码失败。
kLocalVideoStreamErrorDeviceDisconnected	`7`	通话过程中本地视频采集设备被其他程序抢占，导致设备连接中断。

MessageSendResultCode

类型：enum
说明：消息发送结果及失败原因。点对点消息发送结果中，0 表示成功；房间广播消息发送结果中，200 表示成功。

成员

属性	值	描述
MESSAGE_CODE_SUCCESS	`0`	用户 P2P 消息发送成功。
MESSAGE_CODE_ROOM_SUCCESS	`200`	房间 Broadcast 消息发送成功。
MESSAGE_CODE_ERROR_TIMEOUT	`1`	发送超时，没有发送。
MESSAGE_CODE_ERROR_BROKEN	`2`	通道断开，没有发送。
MESSAGE_CODE_ERROR_NOT_RECEIVER	`3`	找不到接收方。
MESSAGE_CODE_ERROR_NOT_JOIN	`100`	消息发送方没有加入房间。
MESSAGE_CODE_ERROR_NO_CONNECTION	`102`	没有可用的数据传输通道连接。
MESSAGE_CODE_ERROR_EXCEED_MAX_LENGTH	`103`	消息超过最大长度。默认单条消息最大为 1 KB；启用 RTS 高级功能后，最大为 64 KB。
MESSAGE_CODE_ERROR_EMPTY_USER	`104`	接收消息的单个用户 id 为空。
MESSAGE_CODE_ERROR_UNKNOWN	`1000`	未知错误。

SingleStreamTaskErrorCode

类型：enum
说明：单流转推任务错误码。

成员

属性	值	描述
kSingleStreamTaskErrorCodeOK	`0`	推流成功。
kSingleStreamTaskErrorCodeUnKnownByServer	`1091`	服务端未知错误。
kSingleStreamTaskErrorCodeSignalRequestTimeout	`1092`	任务处理超时，请检查网络状态并重试。
kSingleStreamTaskErrorCodeInvalidParamByServer	`1093`	服务端检测任务参数不合法。
kSingleStreamTaskErrorRemoteKicked	`1094`	转推任务在目标房间的用户 ID 被踢出目标房间。
kSingleStreamTaskErrorCodeJoinDestRoomFailed	`1095`	转推任务加入目标房间失败。
kSingleStreamTaskErrorCodeReceiveSrcStreamTimeout	`1096`	转推任务在源房间拉流超时。
kSingleStreamTaskErrorCodeNotSurportCodec	`1097`	音视频编码转推任务不支持。
kSingleStreamTaskErrorCodePushToCDN	`1098`	推 CDN 失败。
kSingleStreamTaskErrorCodeCountOverLimit	`1099`	超过单流转推的任务数限制，单主播可同时转推的任务数不超过 20。

PlayerError

类型：enum
说明：播放错误码。

成员

属性	值	描述
kPlayerErrorOK	`0`	正常。
kPlayerErrorFormatNotSupport	`1`	不支持此类型。
kPlayerErrorInvalidPath	`2`	无效的播放路径。
kPlayerErrorInvalidState	`3`	未满足前序接口调用的要求。请查看具体接口文档。
kPlayerErrorInvalidPosition	`4`	设置播放位置出错。
kPlayerErrorInvalidVolume	`5`	音量参数不合法。
kPlayerErrorInvalidPitch	`6`	音调参数设置不合法。
kPlayerErrorInvalidAudioTrackIndex	`7`	音轨参数设置不合法。
kPlayerErrorInvalidPlaybackSpeed	`8`	播放速度参数设置不合法。
kPlayerErrorInvalidEffectId	`9`	音效 ID 异常。还未加载或播放文件，就调用其他 API。

SnapshotErrorCode

类型：enum
说明：截图错误码。

成员

属性	值	描述
kSnapshotErrorCodeOk	`0`	截图成功。
kSnapshotErrorCodeCreateFail	`-1`	截图错误。生成图片数据失败或 RGBA 编码失败。
kSnapshotErrorCodeStreamInvalid	`-2`	截图错误。流无效。
kSnapshotErrorCodeTimeout	`-3`	截图错误。截图超时，超时时间 1 秒。
kSnapshotErrorCodeFileSaveError	`-4`	截图错误。图片保存失败。

最近更新时间：2026.10.10 20:45:58

这个页面对您有帮助吗？

有用

无用

实时音视频

UserVisibilityChangeError #

ForwardStreamError #

SubtitleErrorCode #

AudioRecordingErrorCode #

LocalProxyError #

MixedStreamTaskErrorCode #

WarningCode #

ErrorCode #

LocalAudioStreamError #

LocalVideoStreamError #

MessageSendResultCode #

SingleStreamTaskErrorCode #

PlayerError #

SnapshotErrorCode #

UserVisibilityChangeError

ForwardStreamError

SubtitleErrorCode

AudioRecordingErrorCode

LocalProxyError

MixedStreamTaskErrorCode

WarningCode

ErrorCode

LocalAudioStreamError

LocalVideoStreamError

MessageSendResultCode

SingleStreamTaskErrorCode

PlayerError

SnapshotErrorCode