ByteRTCStreamSinglePushEvent

public enum com.ss.bytertc.engine.live.ByteRTCStreamSinglePushEvent
java

单流转推直播错误码

枚举值

类型	说明
SINGLE_STREAM_PUSH_START(1)	开始推流。
SINGLE_STREAM_PUSH_SUCCESS(2)	推流成功。
SINGLE_STREAM_PUSH_FAILED(3)	推流失败。
SINGLE_STREAM_PUSH_STOP(4)	停止推流。
SINGLE_STREAM_PUSH_TIMEOUT(5)	单流转推直播任务处理超时，请检查网络状态并重试。
SINGLE_STREAM_PUSH_PARAM_ERROR(6)	参数错误。

ByteRTCTranscoderErrorCode

public enum com.ss.bytertc.engine.live.ByteRTCTranscoderErrorCode
java

转推直播错误码

枚举值

类型	说明
TRANSCODER_ERROR_OK(0)	推流成功。
TRANSCODER_ERROR_BASE(1090)	未定义的合流错误
TRANSCODER_ERROR_INVALID_PARAM(1091)	客户端 SDK 检测到无效推流参数。
TRANSCODER_ERROR_INVALID_STATE(1092)	状态错误，需要在状态机正常状态下发起操作
TRANSCODER_ERROR_INVALID_OPERATOR(1093)	无效操作
TRANSCODER_ERROR_TIMEOUT(1094)	转推直播任务处理超时，请检查网络状态并重试
TRANSCODER_ERROR_INVALID_PARAM_BY_SERVER(1095)	服务端检测到错误的推流参数
TRANSCODER_ERROR_SUB_TIMEOUT_BY_SERVER(1096)	对流的订阅超时
TRANSCODER_ERROR_INVALID_STATE_BY_SERVER(1097)	合流服务端内部错误。
TRANSCODER_ERROR_AUTHENTICATION_BY_CDN(1098)	合流服务端推 CDN 失败。
TRANSCODER_ERROR_TIMEOUT_BY_SIGNALING(1099)	服务端接收信令超时，请检查网络状态并重试。
TRANSCODER_ERROR_MIX_IMAGE_FAIL(1100)	图片合流失败。
TRANSCODER_ERROR_UNKNOW_ERROR_BY_SERVER(1101)	服务端未知错误。

成员函数

返回	名称
ByteRTCTranscoderErrorCode	ByteRTCTranscoderErrorCode

函数说明

ByteRTCTranscoderErrorCode

com.ss.bytertc.engine.live.ByteRTCTranscoderErrorCode.ByteRTCTranscoderErrorCode(
    int value)
java

AudioRecordingErrorCode

public enum com.ss.bytertc.engine.type.AudioRecordingErrorCode
java

音频文件录制的错误码

枚举值

类型	说明
AUDIO_RECORDING_ERROR_CODE_OK(0)	录制正常
AUDIO_RECORDING_ERROR_CODE_NO_PERMISSION(-1)	没有文件写权限
AUDIO_RECORDING_ERROR_CODE_NOT_IN_ROOM(-2)	没有进入房间
AUDIO_RECORDING_ERROR_CODE_ALREADY_STARTED(-3)	录制已经开始
AUDIO_RECORDING_ERROR_CODE_NOT_STARTED(-4)	录制还未开始
AUDIO_RECORDING_ERROR_CODE_NOT_SUPPORT(-5)	录制失败。文件格式不支持。
AUDIO_RECORDING_ERROR_CODE_OTHER(-6)	其他异常

ErrorCode

public class com.ss.bytertc.engine.type.ErrorCode
java

回调错误码。

成员变量

类型	名称
int	ERROR_CODE_INVALID_TOKEN
int	ERROR_CODE_JOIN_ROOM
int	ERROR_CODE_NO_PUBLISH_PERMISSION
int	ERROR_CODE_NO_SUBSCRIBE_PERMISSION
int	ERROR_CODE_DUPLICATE_LOGIN
int	ERROR_CODE_APP_ID_NULL
int	ERROR_CODE_KICKED_OUT
int	ERROR_CODE_ROOM_ID_ILLEGAL
int	ERROR_CODE_TOKEN_EXPIRED
int	ERROR_CODE_UPDATE_TOKEN_WITH_INVALID_TOKEN
int	ERROR_CODE_ROOM_DISMISS
int	ERROR_CODE_JOIN_ROOM_WITHOUT_LICENSE_AUTHENTICATE_SDK
int	ERROR_CODE_ROOM_ALREADY_EXIST
int	ERROR_CODE_USER_ID_DIFFERENT
int	ERROR_CODE_SERVER_LICENSE_EXPIRE
int	ERROR_CODE_EXCEEDS_THE_UPPER_LIMIT
int	ERROR_CODE_LICENSE_PARAMETER_ERROR
int	ERROR_CODE_LICENSE_FILE_PATH_ERROR
int	ERROR_CODE_LICENSE_ILLEGAL
int	ERROR_CODE_LICENSE_EXPIRED
int	ERROR_CODE_LICENSE_INFORMATION_NOT_MATCH
int	ERROR_CODE_LICENSE_NOT_MATCH_WITH_CACHE
int	ERROR_CODE_JOIN_ROOM_ROOM_FORBIDDEN
int	ERROR_CODE_JOIN_ROOM_USER_FORBIDDEN
int	ERROR_CODE_JOIN_ROOM_LICENSE_FUNCTION_NOT_FOUND
int	ERROR_CODE_OVER_SUBSCRIBE_LIMIT
int	ERROR_CODE_OVER_STREAM_PUBLISH_LIMIT
int	ERROR_CODE_INVALID_AUDIO_SYNC_USERID_REPEATED
int	ERROR_CODE_ABNORMAL_SERVER_STATUS
int	[deprecated] ERROR_CODE_OVER_SCREEN_PUBLISH_LIMIT
int	[deprecated] ERROR_CODE_OVER_VIDEO_PUBLISH_LIMIT

