C++ API Reference for All Platforms

概览 IRtcEngine IRtcEngineEventHandler IChannel IChannelEventHandler IAudioDeviceManager IVideoDeviceManager

命名空间
namespace	base

namespace	media

namespace	rtc

namespace	signaling

namespace	util

枚举
enum	INTERFACE_ID_TYPE { AGORA_IID_AUDIO_DEVICE_MANAGER = 1 , AGORA_IID_VIDEO_DEVICE_MANAGER = 2 , AGORA_IID_RTC_ENGINE_PARAMETER = 3 , AGORA_IID_MEDIA_ENGINE = 4 , AGORA_IID_SIGNALING_ENGINE = 8 }

enum	WARN_CODE_TYPE { WARN_INVALID_VIEW = 8 , WARN_INIT_VIDEO = 16 , WARN_PENDING = 20 , WARN_NO_AVAILABLE_CHANNEL = 103 , WARN_LOOKUP_CHANNEL_TIMEOUT = 104 , WARN_LOOKUP_CHANNEL_REJECTED = 105 , WARN_OPEN_CHANNEL_TIMEOUT = 106 , WARN_OPEN_CHANNEL_REJECTED = 107 , WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111 , WARN_SET_CLIENT_ROLE_TIMEOUT = 118 , WARN_OPEN_CHANNEL_INVALID_TICKET = 121 , WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122 , WARN_CHANNEL_CONNECTION_UNRECOVERABLE = 131 , WARN_CHANNEL_CONNECTION_IP_CHANGED = 132 , WARN_CHANNEL_CONNECTION_PORT_CHANGED = 133 , WARN_AUDIO_MIXING_OPEN_ERROR = 701 , WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014 , WARN_ADM_RUNTIME_RECORDING_WARNING = 1016 , WARN_ADM_RECORD_AUDIO_SILENCE = 1019 , WARN_ADM_PLAYOUT_MALFUNCTION = 1020 , WARN_ADM_RECORD_MALFUNCTION = 1021 , WARN_ADM_CALL_INTERRUPTION = 1025 , WARN_ADM_IOS_CATEGORY_NOT_PLAYANDRECORD = 1029 , WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031 , WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032 , WARN_ADM_RECORD_AUDIO_IS_ACTIVE = 1033 , WARN_ADM_WINDOWS_NO_DATA_READY_EVENT = 1040 , WARN_ADM_INCONSISTENT_AUDIO_DEVICE = 1042 , WARN_APM_HOWLING = 1051 , WARN_ADM_GLITCH_STATE = 1052 , WARN_APM_RESIDUAL_ECHO = 1053 , WARN_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323 , WARN_ADM_WIN_CORE_IMPROPER_CAPTURE_RELEASE = 1324 , WARN_SUPER_RESOLUTION_STREAM_OVER_LIMITATION = 1610 , WARN_SUPER_RESOLUTION_USER_COUNT_OVER_LIMITATION = 1611 , WARN_SUPER_RESOLUTION_DEVICE_NOT_SUPPORTED = 1612 , WARN_RTM_LOGIN_TIMEOUT = 2005 , WARN_RTM_KEEP_ALIVE_TIMEOUT = 2009 }

