API概览
ARTalkClient
ARTalkClientListener
ARTalkChannel
ARTalkChannelListener
AudioQuality
ResultCallback
状态码和错误码

状态码和错误码

最近更新时间：2023-02-21 10:39:53

枚举类型说明
CONNECTION_CHANGE_REASON
CONNECTION_STATE
INIT_ERR_CODE
JOIN_CHANNEL_ERR
LEAVE_CHANNEL_ERR
LEAVE_CHANNEL_REASON
LOG_FILTER_TYPE
LOGIN_ERR_CODE
LOGOUT_ERR_CODE
QUERY_PEERS_ONLINE_STATUS_ERR
RENEW_TOKEN_ERR_CODE
PUSH_TO_TALK_ERR_CODE
PUSH_TO_TALK_ENDED_ERR_CODE
AUDIO_CODEC_TYPE
AUDIO_SAMPLE_RATE_TYPE

枚举类型说明

CONNECTION_CHANGE_REASON

enum CONNECTION_CHANGE_REASON

枚举值
CONNECTION_CHANGE_REASON_LOGIN1: SDK 正在登录 anyRTC RTK 系统。
CONNECTION_CHANGE_REASON_LOGIN_SUCCESS2: SDK 登录 anyRTC RTK 系统成功。
CONNECTION_CHANGE_REASON_LOGIN_FAILURE3: SDK 登录 anyRTC RTK 系统失败。
CONNECTION_CHANGE_REASON_LOGIN_TIMEOUT4: SDK 无法登录 anyRTC RTK 系统超过 6 秒，停止登录。可能原因：用户正处于 CONNECTION_STATE_ABORTED 状态或 CONNECTION_STATE_RECONNECTING状态。
CONNECTION_CHANGE_REASON_INTERRUPTED5: SDK 与 anyRTC RTK 系统的连接被中断。
CONNECTION_CHANGE_REASON_LOGOUT6: 用户调用了 logout 方法登出 anyRTC RTK 系统。
CONNECTION_CHANGE_REASON_BANNED_BY_SERVER7：SDK 被服务器禁止登录 anyRTC RTK 系统。
CONNECTION_CHANGE_REASON_REMOTE_LOGIN8：另一个用户正以相同的 User ID 登陆 anyRTC RTK 系统。

CONNECTION_STATE

enum CONNECTION_STATE

枚举值
CONNECTION_STATE_DISCONNECTED1: 初始状态。SDK 未连接到 anyRTC RTK 系统。App 调用方法 login 时, SDK 开始登录 anyRTC RTK 系统，触发回调 onConnectionStateChanged 并切换到 CONNECTION_STATE_CONNECTING 状态。
CONNECTION_STATE_CONNECTING2: SDK 正在登录 anyRTC RTK 系统。方法调用成功时，SDK 会触发回调 onConnectionStateChanged, 并切换到 CONNECTION_STATE_CONNECTED 状态。方法调用失败，SDK 会触发回调 onConnectionStateChanged，并切换到 CONNECTION_STATE_DISCONNECTED 状态。
CONNECTION_STATE_CONNECTED3: SDK 已登录 anyRTC RTK 系统。如果 SDK 与 anyRTC RTK 系统的连接由于网络问题中断，SDK 会触发回调 onConnectionStateChanged，并切换到 CONNECTION_STATE_RECONNECTING 状态。如果 SDK 因为相同 ID 已在其他实例或设备中登录等原因被服务器禁止登录，会触发回调 onConnectionStateChanged 并切换到 CONNECTION_STATE_ABORTED 状态。如果 App 调用方法 logout ，SDK 登出 anyRTC RTK 系统成功，会触发回调 onConnectionStateChanged ，并切换到 CONNECTION_STATE_DISCONNECTED。
CONNECTION_STATE_RECONNECTING4: SDK 与 anyRTC RTK 系统连接由于网络原因出现中断，SDK 正在尝试自动重连 anyRTC RTK 系统。如果 SDK 重新登录 anyRTC RTK 系统成功，会触发回调 onConnectionStateChanged，并切换到 CONNECTION_STATE_CONNECTED 状态。SDK 会自动加入中断时用户所在频道，并自动将本地用户属性同步到服务端。如果 SDK 重新登录 anyRTC RTK 系统失败，会保持 CONNECTION_STATE_RECONNECTING 状态。
CONNECTION_STATE_ABORTED5: SDK 停止登录 anyRTC RTK 系统。可能原因：另一实例已经以同一用户 ID 登录 anyRTC RTK 系统。请先调用 logout ，再视情况调用 login 方法重新登录 anyRTC RTK 系统。

INIT_ERR_CODE

enum INIT_ERR_CODE

枚举值
INIT_ERR_OK0: 初始化 anyRTC RTK 服务成功。
INIT_ERR_FAILURE1: 初始化通用错误。
INIT_ERR_ALREADY_INITIALIZED2: anyRTC RTK service 已完成初始化。
INIT_ERR_INVALID_APP_ID3: App ID 无效。
INIT_ERR_INVALID_ARGUMENT4: Event Handler 为空。