变量说明

ERROR_CODE_INVALID_TOKEN

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_INVALID_TOKEN = -1000;
java

Token 无效。通过 onRoomStateChanged 回调。
进房时使用的 Token 无效或过期失效。需要用户重新获取 Token，并调用 updateToken 方法更新 Token。

ERROR_CODE_JOIN_ROOM

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_JOIN_ROOM = -1001;
java

加入房间错误。通过 onRoomStateChanged 回调。
进房时发生未知错误导致加入房间失败。需要用户重新加入房间。

ERROR_CODE_NO_PUBLISH_PERMISSION

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_NO_PUBLISH_PERMISSION = -1002;
java

没有发布音视频流权限。通过 onStreamStateChanged 回调。
用户在所在房间中发布音视频流失败，失败原因为用户没有发布流的权限。

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_NO_SUBSCRIBE_PERMISSION = -1003;
java

没有订阅音视频流权限。通过 onStreamStateChanged 回调。
用户订阅所在房间中的音视频流失败，失败原因为用户没有订阅流的权限。

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_DUPLICATE_LOGIN = -1004;
java

相同用户 ID 的用户加入本房间，当前用户被踢出房间。通过 onRoomStateChanged 回调。

ERROR_CODE_APP_ID_NULL

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_APP_ID_NULL = -1005;
java

App ID 参数异常。
创建引擎时传入的 App ID 参数为空。

ERROR_CODE_KICKED_OUT

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_KICKED_OUT = -1006;
java

服务端调用 OpenAPI 将当前用户踢出房间。通过 onRoomStateChanged 回调。

ERROR_CODE_ROOM_ID_ILLEGAL

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_ROOM_ID_ILLEGAL = -1007;
java

当调用 createRoom ，如果 roomId 非法，会返回 null，并抛出该错误。通过 onCreateRoomStateChanged 回调。

ERROR_CODE_TOKEN_EXPIRED

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_TOKEN_EXPIRED = -1009;
java

Token 过期。调用 joinRoom 使用新的 Token 重新加入房间。通过 onRoomStateChanged 回调。

ERROR_CODE_UPDATE_TOKEN_WITH_INVALID_TOKEN

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_UPDATE_TOKEN_WITH_INVALID_TOKEN = -1010;
java

调用 updateToken 传入的 Token 无效。通过 onRoomStateChanged 回调。

ERROR_CODE_ROOM_DISMISS

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_ROOM_DISMISS = -1011;
java

服务端调用 OpenAPI 解散房间，所有用户被移出房间。通过 onRoomStateChanged 回调。

ERROR_CODE_JOIN_ROOM_WITHOUT_LICENSE_AUTHENTICATE_SDK

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_JOIN_ROOM_WITHOUT_LICENSE_AUTHENTICATE_SDK = -1012;
java

加入房间错误。

调用 joinRoom 方法时, LICENSE 计费账号未使用 LICENSE_AUTHENTICATE SDK，加入房间错误。通过 onRoomStateChanged 回调。

ERROR_CODE_ROOM_ALREADY_EXIST

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_ROOM_ALREADY_EXIST = -1013;
java

通话回路检测已经存在同样 roomId 的房间了。通过 onCreateRoomStateChanged 回调。

ERROR_CODE_USER_ID_DIFFERENT

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_USER_ID_DIFFERENT = -1014;
java

加入多个房间时使用了不同的 uid。通过 onRoomStateChanged 回调。
同一个引擎实例中，用户需使用同一个 uid 加入不同的房间。

ERROR_CODE_SERVER_LICENSE_EXPIRE

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_SERVER_LICENSE_EXPIRE = -1017;
java

服务端license过期，拒绝进房。通过 onRoomStateChanged 回调。

ERROR_CODE_EXCEEDS_THE_UPPER_LIMIT

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_EXCEEDS_THE_UPPER_LIMIT = -1018;
java