enum	ERROR_CODE_TYPE { ERR_OK = 0 , ERR_FAILED = 1 , ERR_INVALID_ARGUMENT = 2 , ERR_NOT_READY = 3 , ERR_NOT_SUPPORTED = 4 , ERR_REFUSED = 5 , ERR_BUFFER_TOO_SMALL = 6 , ERR_NOT_INITIALIZED = 7 , ERR_NO_PERMISSION = 9 , ERR_TIMEDOUT = 10 , ERR_CANCELED = 11 , ERR_TOO_OFTEN = 12 , ERR_BIND_SOCKET = 13 , ERR_NET_DOWN = 14 , ERR_NET_NOBUFS = 15 , ERR_JOIN_CHANNEL_REJECTED = 17 , ERR_LEAVE_CHANNEL_REJECTED = 18 , ERR_ALREADY_IN_USE = 19 , ERR_ABORTED = 20 , ERR_INIT_NET_ENGINE = 21 , ERR_RESOURCE_LIMITED = 22 , ERR_INVALID_APP_ID = 101 , ERR_INVALID_CHANNEL_NAME = 102 , ERR_NO_SERVER_RESOURCES = 103 , ERR_TOKEN_EXPIRED = 109 , ERR_INVALID_TOKEN = 110 , ERR_CONNECTION_INTERRUPTED = 111 , ERR_CONNECTION_LOST = 112 , ERR_NOT_IN_CHANNEL = 113 , ERR_SIZE_TOO_LARGE = 114 , ERR_BITRATE_LIMIT = 115 , ERR_TOO_MANY_DATA_STREAMS = 116 , ERR_STREAM_MESSAGE_TIMEOUT = 117 , ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119 , ERR_DECRYPTION_FAILED = 120 , ERR_CLIENT_IS_BANNED_BY_SERVER = 123 , ERR_WATERMARK_PARAM = 124 , ERR_WATERMARK_PATH = 125 , ERR_WATERMARK_PNG = 126 , ERR_WATERMARKR_INFO = 127 , ERR_WATERMARK_ARGB = 128 , ERR_WATERMARK_READ = 129 , ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH = 130 , ERR_INVALID_USER_ACCOUNT = 134 , ERR_PUBLISH_STREAM_CDN_ERROR = 151 , ERR_PUBLISH_STREAM_NUM_REACH_LIMIT = 152 , ERR_PUBLISH_STREAM_NOT_AUTHORIZED = 153 , ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR = 154 , ERR_PUBLISH_STREAM_NOT_FOUND = 155 , ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED = 156 , ERR_MODULE_NOT_FOUND = 157 , ERR_ALREADY_IN_RECORDING = 160 , ERR_LOGOUT_OTHER = 400 , ERR_LOGOUT_USER = 401 , ERR_LOGOUT_NET = 402 , ERR_LOGOUT_KICKED = 403 , ERR_LOGOUT_PACKET = 404 , ERR_LOGOUT_TOKEN_EXPIRED = 405 , ERR_LOGOUT_OLDVERSION = 406 , ERR_LOGOUT_TOKEN_WRONG = 407 , ERR_LOGOUT_ALREADY_LOGOUT = 408 , ERR_LOGIN_OTHER = 420 , ERR_LOGIN_NET = 421 , ERR_LOGIN_FAILED = 422 , ERR_LOGIN_CANCELED = 423 , ERR_LOGIN_TOKEN_EXPIRED = 424 , ERR_LOGIN_OLD_VERSION = 425 , ERR_LOGIN_TOKEN_WRONG = 426 , ERR_LOGIN_TOKEN_KICKED = 427 , ERR_LOGIN_ALREADY_LOGIN = 428 , ERR_JOIN_CHANNEL_OTHER = 440 , ERR_SEND_MESSAGE_OTHER = 440 , ERR_SEND_MESSAGE_TIMEOUT = 441 , ERR_QUERY_USERNUM_OTHER = 450 , ERR_QUERY_USERNUM_TIMEOUT = 451 , ERR_QUERY_USERNUM_BYUSER = 452 , ERR_LEAVE_CHANNEL_OTHER = 460 , ERR_LEAVE_CHANNEL_KICKED = 461 , ERR_LEAVE_CHANNEL_BYUSER = 462 , ERR_LEAVE_CHANNEL_LOGOUT = 463 , ERR_LEAVE_CHANNEL_DISCONNECTED = 464 , ERR_INVITE_OTHER = 470 , ERR_INVITE_REINVITE = 471 , ERR_INVITE_NET = 472 , ERR_INVITE_PEER_OFFLINE = 473 , ERR_INVITE_TIMEOUT = 474 , ERR_INVITE_CANT_RECV = 475 , ERR_LOAD_MEDIA_ENGINE = 1001 , ERR_START_CALL = 1002 , ERR_START_CAMERA = 1003 , ERR_START_VIDEO_RENDER = 1004 , ERR_ADM_GENERAL_ERROR = 1005 , ERR_ADM_JAVA_RESOURCE = 1006 , ERR_ADM_SAMPLE_RATE = 1007 , ERR_ADM_INIT_PLAYOUT = 1008 , ERR_ADM_START_PLAYOUT = 1009 , ERR_ADM_STOP_PLAYOUT = 1010 , ERR_ADM_INIT_RECORDING = 1011 , ERR_ADM_START_RECORDING = 1012 , ERR_ADM_STOP_RECORDING = 1013 , ERR_ADM_RUNTIME_PLAYOUT_ERROR = 1015 , ERR_ADM_RUNTIME_RECORDING_ERROR = 1017 , ERR_ADM_RECORD_AUDIO_FAILED = 1018 , ERR_ADM_INIT_LOOPBACK = 1022 , ERR_ADM_START_LOOPBACK = 1023 , ERR_ADM_NO_PERMISSION = 1027 , ERR_ADM_RECORD_AUDIO_IS_ACTIVE = 1033 , ERR_ADM_ANDROID_JNI_JAVA_RESOURCE = 1101 , ERR_ADM_ANDROID_JNI_NO_RECORD_FREQUENCY = 1108 , ERR_ADM_ANDROID_JNI_NO_PLAYBACK_FREQUENCY = 1109 , ERR_ADM_ANDROID_JNI_JAVA_START_RECORD = 1111 , ERR_ADM_ANDROID_JNI_JAVA_START_PLAYBACK = 1112 , ERR_ADM_ANDROID_JNI_JAVA_RECORD_ERROR = 1115 , ERR_ADM_ANDROID_OPENSL_CREATE_ENGINE = 1151 , ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_RECORDER = 1153 , ERR_ADM_ANDROID_OPENSL_START_RECORDER_THREAD = 1156 , ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_PLAYER = 1157 , ERR_ADM_ANDROID_OPENSL_START_PLAYER_THREAD = 1160 , ERR_ADM_IOS_INPUT_NOT_AVAILABLE = 1201 , ERR_ADM_IOS_ACTIVATE_SESSION_FAIL = 1206 , ERR_ADM_IOS_VPIO_INIT_FAIL = 1210 , ERR_ADM_IOS_VPIO_REINIT_FAIL = 1213 , ERR_ADM_IOS_VPIO_RESTART_FAIL = 1214 , ERR_ADM_IOS_SET_RENDER_CALLBACK_FAIL = 1219 , ERR_ADM_IOS_SESSION_SAMPLERATR_ZERO = 1221 , ERR_ADM_WIN_CORE_INIT = 1301 , ERR_ADM_WIN_CORE_INIT_RECORDING = 1303 , ERR_ADM_WIN_CORE_INIT_PLAYOUT = 1306 , ERR_ADM_WIN_CORE_INIT_PLAYOUT_NULL = 1307 , ERR_ADM_WIN_CORE_START_RECORDING = 1309 , ERR_ADM_WIN_CORE_CREATE_REC_THREAD = 1311 , ERR_ADM_WIN_CORE_CAPTURE_NOT_STARTUP = 1314 , ERR_ADM_WIN_CORE_CREATE_RENDER_THREAD = 1319 , ERR_ADM_WIN_CORE_RENDER_NOT_STARTUP = 1320 , ERR_ADM_WIN_CORE_NO_RECORDING_DEVICE = 1322 , ERR_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323 , ERR_ADM_WIN_WAVE_INIT = 1351 , ERR_ADM_WIN_WAVE_INIT_RECORDING = 1353 , ERR_ADM_WIN_WAVE_INIT_MICROPHONE = 1354 , ERR_ADM_WIN_WAVE_INIT_PLAYOUT = 1355 , ERR_ADM_WIN_WAVE_INIT_SPEAKER = 1356 , ERR_ADM_WIN_WAVE_START_RECORDING = 1357 , ERR_ADM_WIN_WAVE_START_PLAYOUT = 1358 , ERR_ADM_NO_RECORDING_DEVICE = 1359 , ERR_ADM_NO_PLAYOUT_DEVICE = 1360 , ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501 , ERR_VDM_WIN_DEVICE_IN_USE = 1502 , ERR_VCM_UNKNOWN_ERROR = 1600 , ERR_VCM_ENCODER_INIT_ERROR = 1601 , ERR_VCM_ENCODER_ENCODE_ERROR = 1602 , ERR_VCM_ENCODER_SET_ERROR = 1603 , ERR_ADM_WIN_CORE_SERVRE_SHUT_DOWN = 1735 , ERR_NOT_SUPPORTED_MUTI_GPU_EXCLUDE_WINDOW = 1736 }