JOIN_CHANNEL_ERR

enum JOIN_CHANNEL_ERR

枚举值
JOIN_CHANNEL_ERR_OK0: 方法调用成功，或用户加入频道成功。
JOIN_CHANNEL_ERR_FAILURE1: 通用错误。用户加入频道失败。
JOIN_CHANNEL_ERR_REJECTED2: 预留错误码
JOIN_CHANNEL_ERR_INVALID_ARGUMENT3: 用户加入频道失败。输入参数无效。
JOIN_CHANNEL_TIMEOUT4: 用户加入频道超时。目前的超时设置为 5 秒。可能原因：用户正处于 CONNECTION_STATE_ABORTED 状态或 CONNECTION_STATE_RECONNECTING 状态。
JOIN_CHANNEL_ERR_EXCEED_LIMIT5: 同时加入的频道数超过 20 上限。
JOIN_CHANNEL_ERR_ALREADY_JOINED6: 用户正在加入频道或已成功加入频道。
JOIN_CHANNEL_ERR_TOO_OFTEN7: 方法调用超过每 3 秒 50 次的上限。
JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN8: 加入相同频道的频率超过每 5 秒 2 次的上限。
JOIN_CHANNEL_ERR_NOT_INITIALIZED101: anyRTC RTK 服务未完成初始化。
JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN102: 用户加入频道前未调用 login 方法或者 login 方法调用未成功。

LEAVE_CHANNEL_ERR

enum LEAVE_CHANNEL_ERR

枚举值
LEAVE_CHANNEL_ERR_OK0: 方法调用成功，或用户离开频道成功。
LEAVE_CHANNEL_ERR_FAILURE1: 通用错误。用户离开频道失败。
LEAVE_CHANNEL_ERR_REJECTED2: 预留错误码
LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL3: 用户已不在频道内。
LEAVE_CHANNEL_ERR_NOT_INITIALIZED101: anyRTC RTK 服务未完成初始化。
LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN102: 用户在调用 leave 方法前未调用 login 方法或者 login 方法调用未成功。

LEAVE_CHANNEL_REASON

enum LEAVE_CHANNEL_REASON

枚举值
LEAVE_CHANNEL_REASON_QUIT1: 用户已主动调用 leave 方法离开频道。
LEAVE_CHANNEL_REASON_KICKED2: 用户被服务器踢出。可能因为另一个实例用了相同的 uid 登录 anyRTC RTK 系统。

LOG_FILTER_TYPE

enum LOG_FILTER_TYPE

枚举值
LOG_FILTER_OFF0: 不输出日志信息。
LOG_FILTER_INFO0x000f: 输出 CRITICAL、ERROR、WARNING 和 INFO 级别的日志信息。 我们推荐你将日志级别设为该等级。
LOG_FILTER_WARN0x000e: 输出 CRITICAL、ERROR 和 WARNING 级别的日志信息。
LOG_FILTER_ERROR0x000c: 输出 CRITICAL 和 ERROR 级别的日志信息。
LOG_FILTER_CRITICAL0x0008: 输出 CRITICAL 级别的日志信息。
LOG_FILTER_MASK预留错误码。

LOGIN_ERR_CODE

enum LOGIN_ERR_CODE

枚举值
LOGIN_ERR_OK0: 方法调用成功或登录成功
LOGIN_ERR_UNKNOWN1: 登录失败。原因未知。
LOGIN_ERR_REJECTED2: 登录被服务器拒绝。
LOGIN_ERR_INVALID_ARGUMENT3: 无效的登录参数。
LOGIN_ERR_INVALID_APP_ID4: 无效的 App ID。
LOGIN_ERR_INVALID_TOKEN5: 无效的 Token。
LOGIN_ERR_TOKEN_EXPIRED6: Token 已过期，登录被拒绝。
LOGIN_ERR_NOT_AUTHORIZED7: 预留错误码 未经授权的登录。
LOGIN_ERR_ALREADY_LOGIN8: 用户已登录，或正在登录 anyRTC RTK 系统，或未调用 logout 方法退出 CONNECTION_STATE_ABORTED 状态。
LOGIN_ERR_TIMEOUT9: 登录超时。目前的超时设置为 6 秒。
LOGIN_ERR_TOO_OFTEN10: 登录过于频繁。超过 2 次每秒的上限。
LOGIN_ERR_NOT_INITIALIZED101: anyRTC RTK 服务未完成初始化。

LOGOUT_ERR_CODE

enum LOGOUT_ERR_CODE

枚举值
LOGOUT_ERR_OK0: 登出成功。没有错误。
LOGOUT_ERR_REJECTED1: 预留错误码
LOGOUT_ERR_NOT_INITIALIZED101: anyRTC RTK 服务未完成初始化。
LOGOUT_ERR_USER_NOT_LOGGED_IN102: 登出 anyRTC RTK 系统前未调用 login 方法或者 login 方法调用未成功。