超过服务端license许可的并发量上限，拒绝进房。通过 onRoomStateChanged 回调。

ERROR_CODE_LICENSE_PARAMETER_ERROR

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_LICENSE_PARAMETER_ERROR = -1019;
java

license参数错误，拒绝进房。通过 onRoomStateChanged 回调。

ERROR_CODE_LICENSE_FILE_PATH_ERROR

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_LICENSE_FILE_PATH_ERROR = -1020;
java

license证书路径错误。通过 onRoomStateChanged 回调。

ERROR_CODE_LICENSE_ILLEGAL

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_LICENSE_ILLEGAL = -1021;
java

license证书不合法。通过 onRoomStateChanged 回调。

ERROR_CODE_LICENSE_EXPIRED

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_LICENSE_EXPIRED = -1022;
java

license证书已经过期，拒绝进房。通过 onRoomStateChanged 回调。

ERROR_CODE_LICENSE_INFORMATION_NOT_MATCH

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_LICENSE_INFORMATION_NOT_MATCH = -1023;
java

license证书内容不匹配。通过 onRoomStateChanged 回调。

ERROR_CODE_LICENSE_NOT_MATCH_WITH_CACHE

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_LICENSE_NOT_MATCH_WITH_CACHE=-1024;
java

license当前证书与缓存证书不匹配。通过 onRoomStateChanged 回调。

ERROR_CODE_JOIN_ROOM_ROOM_FORBIDDEN

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_JOIN_ROOM_ROOM_FORBIDDEN = -1025;
java

房间被封禁。通过 onRoomStateChanged 回调。

ERROR_CODE_JOIN_ROOM_USER_FORBIDDEN

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_JOIN_ROOM_USER_FORBIDDEN = -1026;
java

用户被封禁。通过 onRoomStateChanged 回调。

ERROR_CODE_JOIN_ROOM_LICENSE_FUNCTION_NOT_FOUND

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_JOIN_ROOM_LICENSE_FUNCTION_NOT_FOUND = -1027;
java

license 计费方法没有加载成功。可能是因为 license 相关插件未正确集成。通过 onRoomStateChanged 回调。

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_OVER_SUBSCRIBE_LIMIT = -1070;
java

订阅音视频流失败，订阅音视频流总数超过上限。通过 onStreamStateChanged 回调。
游戏场景下为了保证音视频通话的性能和质量，服务器会限制用户订阅的音视频流的总数。当用户订阅的音视频流总数已达上限时，继续订阅更多流时会失败，同时用户会收到此错误通知。

ERROR_CODE_OVER_STREAM_PUBLISH_LIMIT

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_OVER_STREAM_PUBLISH_LIMIT = -1080;
java

发布流失败，发布流总数超过上限。通过 onStreamStateChanged 回调。
RTC 系统会限制单个房间内发布的总流数，总流数包括视频流、音频流和屏幕流。如果房间内发布流数已达上限时，本地用户再向房间中发布流时会失败，同时会收到此错误通知。

ERROR_CODE_OVER_SCREEN_PUBLISH_LIMIT

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_OVER_SCREEN_PUBLISH_LIMIT = -1081;
java

发布屏幕流失败，发布流总数超过上限。
RTC 系统会限制单个房间内发布的总流数，总流数包括视频流、音频流和屏幕流。如果房间内发布流数已达上限时，本地用户再向房间中发布流时会失败，同时会收到此错误通知。

Deprecated since 3.52, use ERROR_CODE_OVER_STREAM_PUBLISH_LIMIT(-1080) instead

ERROR_CODE_OVER_VIDEO_PUBLISH_LIMIT

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_OVER_VIDEO_PUBLISH_LIMIT = -1082;
java

发布视频流总数超过上限。
RTC 系统会限制单个房间内发布的视频流数。如果房间内发布视频流数已达上限时，本地用户再向房间中发布视频流时会失败，同时会收到此错误通知。

Deprecated since 3.52, use ERROR_CODE_OVER_STREAM_PUBLISH_LIMIT(-1080) instead

ERROR_CODE_INVALID_AUDIO_SYNC_USERID_REPEATED

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_INVALID_AUDIO_SYNC_USERID_REPEATED = -1083;
java

音视频同步失败。通过 onStreamStateChanged 回调。
当前音频源已与其他视频源关联同步关系。

单个音频源不支持与多个视频源同时同步。

ERROR_CODE_ABNORMAL_SERVER_STATUS

public static final int com.ss.bytertc.engine.type.ErrorCode.ERROR_CODE_ABNORMAL_SERVER_STATUS = -1084;
java

服务端异常状态导致退出房间。通过 onRoomStateChanged 回调。
SDK与信令服务器断开，并不再自动重连，可联系技术支持。

LoginErrorCode

public class com.ss.bytertc.engine.type.LoginErrorCode
java

登录结果

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

成员变量