enum	LOG_FILTER_TYPE { LOG_FILTER_OFF = 0 , LOG_FILTER_DEBUG = 0x080f , LOG_FILTER_INFO = 0x000f , LOG_FILTER_WARN = 0x000e , LOG_FILTER_ERROR = 0x000c , LOG_FILTER_CRITICAL = 0x0008 }

enum class	LOG_LEVEL { LOG_LEVEL_NONE = 0x0000 , LOG_LEVEL_INFO = 0x0001 , LOG_LEVEL_WARN = 0x0002 , LOG_LEVEL_ERROR = 0x0004 , LOG_LEVEL_FATAL = 0x0008 }

枚举类型说明

◆ INTERFACE_ID_TYPE

enum agora::INTERFACE_ID_TYPE

枚举值
AGORA_IID_AUDIO_DEVICE_MANAGER
AGORA_IID_VIDEO_DEVICE_MANAGER
AGORA_IID_RTC_ENGINE_PARAMETER
AGORA_IID_MEDIA_ENGINE
AGORA_IID_SIGNALING_ENGINE

◆ WARN_CODE_TYPE

enum agora::WARN_CODE_TYPE

警告代码

警告代码意味着 SDK 遇到问题，但有可能恢复，警告代码仅起告知作用，一般情况下应用程序可以忽略警告代码。