QUERY_PEERS_ONLINE_STATUS_ERR

enum QUERY_PEERS_ONLINE_STATUS_ERR

枚举值
QUERY_PEERS_ONLINE_STATUS_ERR_OK0：方法调用成功，或查询用户在线状态成功。
QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE1：通用错误。查询用户在线状态失败。
QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT2：无效的输入参数。
QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED3： 预留错误码
QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT4：服务器响应超时。当前的超时设置为 10 秒。可能原因：用户正处于 CONNECTION_STATE_ABORTED 状态或 CONNECTION_STATE_RECONNECTING 状态。
QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN5：方法调用过于频繁。超过（RTK SDK for Windows C++）每 5 秒 10 次或 （RTK SDK for Linux C++）每 5 秒 20 次的限制。
QUERY_PEERS_ONLINE_STATUS_ERR_NOT_INITIALIZED101: ARTalkClient 未完成初始化。
QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN102: 查询指定用户在线状态前未调用 login 方法或者 login 方法调用未成功。

RENEW_TOKEN_ERR_CODE

enum RENEW_TOKEN_ERR_CODE

Token 错误码

枚举值
RENEW_TOKEN_ERR_OK0：方法调用成功，或更新 Token 成功。
RENEW_TOKEN_ERR_FAILURE1：通用错误。更新 Token 失败。
RENEW_TOKEN_ERR_INVALID_ARGUMENT2：无效的输入参数。
RENEW_TOKEN_ERR_REJECTED3：预留错误码
RENEW_TOKEN_ERR_TOO_OFTEN4：方法调用过于频繁。超过 2 次每秒的上限。
RENEW_TOKEN_ERR_TOKEN_EXPIRED5：输入 Token 已过期。
RENEW_TOKEN_ERR_INVALID_TOKEN6：输入 Token 无效。
RENEW_TOKEN_ERR_NOT_INITIALIZED101: anyRTC RTK 服务未完成初始化。
RENEW_TOKEN_ERR_USER_NOT_LOGGED_IN102: 更新 Token 前未调用 login 方法或者 login 方法调用未成功。

PUSH_TO_TALK_ERR_CODE

enum PUSH_TO_TALK_ERR_CODE

上麦 错误码

枚举值
PUSH_TO_TALK_ERR_OK0：方法调用成功。
PUSH_TO_TALK_ERR_FAILURE1：通用错误。上麦失败。
PUSH_TO_TALK_ERR_INVALID_ARGUMENT2：无效的输入参数。
PUSH_TO_TALK_ERR_REJECTED3：预留错误码
PUSH_TO_TALK_ERR_TOO_OFTEN4：方法调用过于频繁。超过 2 次每秒的上限。
PUSH_TO_TALK_ERR_EXISTED5：上麦出错。
PUSH_TO_TALK_ERR_REJECT_BY_PERMISSION等级高的用户在麦上。
PUSH_TO_TALK_ERR_NOT_INITIALIZED101: anyRTC RTK 服务未完成初始化。
PUSH_TO_TALK_ERR_USER_NOT_LOGGED_IN102: 更新 Token 前未调用 login 方法或者 login 方法调用未成功。
PUSH_TO_TALK_ERR_CHANNEL_NOT_JOINED103: 未登录频道。

PUSH_TO_TALK_ENDED_ERR_CODE

enum PUSH_TO_TALK_ENDED_ERR_CODE

下麦 错误码

枚举值
PUSH_TO_TALK_ENDED_ERR_OK0：方法调用成功。
PUSH_TO_TALK_ENDED_ERR_TIMEOUT1：超时。
PUSH_TO_TALK_ENDED_ERR_BREAKED2：被拒绝。
PUSH_TO_TALK_ENDED_ERR_EXCEPTION3：网路错误
PUSH_TO_TALK_ENDED_ERR_NOT_FOUND4：当前对讲不存在。

AUDIO_CODEC_TYPE

enum AUDIO_CODEC_TYPE

音频格式

枚举值
AUDIO_CODEC_OPUS0：OPUS。
AUDIO_CODEC_AACLC8：AACLC。
AUDIO_CODEC_HEAAC9：HEAAC。
AUDIO_CODEC_AMR19：AMR。
AUDIO_CODEC_AICODEC20：AICODEC。
AUDIO_CODEC_GENERIC253：GENERIC。

AUDIO_SAMPLE_RATE_TYPE

enum AUDIO_SAMPLE_RATE_TYPE

音频采样率

枚举值
AUDIO_SAMPLE_RATE_80008000：8 kHz。
AUDIO_SAMPLE_RATE_1600016000：16 kHz。
AUDIO_SAMPLE_RATE_4410044100：44.1 kHz。
AUDIO_SAMPLE_RATE_4800048000：48 kHz。