类型	名称
int	LOGIN_ERROR_CODE_SUCCESS
int	LOGIN_ERROR_CODE_INVALID_TOKEN
int	LOGIN_ERROR_CODE_LOGIN_FAILED
int	LOGIN_ERROR_CODE_INVALID_USER_ID
int	LOGIN_ERROR_CODE_SERVER_ERROR

变量说明

public static final int com.ss.bytertc.engine.type.LoginErrorCode.LOGIN_ERROR_CODE_SUCCESS = 0;
java

调用 login 方法登录成功。

public static final int com.ss.bytertc.engine.type.LoginErrorCode.LOGIN_ERROR_CODE_INVALID_TOKEN = -1000;
java

调用 login 方法时使用的 Token 无效或过期失效。需要用户重新获取 Token。

public static final int com.ss.bytertc.engine.type.LoginErrorCode.LOGIN_ERROR_CODE_LOGIN_FAILED = -1001;
java

登录错误。

调用 login 方法时发生未知错误导致登录失败，需要重新登录。

public static final int com.ss.bytertc.engine.type.LoginErrorCode.LOGIN_ERROR_CODE_INVALID_USER_ID = -1002;
java

调用 login 方法时传入的用户 ID 有问题。

public static final int com.ss.bytertc.engine.type.LoginErrorCode.LOGIN_ERROR_CODE_SERVER_ERROR = -1003;
java

调用 login 登录时服务器错误。

NetworkDetectionStartReturn

public enum com.ss.bytertc.engine.type.NetworkDetectionStartReturn
java

开始探测的返回值。

startNetworkDetection 返回对象类型

枚举值

类型	说明
NetworkDetectionStartReturnSuccess (0)	成功开启网络探测。
NetworkDetectionStartReturnParamErr (1)	开始探测失败。参数错误，上下行探测均为 `false`，或期望带宽超过了范围 [100,10000]
NetworkDetectionStartReturnStreaming (2)	开始探测失败。失败原因为，本地已经开始推拉流
NetworkDetectionStartReturnStarted (3)	已经开始探测，无需重复开启
NetworkDetectionStartReturnNotSupport (4)	不支持该功能

PublicStreamErrorCode

public enum com.ss.bytertc.engine.type.PublicStreamErrorCode
java

公共流状态码

枚举值

类型	说明
ERROR_CODE_SUCCESS(0)	发布或订阅成功。
ERROR_CODE_PUSH_PARAM_ERROR(1191)	公共流的参数异常，请修改参数后重试。
ERROR_CODE_PUSH_STATE_ERROR(1192)	服务端状态异常，将自动重试。
ERROR_CODE_PUSH_INTERNAL_ERROR(1193)	内部错误，不可恢复，请重试。
ERROR_CODE_PUSH_ERROR(1195)	发布失败，将自动重试，请关注重试结果。
ERROR_CODE_PUSH_TIMEOUT(1196)	发布失败，10 s 后会重试，重试 3 次后自动停止。
ERROR_CODE_PULL_NO_PUSH_STREAM(1300)	订阅失败，发布端未开始发布流。

RoomMessageSendResult

public class com.ss.bytertc.engine.type.RoomMessageSendResult
java

房间内群发消息结果

成员变量

类型	名称
int	ROOM_MESSAGE_SEND_RESULT_SUCCESS
int	ROOM_MESSAGE_SEND_RESULT_EXCEED_QPS
int	ROOM_MESSAGE_SEND_RESULT_NOT_JOIN
int	ROOM_MESSAGE_SEND_RESULT_INIT
int	ROOM_MESSAGE_SEND_RESULT_NO_CONNECTION
int	ROOM_MESSAGE_SEND_RESULT_EXCEED_MAX_LENGTH
int	ROOM_MESSAGE_SEND_RESULT_UNKNOWN

变量说明

ROOM_MESSAGE_SEND_RESULT_SUCCESS

public static final int com.ss.bytertc.engine.type.RoomMessageSendResult.ROOM_MESSAGE_SEND_RESULT_SUCCESS = 200;
java

发送成功

ROOM_MESSAGE_SEND_RESULT_EXCEED_QPS

public static final int com.ss.bytertc.engine.type.RoomMessageSendResult.ROOM_MESSAGE_SEND_RESULT_EXCEED_QPS = 5;
java

超过 QPS 限制

ROOM_MESSAGE_SEND_RESULT_NOT_JOIN

public static final int com.ss.bytertc.engine.type.RoomMessageSendResult.ROOM_MESSAGE_SEND_RESULT_NOT_JOIN = 100;
java

发送失败。消息发送方没有加入房间。

ROOM_MESSAGE_SEND_RESULT_INIT

public static final int com.ss.bytertc.engine.type.RoomMessageSendResult.ROOM_MESSAGE_SEND_RESULT_INIT = 101;
java

发送失败。连接未完成初始化。

ROOM_MESSAGE_SEND_RESULT_NO_CONNECTION

public static final int com.ss.bytertc.engine.type.RoomMessageSendResult.ROOM_MESSAGE_SEND_RESULT_NO_CONNECTION = 102;
java