枚举值
WARN_INVALID_VIEW	8: 指定的 view 无效，使用视频功能时需要指定 view，如果 view 尚未指定，则返回该警告。
WARN_INIT_VIDEO	16: 初始化视频功能失败。有可能是因视频资源被占用导致的。用户无法看到视频画面，但不影响语音通信。
WARN_PENDING	20: 请求处于待定状态。一般是由于某个模块还没准备好，请求被延迟处理。
WARN_NO_AVAILABLE_CHANNEL	103: 没有可用的频道资源。可能是因为服务端没法分配频道资源。
WARN_LOOKUP_CHANNEL_TIMEOUT	104: 查找频道超时。在加入频道时 SDK 先要查找指定的频道，出现该警告一般是因为网络太差，连接不到服务器。
WARN_LOOKUP_CHANNEL_REJECTED	弃用: 105: 查找频道请求被服务器拒绝。服务器可能没有办法处理这个请求或请求是非法的。从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_REJECTED_BY_SERVER(10)。
WARN_OPEN_CHANNEL_TIMEOUT	106: 打开频道超时。查找到指定频道后，SDK 接着打开该频道，超时一般是因为网络太差，连接不到服务器。
WARN_OPEN_CHANNEL_REJECTED	107: 打开频道请求被服务器拒绝。服务器可能没有办法处理该请求或该请求是非法的。
WARN_SWITCH_LIVE_VIDEO_TIMEOUT	111: 切换直播视频超时。
WARN_SET_CLIENT_ROLE_TIMEOUT	118: 直播场景下设置用户角色超时。
WARN_OPEN_CHANNEL_INVALID_TICKET	121: 加入频道失败。
WARN_OPEN_CHANNEL_TRY_NEXT_VOS	122: 尝试打开另一个服务器。
WARN_CHANNEL_CONNECTION_UNRECOVERABLE	131: 频道连接不可恢复。
WARN_CHANNEL_CONNECTION_IP_CHANGED	132: IP 已改变。
WARN_CHANNEL_CONNECTION_PORT_CHANGED	133: 端口已改变。
WARN_AUDIO_MIXING_OPEN_ERROR	701: 打开伴奏出错。
WARN_ADM_RUNTIME_PLAYOUT_WARNING	1014: 音频设备模块：运行时播放设备出现警告。
WARN_ADM_RUNTIME_RECORDING_WARNING	1016: 音频设备模块：运行时音频采集设备出现警告。
WARN_ADM_RECORD_AUDIO_SILENCE	1019: 音频设备模块：没有采集到有效的声音数据。
WARN_ADM_PLAYOUT_MALFUNCTION	1020: 音频设备模块：播放频率异常，可能造成音频卡顿。该异常原因为系统 CPU 占用率高，建议结束其他可能占用 CPU 的 app。
WARN_ADM_RECORD_MALFUNCTION	1021: 音频设备模块：采集频率异常，可能造成音频卡顿。该异常原因为系统 CPU 占用率高，建议结束其他可能占用 CPU 的 app。
WARN_ADM_CALL_INTERRUPTION	1025: 本地音频采集被系统来电、Siri、闹钟中断。如需恢复本地音频采集，请用户中止电话、Siri、闹钟。
WARN_ADM_IOS_CATEGORY_NOT_PLAYANDRECORD	1029：在通话过程中，Audio Session 的 category 必须设置成 AVAudioSessionCategoryPlayAndRecord，RtcEngine 会监控这个属性值。当这个值被修改成其他值的时候会触发这个告警，并强制设置回 AVAudioSessionCategoryPlayAndRecord。
WARN_ADM_RECORD_AUDIO_LOWLEVEL	1031: 音频设备模块：录到的声音太低。
WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL	1032: 音频设备模块：播放的声音太低。
WARN_ADM_RECORD_AUDIO_IS_ACTIVE	1033: 本地音频采集设备被其他应用占用。请用户依次离开频道、停止在其他应用中进行的音频采集，重新加入频道。
WARN_ADM_WINDOWS_NO_DATA_READY_EVENT	1040: 音频设备模块：音频驱动异常。解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动
WARN_ADM_INCONSISTENT_AUDIO_DEVICE	1042: 音频采集设备和播放设备不一致，可能引起回声，建议使用同一设备采集和播放音频。
WARN_APM_HOWLING	1051: （仅通信场景）音频信号处理模块：采集音频时监测到啸叫。
WARN_ADM_GLITCH_STATE	1052: 音频设备模块：音频播放会卡顿。
WARN_APM_RESIDUAL_ECHO	1053: 音频信号处理模块：检测到残余回声，该回声可能由系统线程调度不及时或信号溢出导致。
WARN_ADM_WIN_CORE_NO_PLAYOUT_DEVICE	1323: 音频设备模块：无可用音频播放设备。解决方案：插入音频设备
WARN_ADM_WIN_CORE_IMPROPER_CAPTURE_RELEASE	1324: 音频设备模块：音频采集释放有误。解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动。
WARN_SUPER_RESOLUTION_STREAM_OVER_LIMITATION	1610: 远端用户的原始视频分辨率超出了可以应用超分辨率的范围。
WARN_SUPER_RESOLUTION_USER_COUNT_OVER_LIMITATION	1611: 已对一个远端用户的视频使用超分辨率。
WARN_SUPER_RESOLUTION_DEVICE_NOT_SUPPORTED	1612: 设备不支持使用超分辨率。

◆ ERROR_CODE_TYPE

enum agora::ERROR_CODE_TYPE

错误代码

错误代码意味着 SDK 遇到不可恢复的错误，需要应用程序干预，例如打开摄像头失败会返回错误，应用程序需要提示用户不能使用摄像头。