发送失败。没有可用的数据传输通道连接

ROOM_MESSAGE_SEND_RESULT_EXCEED_MAX_LENGTH

public static final int com.ss.bytertc.engine.type.RoomMessageSendResult.ROOM_MESSAGE_SEND_RESULT_EXCEED_MAX_LENGTH = 103;
java

发送失败。消息超过最大长度 64KB。

ROOM_MESSAGE_SEND_RESULT_UNKNOWN

public static final int com.ss.bytertc.engine.type.RoomMessageSendResult.ROOM_MESSAGE_SEND_RESULT_UNKNOWN = 1000;
java

发送失败。未知错误

SubtitleErrorCode

public enum com.ss.bytertc.engine.type.SubtitleErrorCode
java

字幕任务错误码。

枚举值

类型	说明
SUBTITLE_ERROR_CODE_UNKNOW(-1)	客户端无法识别云端媒体处理发送的错误码。请联系技术支持。
SUBTITLE_ERROR_CODE_SUCCESS(0)	字幕已开启。
SUBTITLE_ERROR_CODE_POST_PROCESS_ERROR(1)	云端媒体处理内部出现错误，请联系技术支持。
SUBTITLE_ERROR_CODE_ASR_CONNECTION_ERROR(2)	第三方服务连接失败，请联系技术支持。
SUBTITLE_ERROR_CODE_ASR_SERVICE_ERROR(3)	第三方服务内部出现错误，请联系技术支持。
SUBTITLE_ERROR_CODE_BEFORE_JOIN_ROOM(4)	未进房导致调用`startSubtitle`失败。请加入房间后再调用此方法。
SUBTITLE_ERROR_CODE_ALREADY_ON(5)	字幕已开启，无需重复调用 `startSubtitle`。
SUBTITLE_ERROR_CODE_UNSUPPORTED_LANGUAGE(6)	你选择的目标语言目前暂不支持。
SUBTITLE_ERROR_CODE_POST_PROCESS_TIMEOUT(7)	云端媒体处理超时未响应，请联系技术支持。

TranscodingError

public class com.ss.bytertc.engine.type.TranscodingError
java

转推直播功能错误码。

成员变量

类型	名称
int	TRANSCODING_ERROR_OK
int	TRANSCODING_ERROR_INVALID_ARGUMENT
int	TRANSCODING_ERROR_SUBSCRIBE
int	TRANSCODING_ERROR_PROCESSING
int	TRANSCODING_ERROR_PUBLISH

变量说明

TRANSCODING_ERROR_OK

public static final int com.ss.bytertc.engine.type.TranscodingError.TRANSCODING_ERROR_OK = 0;
java

推流成功。

TRANSCODING_ERROR_INVALID_ARGUMENT

public static final int com.ss.bytertc.engine.type.TranscodingError.TRANSCODING_ERROR_INVALID_ARGUMENT = 1;
java

推流参数错误。你必须更新合流参数并重试。

public static final int com.ss.bytertc.engine.type.TranscodingError.TRANSCODING_ERROR_SUBSCRIBE = 2;
java

和 RTC 服务端建立连接失败。会自动重连

TRANSCODING_ERROR_PROCESSING

public static final int com.ss.bytertc.engine.type.TranscodingError.TRANSCODING_ERROR_PROCESSING = 3;
java

合流服务中间过程存在错误，建议重试。

TRANSCODING_ERROR_PUBLISH

public static final int com.ss.bytertc.engine.type.TranscodingError.TRANSCODING_ERROR_PUBLISH = 4;
java

推流失败，可以等待服务端重新推流。

UserMessageSendResult

public class com.ss.bytertc.engine.type.UserMessageSendResult
java

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

成员变量

类型	名称
int	USER_MESSAGE_SEND_RESULT_SUCCESS
int	USER_MESSAGE_SEND_RESULT_TIMEOUT
int	USER_MESSAGE_SEND_RESULT_BROKEN
int	USER_MESSAGE_SEND_RESULT_NO_RECEIVER
int	USER_MESSAGE_SEND_RESULT_NO_RELAY_PATH
int	USER_MESSAGE_SEND_RESULT_EXCEED_QPS
int	USER_MESSAGE_SEND_RESULT_NOT_JOIN
int	USER_MESSAGE_SEND_RESULT_INIT
int	USER_MESSAGE_SEND_RESULT_NO_CONNECTION
int	USER_MESSAGE_SEND_RESULT_EXCEED_MAX_LENGTH
int	USER_MESSAGE_SEND_RESULT_EMPTY_USER
int	USER_MESSAGE_SEND_RESULT_NOT_LOGIN
int	USER_MESSAGE_SEND_RESULT_SERVER_PARAMS_NOT_SET
int	USER_MESSAGE_SEND_RESULT_UNKNOWN

变量说明

USER_MESSAGE_SEND_RESULT_SUCCESS

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_SUCCESS = 0;
java

发送消息成功

USER_MESSAGE_SEND_RESULT_TIMEOUT

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_TIMEOUT = 1;
java

发送超时，没有发送

USER_MESSAGE_SEND_RESULT_BROKEN

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_BROKEN = 2;
java

通道断开，没有发送

USER_MESSAGE_SEND_RESULT_NO_RECEIVER

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_NO_RECEIVER = 3;
java

找不到接收方

USER_MESSAGE_SEND_RESULT_NO_RELAY_PATH

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_NO_RELAY_PATH = 4;
java

远端用户没有登录或进房

USER_MESSAGE_SEND_RESULT_EXCEED_QPS

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_EXCEED_QPS = 5;
java

超过 QPS 限制

USER_MESSAGE_SEND_RESULT_NOT_JOIN

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_NOT_JOIN = 100;
java

消息发送方没有加入房间

USER_MESSAGE_SEND_RESULT_INIT

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_INIT = 101;
java

连接未完成初始化。

USER_MESSAGE_SEND_RESULT_NO_CONNECTION

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_NO_CONNECTION = 102;
java

没有可用的数据传输通道连接

USER_MESSAGE_SEND_RESULT_EXCEED_MAX_LENGTH

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_EXCEED_MAX_LENGTH = 103;
java

消息超过最大长度，当前为 64KB。

USER_MESSAGE_SEND_RESULT_EMPTY_USER

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_EMPTY_USER = 104;
java

接收消息的单个用户 id 为空

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_NOT_LOGIN = 105;
java

房间外或应用服务器消息发送方没有登录

USER_MESSAGE_SEND_RESULT_SERVER_PARAMS_NOT_SET

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_SERVER_PARAMS_NOT_SET = 106;
java

发送消息给业务方服务器之前没有设置参数

USER_MESSAGE_SEND_RESULT_UNKNOWN

public static final int com.ss.bytertc.engine.type.UserMessageSendResult.USER_MESSAGE_SEND_RESULT_UNKNOWN = 1000;
java

未知错误

WarningCode

public class com.ss.bytertc.engine.type.WarningCode
java

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

成员变量

类型	名称
int	WARNING_CODE_JOIN_ROOM_FAILED
int	WARNING_CODE_PUBLISH_STREAM_FAILED
int	WARNING_CODE_SUBSCRIBE_STREAM_FAILED404
int	WARNING_CODE_SUBSCRIBE_STREAM_FAILED5XX
int	WARNING_CODE_PUBLISH_STREAM_FORBIDEN
int	WARNING_CODE_SEND_CUSTOM_MESSAGE
int	WARNING_CODE_RECEIVE_USER_NOTIFY_STOP
int	WARNING_CODE_USER_IN_PUBLISH
int	WARNING_CODE_OLD_ROOM_BEEN_REPLACED
int	WARNING_CODE_IN_ECHO_TEST_MODE
int	WARNING_CODE_NO_CAMERA_PERMISSION
int	WARNING_CODE_SET_SCREEN_AUDIO_SOURCE_TYPE_FAILED
int	WARNING_CODE_SET_SCREEN_STREAM_INDEX_FAILED
int	WARNING_CODE_SET_SCREEN_STREAM_INVALID_VOICE_PITCH
int	WARNING_CODE_INVALID_CALL_FOR_EXT_AUDIO
int	WARNING_CODE_INVALID_SAMI_APPKEY_OR_TOKEN
int	WARNING_CODE_INVALID_RESOURCE_PATH
int	WARNING_CODE_LOAD_SAMI_LIBRARY_FAILED
int	WARNING_CODE_INVALID_SAMI_EFFECT_TYPE
int	[deprecated] WARNING_CODE_GET_ROOM_FAILED
int	[deprecated] WARNING_CODE_SUBSCRIBE_STREAM_FORBIDEN
int	[deprecated] WARNING_CODE_ROOM_ID_ALREADY_EXIST
int	[deprecated] WARNING_CODE_NO_MICROPHONE_PERMISSION
int	[deprecated] WARNING_CODE_RECODING_DEVICE_START_FAILED
int	[deprecated] WARNING_CODE_PLAYOUT_DEVICE_START_FAILED
int	[deprecated] WARNING_CODE_NO_RECORDING_DEVICE
int	[deprecated] WARNING_CODE_NO_PLAYOUT_DEVICE
int	[deprecated] WARNING_CODE_RECORDING_SILENCE
int	[deprecated] WARNING_CODE_MEDIA_DEVICE_OPERATION_DENIED

变量说明

WARNING_CODE_GET_ROOM_FAILED

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_GET_ROOM_FAILED = -2000;
java

获取房间信息失败警告

Deprecated since 3.45 and will be deleted in 3.51.注意:
SDK 获取房间信息失败（包含超时，返回非 200 的错误码），每隔两秒重试一次。连续失败 5 次后，报该 warning，并继续重试。
建议提示用户：进入房间失败，请稍后再试