枚举值
ERR_OK	0: 没有错误。
ERR_FAILED	1: 一般性的错误（没有明确归类的错误原因）。
ERR_INVALID_ARGUMENT	2: API 调用了无效的参数。例如指定的频道名含有非法字符。
ERR_NOT_READY	3: RTC 引擎初始化失败。处理方法：检查音频设备状态。检查程序集完整性。尝试重新初始化 RTC 引擎。
ERR_NOT_SUPPORTED	4: RTC 引擎当前状态不支持此项操作。
ERR_REFUSED	5: 调用被拒绝。
ERR_BUFFER_TOO_SMALL	6: 传入的缓冲区大小不足以存放返回的数据。
ERR_NOT_INITIALIZED	7: SDK 尚未初始化，就调用其 API。请确认在调用 API 之前已创建 RtcEngine 对象并完成初始化。
ERR_NO_PERMISSION	9: 没有操作权限，请检查用户是否授予 app 音视频设备使用权限。
ERR_TIMEDOUT	10: API 调用超时。有些 API 调用需要 SDK 返回结果，如果 SDK 处理事件过长，超过 10 秒没有返回，会出现此错误。
ERR_CANCELED	11: 请求被取消。仅供 SDK 内部使用，不通过 API 或者回调事件返回给 App。
ERR_TOO_OFTEN	12: 调用频率太高。
ERR_BIND_SOCKET	13: SDK 内部绑定到网络 Socket 失败。仅供 SDK 内部使用，不通过 API 或者回调事件返回给 App。
ERR_NET_DOWN	14: 网络不可用。仅供 SDK 内部使用，不通过 API 或者回调事件返回给 App。
ERR_NET_NOBUFS	15: 没有网络缓冲区可用。仅供 SDK 内部使用，不通过 API 或者回调事件返回给 App。
ERR_JOIN_CHANNEL_REJECTED	17: 加入频道被拒绝。一般有以下原因：用户已进入频道，再次调用加入频道的 API，例如 joinChannel ，会返回此错误。停止调用该方法即可。用户在调用 startEchoTest 进行通话测试时，尝试加入频道。通话测试开始后，需要先调用 stopEchoTest 结束当前测试，再加入频道。使用已过期的 Token 调用 joinChannel 时也会返回此错误。请使用有效的 Token 重新加入频道。
ERR_LEAVE_CHANNEL_REJECTED	18: 离开频道失败。一般有以下原因：用户已离开频道，再次调用退出频道的 API，例如 leaveChannel ，会返回此错误。停止调用该方法即可。用户尚未加入频道，就调用退出频道的 API。这种情况下无需额外操作。
ERR_ALREADY_IN_USE	19: 资源已被占用，不能重复使用。
ERR_ABORTED	20: SDK 放弃请求，可能由于请求次数太多。
ERR_INIT_NET_ENGINE	21: Windows 下特定的防火墙设置导致 SDK 初始化失败然后崩溃。
ERR_RESOURCE_LIMITED	22: 当用户 App 占用资源过多，或系统资源耗尽时，SDK 分配资源失败会返回该错误。
ERR_INVALID_APP_ID	101: 不是有效的 App ID。请更换有效的 App ID 重新加入频道。
ERR_INVALID_CHANNEL_NAME	102: 不是有效的频道名。请更换有效的频道名重新加入频道。
ERR_NO_SERVER_RESOURCES	103: 无法获取当前指定区域的服务器资源。请在调用 initialize 方法时尝试指定其他区域。
ERR_TOKEN_EXPIRED	弃用: 109: 从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_TOKEN_EXPIRED(9)。当前使用的 Token 过期，不再有效。一般有以下原因： Token 授权时间戳无效：Token 授权时间戳为 Token 生成时的时间戳，自 1970 年 1 月 1 日开始到当前时间的描述。授权该 Token 在生成后的 24 小时内可以访问声网服务。如果 24 小时内没有访问，则该 Token 无法再使用。需要重新在服务端申请生成 Token。 Token 服务到期时间戳已过期：用户设置的服务到期时间戳小于当前时间戳，无法继续使用声网服务（比如正在进行的通话会被强制终止）；设置服务到期时间并不意味着 Token 失效，而仅仅用于限制用户使用当前服务的时间。需要重新在服务端申请生成 Token。
ERR_INVALID_TOKEN	弃用: 110: 从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_INVALID_TOKEN(8)。生成的 Token 无效，一般有以下原因：用户在控制台上启用了 App Certificate，但仍旧在代码里仅使用了 App ID。当启用了 App Certificate，必须使用 Token。字段 `uid` 为生成 Token 的必须字段，用户在调用 joinChannel 加入频道时必须设置相同的 `uid`。
ERR_CONNECTION_INTERRUPTED	111: 网络连接中断。仅适用于 RTC Web SDK。
ERR_CONNECTION_LOST	112: 网络连接丢失。仅适用于 RTC Web SDK。
ERR_NOT_IN_CHANNEL	113: 用户不在频道内。
ERR_SIZE_TOO_LARGE	114: 在调用 sendStreamMessage 时，当发送的数据长度大于 1024 个字节时，会发生该错误。
ERR_BITRATE_LIMIT	115: 在调用 sendStreamMessage 时，当发送的数据频率超过限制时（6 KB/s），会发生该错误。
ERR_TOO_MANY_DATA_STREAMS	116: 在调用 createDataStream 时，如果创建的数据通道过多（超过 5 个通道），会发生该错误。
ERR_STREAM_MESSAGE_TIMEOUT	117: 数据流发送超时。
ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED	119: 自 v3.7.0 起废弃。请改用 `onClientRoleChangeFailed` 回调中的 `CLIENT_ROLE_CHANGE_FAILED_REASON`。
ERR_DECRYPTION_FAILED	120: 解密失败，可能是用户加入频道用了不同的密码。请检查加入频道时的设置，或尝试重新加入频道。
ERR_CLIENT_IS_BANNED_BY_SERVER	123: 此用户被服务器禁止。服务端踢人场景时会报这个错。
ERR_WATERMARK_PARAM	124: 水印文件参数错误。
ERR_WATERMARK_PATH	125: 水印文件路径错误。
ERR_WATERMARK_PNG	126: 水印文件格式错误。
ERR_WATERMARKR_INFO	127: 水印文件信息错误。
ERR_WATERMARK_ARGB	128: 水印文件数据格式错误。
ERR_WATERMARK_READ	129: 水印文件读取错误。
ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH	130: 在调用 addPublishStreamUrl 时，如果开启了加密，则会返回该错误(推流不支持加密流)。
ERR_INVALID_USER_ACCOUNT	134: 无效的 User account.
ERR_PUBLISH_STREAM_CDN_ERROR	151: CDN 相关错误。请调用 removePublishStreamUrl 方法删除原来的推流地址，然后调用 addPublishStreamUrl 方法重新推流到新地址。
ERR_PUBLISH_STREAM_NUM_REACH_LIMIT	152: 单个主播的推流地址数目达到上限 10。请删掉一些不用的推流地址再增加推流地址。
ERR_PUBLISH_STREAM_NOT_AUTHORIZED	153: 操作不属于主播自己的流，如更新其他主播的流参数、停止其他主播的流。请检查 App 逻辑。
ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR	154: 推流服务器出现错误。请调用 addPublishStreamUrl 重新推流
ERR_PUBLISH_STREAM_NOT_FOUND	155: 服务器无法找到数据流。
ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED	156: 推流地址格式有错误。请检查推流地址格式是否正确
ERR_MODULE_NOT_FOUND	157: 尚未集成必要的动态库。例如，调用 enableDeepLearningDenoise 前，你没有将用于 AI 降噪的动态库集成到项目中。
ERR_ALREADY_IN_RECORDING	160: 客户端正在录音。如需开始新的录音，请先调用 stopAudioRecording 停止当前录音，再调用 startAudioRecording。
ERR_LOAD_MEDIA_ENGINE	1001: 加载媒体引擎失败。
ERR_START_CALL	1002: 启动媒体引擎开始通话失败。请尝试重新进入频道。
ERR_START_CAMERA	弃用: 1003: 从 v2.4.1 起废弃。请改用 onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4)。启动摄像头失败，请检查摄像头是否被其他应用占用，或者尝试重新进入频道。
ERR_START_VIDEO_RENDER	1004: 启动视频渲染模块失败。
ERR_ADM_GENERAL_ERROR	1005: 音频设备模块：音频设备出现错误（未明确指明为何种错误）。请检查音频设备是否被其他应用占用，或者尝试重新进入频道。
ERR_ADM_JAVA_RESOURCE	1006: 音频设备模块：使用 Java 资源出现错误。
ERR_ADM_SAMPLE_RATE	1007: 音频设备模块：设置的采样频率出现错误。
ERR_ADM_INIT_PLAYOUT	1008: 音频设备模块：初始化播放设备出现错误。请检查播放设备是否被其他应用占用，或者尝试重新进入频道。
ERR_ADM_START_PLAYOUT	1009: 音频设备模块：启动播放设备出现错误。请检查播放设备是否正常。
ERR_ADM_STOP_PLAYOUT	1010: 音频设备模块：停止播放设备出现错误。
ERR_ADM_INIT_RECORDING	1011: 音频设备模块：初始化音频采集设备时出现错误。请检查音频采集设备是否正常，或者尝试重新进入频道。
ERR_ADM_START_RECORDING	1012: 音频设备模块：启动音频采集设备出现错误。请检查音频采集设备是否正常。
ERR_ADM_STOP_RECORDING	1013: 音频设备模块：停止音频采集设备出现错误。
ERR_ADM_RUNTIME_PLAYOUT_ERROR	1015: 音频设备模块：运行时播放出现错误。请检查播放设备是否正常，或者尝试重新进入频道。
ERR_ADM_RUNTIME_RECORDING_ERROR	1017: 音频设备模块：运行时采集音频错误。请检查音频采集设备是否正常，或者尝试重新进入频道。
ERR_ADM_RECORD_AUDIO_FAILED	1018: 音频设备模块：采集音频失败。
ERR_ADM_INIT_LOOPBACK	1022: 音频设备模块：初始化 Loopback 设备错误。
ERR_ADM_START_LOOPBACK	1023: 音频设备模块：启动 Loopback 设备错误。
ERR_ADM_NO_PERMISSION	1027: 没有使用麦克风的权限。请提示用户开启使用麦克风的权限再重新加入频道。
ERR_ADM_RECORD_AUDIO_IS_ACTIVE	1033: 本地音频采集设备被其他应用占用。请用户依次离开频道、停止在其他应用中进行的音频采集，重新加入频道。
ERR_ADM_ANDROID_JNI_JAVA_RESOURCE	1101: 音频设备模块：严重异常。
ERR_ADM_ANDROID_JNI_NO_RECORD_FREQUENCY	1108: 音频采集线程中出现异常。请用户重新加入频道。
ERR_ADM_ANDROID_JNI_NO_PLAYBACK_FREQUENCY	1109: 音频播放线程中出现异常。请用户重新加入频道。
ERR_ADM_ANDROID_JNI_JAVA_START_RECORD	1111: 开启本地音频采集失败。请用户重新加入频道。
ERR_ADM_ANDROID_JNI_JAVA_START_PLAYBACK	1112: 开启本地音频播放失败。请用户重新加入频道。
ERR_ADM_ANDROID_JNI_JAVA_RECORD_ERROR	1115: 音频设备模块：AudioRecord 数据返回错误、SDK 会自动处理、重启 AudioRecord。
ERR_ADM_ANDROID_OPENSL_CREATE_ENGINE	弃用:
ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_RECORDER	1153: 创建 Audio Recorder 失败。请用户重新加入频道。
ERR_ADM_ANDROID_OPENSL_START_RECORDER_THREAD	1156: 开启本地音频采集失败。请用户重新加入频道。
ERR_ADM_ANDROID_OPENSL_CREATE_AUDIO_PLAYER	1157: 创建 Audio Player 失败。请用户重新加入频道。
ERR_ADM_ANDROID_OPENSL_START_PLAYER_THREAD	1160: 开启本地音频播放失败。请用户重新加入频道。
ERR_ADM_IOS_INPUT_NOT_AVAILABLE	1201: 音频设备模块：当前设备不支持音频输入，可能的原因是 Audio Session 的 category 配置不对或音频输入设备被占用。建议把后台所有 App 杀掉，重新加入频道。
ERR_ADM_IOS_ACTIVATE_SESSION_FAIL	1206: 音频设备模块：Audio Session 无法被启动。
ERR_ADM_IOS_VPIO_INIT_FAIL	1210: 音频设备模块：初始化音频设备出错。一般出错是因为音频设备的设置参数错误。
ERR_ADM_IOS_VPIO_REINIT_FAIL	1213: 音频设备模块：重新初始化音频设备出错。一般出错是因为音频设备的设置参数错误。
ERR_ADM_IOS_VPIO_RESTART_FAIL	1214: 音频设备模块：重新启动 Audio Unit 出错。一般出错是因为 Audio Session 的 category 设置与 Audio Unit 的设置不兼容。
ERR_ADM_IOS_SET_RENDER_CALLBACK_FAIL
ERR_ADM_IOS_SESSION_SAMPLERATR_ZERO	弃用:
ERR_ADM_WIN_CORE_INIT	1301: 音频设备模块：音频驱动异常或者兼容性问题解决方案：禁用并重新启用音频设备，或者重启机器。
ERR_ADM_WIN_CORE_INIT_RECORDING	1303: 音频设备模块：音频驱动异常或者兼容性问题解决方案：禁用并重新启用音频设备，或者重启机器。
ERR_ADM_WIN_CORE_INIT_PLAYOUT	1306: 音频设备模块：音频驱动异常或者兼容性问题解决方案：禁用并重新启用音频设备，或者重启机器。
ERR_ADM_WIN_CORE_INIT_PLAYOUT_NULL	1307: 音频设备模块：无可用音频设备解决方案：插入音频设备。
ERR_ADM_WIN_CORE_START_RECORDING	1309: 音频设备模块：音频驱动异常或者兼容性问题解决方案：禁用并重新启用音频设备，或者重启机器。
ERR_ADM_WIN_CORE_CREATE_REC_THREAD	1311: 音频设备模块：系统内存不足或者机器性能较差解决方案：重启机器或者更换机器。
ERR_ADM_WIN_CORE_CAPTURE_NOT_STARTUP	1314: 音频设备模块：音频驱动异常解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动。
ERR_ADM_WIN_CORE_CREATE_RENDER_THREAD	1319: 音频设备模块：系统内存不足或者机器性能较差解决方案：重启机器或者更换机器。
ERR_ADM_WIN_CORE_RENDER_NOT_STARTUP	1320: 音频设备模块：音频驱动异常解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动。
ERR_ADM_WIN_CORE_NO_RECORDING_DEVICE	1322: 音频设备模块：无可用音频采集设备。解决方案：插入音频设备。
ERR_ADM_WIN_CORE_NO_PLAYOUT_DEVICE	1323: 音频设备模块：无可用音频播放设备。解决方案：插入音频设备。
ERR_ADM_WIN_WAVE_INIT	1351: 音频设备模块：音频驱动异常或者兼容性问题解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动。
ERR_ADM_WIN_WAVE_INIT_RECORDING	1353: 音频设备模块：音频驱动异常解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动。
ERR_ADM_WIN_WAVE_INIT_MICROPHONE	1354: 音频设备模块：音频驱动异常解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动。
ERR_ADM_WIN_WAVE_INIT_PLAYOUT	1355: 音频设备模块：音频驱动异常解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动。
ERR_ADM_WIN_WAVE_INIT_SPEAKER	1356: 音频设备模块：音频驱动异常解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动。
ERR_ADM_WIN_WAVE_START_RECORDING	1357: 音频设备模块：音频驱动异常解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动。
ERR_ADM_WIN_WAVE_START_PLAYOUT	1358: 音频设备模块：音频驱动异常解决方案：禁用并重新启用音频设备，或者重启机器，或者更新声卡驱动。
ERR_ADM_NO_RECORDING_DEVICE	1359: 音频设备模块：无采集设备。请检查是否有可用的录放音设备或者录放音设备是否已经被其他应用占用。
ERR_ADM_NO_PLAYOUT_DEVICE	1360: 音频设备模块：无播放设备。
ERR_VDM_CAMERA_NOT_AUTHORIZED	1501: 视频设备模块：没有摄像头使用权限。请检查是否已经打开摄像头权限。
ERR_VDM_WIN_DEVICE_IN_USE	弃用: 1502: 视频设备模块：摄像头正在使用中。从 v2.4.1 起废弃。请改用 onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY(3)。
ERR_VCM_UNKNOWN_ERROR	1600: 视频设备模块：未知错误。
ERR_VCM_ENCODER_INIT_ERROR	1601: 视频设备模块：视频编码器初始化错误。该错误为严重错误，请尝试重新加入频道。
ERR_VCM_ENCODER_ENCODE_ERROR	1602: 视频设备模块：视频编码器错误。该错误为严重错误，请尝试重新加入频道。
ERR_VCM_ENCODER_SET_ERROR	1603: 视频设备模块：视频编码器设置错误。
ERR_ADM_WIN_CORE_SERVRE_SHUT_DOWN	1735：Windows Audio 服务被关闭。你需要开启 Windows Audio 服务或重启设备。自从 v3.5.0
ERR_NOT_SUPPORTED_MUTI_GPU_EXCLUDE_WINDOW	1736:（仅 Windows）SDK 不支持你在多显卡的设备上设置 `excludeWindowList` 屏蔽窗口。自从 v3.7.0