SDK 获取房间信息失败（包含超时，返回非 200 的错误码），每隔两秒重试一次。连续失败 5 次后，报该 warning，并继续重试。
建议提示用户：进入房间失败，请稍后再试

WARNING_CODE_JOIN_ROOM_FAILED

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_JOIN_ROOM_FAILED = -2001;
java

进房失败。通过 onRoomStateChanged 回调。
初次进房或者由于网络状况不佳断网重连时，由于服务器错误导致进房失败。SDK 会自动重试进房。

WARNING_CODE_PUBLISH_STREAM_FAILED

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_PUBLISH_STREAM_FAILED = -2002;
java

发布音视频流失败。通过 onStreamStateChanged 回调。
当你在所在房间中发布音视频流时，由于服务器错误导致发布失败。SDK 会自动重试发布。

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_SUBSCRIBE_STREAM_FAILED404 = -2003;
java

订阅音视频流失败。通过 onStreamStateChanged 回调。
当前房间中找不到订阅的音视频流导致订阅失败。SDK 会自动重试订阅，若仍订阅失败则建议你退出重试。

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_SUBSCRIBE_STREAM_FAILED5XX = -2004;
java

订阅音视频流失败。通过 onStreamStateChanged 回调。
当你订阅所在房间中的音视频流时，由于服务器错误导致订阅失败。SDK 会自动重试订阅。

WARNING_CODE_PUBLISH_STREAM_FORBIDEN

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_PUBLISH_STREAM_FORBIDEN = -2009;
java

当调用 setUserVisibility 将自身可见性设置为 false 后，再尝试发布流会触发此警告。通过 onStreamStateChanged 回调。

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_SUBSCRIBE_STREAM_FORBIDEN = -2010;
java

自动订阅模式未关闭时，尝试开启手动订阅模式会触发此警告。

你需在进房前关闭自动订阅模式，再调用 subscribeUserStream 方法手动订阅音视频流。

Deprecated since 3.45 and will be deleted in 3.51.

WARNING_CODE_SEND_CUSTOM_MESSAGE

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_SEND_CUSTOM_MESSAGE = -2011;
java

发送自定义广播消息失败, 当前你未在房间中。

WARNING_CODE_RECEIVE_USER_NOTIFY_STOP

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_RECEIVE_USER_NOTIFY_STOP = -2013;
java

当房间内人数超过 500 人时，停止向房间内已有用户发送 onUserJoined 和 onUserLeave 回调，并通过广播提示房间内所有用户。通过 onRoomStateChanged 回调。

WARNING_CODE_USER_IN_PUBLISH

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_USER_IN_PUBLISH = -2014;
java

用户已经在其他房间发布过流，或者用户正在发布公共流。通过 onStreamStateChanged 回调。

WARNING_CODE_ROOM_ID_ALREADY_EXIST

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_ROOM_ID_ALREADY_EXIST = -2015;
java

已存在同样 roomId 的房间。

Deprecated since 3.45 and will be deleted in 3.51.

WARNING_CODE_OLD_ROOM_BEEN_REPLACED

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_OLD_ROOM_BEEN_REPLACED = -2016;
java

已存在相同 roomId 的房间，新创建的房间实例已替换旧房间实例。通过 onRoomStateChanged 回调。

WARNING_CODE_IN_ECHO_TEST_MODE

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_IN_ECHO_TEST_MODE = -2017;
java

当前正在进行回路测试，该接口调用无效

WARNING_CODE_NO_CAMERA_PERMISSION

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_NO_CAMERA_PERMISSION = -5001;
java

摄像头权限异常，当前应用没有获取摄像头权限。

WARNING_CODE_NO_MICROPHONE_PERMISSION

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_NO_MICROPHONE_PERMISSION = -5002;
java

麦克风权限异常，当前应用没有获取麦克风权限。

Deprecated since 3.33 and will be deleted in 3.51, use MediaDeviceError.MEDIA_DEVICE_ERROR_NOPERMISSION instead.

WARNING_CODE_RECODING_DEVICE_START_FAILED

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_RECODING_DEVICE_START_FAILED = -5003;
java

音频采集设备启动失败。

启动音频采集设备失败，当前设备可能被其他应用占用。

Deprecated since 3.33 and will be deleted in 3.51, use MediaDeviceError.MEDIA_DEVICE_ERROR_DEVICEFAILURE instead.

WARNING_CODE_PLAYOUT_DEVICE_START_FAILED

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_PLAYOUT_DEVICE_START_FAILED = -5004;
java

音频播放设备启动失败警告。

可能由于系统资源不足，或参数错误。

Deprecated since 3.33 and will be deleted in 3.51, use MediaDeviceError.MEDIA_DEVICE_ERROR_DEVICEFAILURE instead.

WARNING_CODE_NO_RECORDING_DEVICE

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_NO_RECORDING_DEVICE = -5005;
java

无可用音频采集设备。

启动音频采集设备失败，请插入可用的音频采集设备。