◆ LOG_FILTER_TYPE

enum agora::LOG_FILTER_TYPE

日志过滤分级

枚举值
LOG_FILTER_OFF	0: 不输出日志信息。
LOG_FILTER_DEBUG	0x080f: 输出所有 API 日志信息。如果你想获取最完整的日志，可以将日志级别设为该等级。
LOG_FILTER_INFO	0x000f: 输出 CRITICAL、ERROR、WARNING 和 INFO 级别的日志信息。我们推荐你将日志级别设为该等级。
LOG_FILTER_WARN	0x000e: 输出 CRITICAL、ERROR 和 WARNING 级别的日志信息。
LOG_FILTER_ERROR	0x000c: 输出 CRITICAL 和 ERROR 级别的日志信息。
LOG_FILTER_CRITICAL	0x0008: 输出 CRITICAL 级别的日志信息。

◆ LOG_LEVEL

enum class agora::LOG_LEVEL

strong

日志输出级别。

自从: v3.3.0

枚举值
LOG_LEVEL_NONE	0: 不输出任何日志。
LOG_LEVEL_INFO	0x0001: (默认) 输出 FATAL、ERROR、WARN、INFO 级别的日志。我们推荐你将日志级别设为该等级。
LOG_LEVEL_WARN	0x0002: 仅输出 FATAL、ERROR、WARN 级别的日志。
LOG_LEVEL_ERROR	0x0004: 仅输出 FATAL、ERROR 级别的日志。
LOG_LEVEL_FATAL	0x0008: 仅输出 FATAL 级别的日志。

C++ API Reference for All Platforms

命名空间

枚举

枚举类型说明

◆ INTERFACE_ID_TYPE

◆ WARN_CODE_TYPE

◆ ERROR_CODE_TYPE

◆ LOG_FILTER_TYPE

◆ LOG_LEVEL