Deprecated since 3.33 and will be deleted in 3.51, use MediaDeviceError.MEDIA_DEVICE_ERROR_DEVICENOTFOUND instead.

WARNING_CODE_NO_PLAYOUT_DEVICE

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_NO_PLAYOUT_DEVICE = -5006;
java

无可用音频播放设备。

启动音频播放设备失败，请插入可用的音频播放设备。

Deprecated since 3.33 and will be deleted in 3.51, use MediaDeviceError.MEDIA_DEVICE_ERROR_DEVICENOTFOUND instead.

WARNING_CODE_RECORDING_SILENCE

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_RECORDING_SILENCE = -5007;
java

当前音频设备没有采集到有效的声音数据，请检查更换音频采集设备。

Deprecated since 3.33 and will be deleted in 3.51, use MediaDeviceWarning.MEDIA_DEVICE_WARNING_CAPTURE_SILENCE instead.

WARNING_CODE_MEDIA_DEVICE_OPERATION_DENIED

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_MEDIA_DEVICE_OPERATION_DENIED = -5008;
java

媒体设备误操作警告。

使用自定义采集时，不可调用内部采集开关，调用时将触发此警告。

Deprecated since 3.33 and will be deleted in 3.51, use MediaDeviceWarning.MEDIA_DEVICE_WARNING_OPERATION_DENIED instead.

WARNING_CODE_SET_SCREEN_AUDIO_SOURCE_TYPE_FAILED

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_SET_SCREEN_AUDIO_SOURCE_TYPE_FAILED = -5009;
java

不支持在 publishScreen 之后，调用 setScreenAudioSourceType 设置屏幕音频采集类型

WARNING_CODE_SET_SCREEN_STREAM_INDEX_FAILED

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_SET_SCREEN_STREAM_INDEX_FAILED = -5010;
java

不支持在 publishScreen 之后，调用 setScreenAudioStreamIndex 设置屏幕音频共享发布类型

WARNING_CODE_SET_SCREEN_STREAM_INVALID_VOICE_PITCH

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_SET_SCREEN_STREAM_INVALID_VOICE_PITCH = -5011;
java

设置语音音高不合法

WARNING_CODE_INVALID_CALL_FOR_EXT_AUDIO

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_INVALID_CALL_FOR_EXT_AUDIO = -5013;
java

外部音频源新旧接口混用

WARNING_CODE_INVALID_SAMI_APPKEY_OR_TOKEN

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_INVALID_SAMI_APPKEY_OR_TOKEN = -7002;
java

音频技术 SDK 鉴权失效。联系技术支持人员。

WARNING_CODE_INVALID_RESOURCE_PATH

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_INVALID_RESOURCE_PATH = -7003;
java

音频技术资源加载失败。传入正确的 DAT 路径，或联系技术支持人员。

WARNING_CODE_LOAD_SAMI_LIBRARY_FAILED

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_LOAD_SAMI_LIBRARY_FAILED= -7004;
java

音频技术库加载失败。使用正确的库，或联系技术支持人员。

WARNING_CODE_INVALID_SAMI_EFFECT_TYPE

public static final int com.ss.bytertc.engine.type.WarningCode.WARNING_CODE_INVALID_SAMI_EFFECT_TYPE = -7005;
java

音频技术不支持此音效。联系技术支持人员。

KTVErrorCode

public enum com.ss.bytertc.ktv.data.KTVErrorCode
java

KTV 错误码。

枚举值

类型	说明
OK(0)	成功。
APPID_INVALID(-3000)	AppID 异常。
PARAS_INVALID(-3001)	非法参数，传入的参数不正确。
GET_MUSIC_FAILED(-3002)	获取歌曲资源失败。
GET_LYRIC_FAILED(-3003)	获取歌词失败。
MUSIC_TAKEDOWN(-3004)	歌曲下架。
MUSIC_DOWNLOAD(-3005)	歌曲文件下载失败。
MIDI_DOWNLOAD_FAILED(-3006)	MIDI 文件下载失败。
SYSTEM_BUSY(-3007)	系统繁忙。
NETWORK(-3008)	网络异常。
NOT_JOIN_ROOM(-3009)	KTV 功能未加入房间。
PARSE_DATA(-3010)	解析数据失败。
DOWNLOADING(-3012)	已在下载中。
INTERNAL_DOMAIN(-3013)	内部错误，联系技术支持人员。
INSUFFICIENT_DISK_SPACE(-3014)	下载失败，磁盘空间不足。清除缓存后重试。
MUSIC_DECRYPTION_FAILED(-3015)	下载失败，音乐文件解密失败，联系技术支持人员。
FILE_RENAME_FAILED(-3016)	下载失败，音乐文件重命名失败，请重试。
DOWNLOAD_TIMEOUT(-3017)	下载失败，下载超时，请重试。
CLEAR_CACHE_FAILED(-3018)	清除缓存失败，可能原因是文件被占用或者系统异常，请重试。
DOWNLOAD_CANCELED(-3019)	取消下载。