agora::rtc 命名空间参考 | 声网文档中心

类型定义说明

uid_t

typedef unsigned int agora::rtc::uid_t

track_id_t

typedef unsigned int agora::rtc::track_id_t

conn_id_t

typedef unsigned int agora::rtc::conn_id_t

USER_OFFLINE_REASON_TYPE

enum agora::rtc::USER_OFFLINE_REASON_TYPE

用户离线原因。

枚举值
USER_OFFLINE_QUIT	0: 用户主动离开。
USER_OFFLINE_DROPPED	1:因过长时间收不到对方数据包，超时掉线。由于 SDK 使用的是不可靠通道，也有可能对方主动离开频道，但是本地没收到对方离开消息而误判为超时掉线。
USER_OFFLINE_BECOME_AUDIENCE	2: 用户身份从主播切换为观众。

QUALITY_TYPE

enum agora::rtc::QUALITY_TYPE

网络质量类型。

枚举值
QUALITY_UNKNOWN	0: 质量未知。
QUALITY_EXCELLENT	1: 质量极好。
QUALITY_GOOD	2: 用户主观感觉和极好差不多，但码率可能略低于极好。
QUALITY_POOR	3: 用户主观感受有瑕疵但不影响沟通。
QUALITY_BAD	4: 勉强能沟通但不顺畅。
QUALITY_VBAD	5: 网络质量非常差，基本不能沟通。
QUALITY_DOWN	6: 网络连接断开，完全无法沟通。

VIDEO_ORIENTATION

enum agora::rtc::VIDEO_ORIENTATION

视频旋转信息。

枚举值
VIDEO_ORIENTATION_0	0: 顺时针旋转 0 度。
VIDEO_ORIENTATION_90	90: 顺时针旋转 90 度。
VIDEO_ORIENTATION_180	180: 顺时针旋转 180 度。
VIDEO_ORIENTATION_270	270: 顺时针旋转 270 度。

FRAME_RATE

enum agora::rtc::FRAME_RATE

视频帧率。

枚举值
FRAME_RATE_FPS_1	1: 1 fps
FRAME_RATE_FPS_7	7: 7 fps
FRAME_RATE_FPS_10	10: 10 fps
FRAME_RATE_FPS_15	15: 15 fps
FRAME_RATE_FPS_24	24: 24 fps
FRAME_RATE_FPS_30	30: 30 fps
FRAME_RATE_FPS_60	60: 60 fps。仅适用于 Windows 和 macOS 平台。

FRAME_WIDTH

enum agora::rtc::FRAME_WIDTH

视频帧宽度。

枚举值
FRAME_WIDTH_640	640：640 像素

FRAME_HEIGHT

enum agora::rtc::FRAME_HEIGHT

视频帧高度。

枚举值
FRAME_HEIGHT_360	360：360 像素

VIDEO_FRAME_TYPE

enum agora::rtc::VIDEO_FRAME_TYPE

视频帧类型。

枚举值
VIDEO_FRAME_TYPE_BLANK_FRAME	0：空白帧
VIDEO_FRAME_TYPE_KEY_FRAME	3：关键帧。对于 H.264 编码格式，SDK 把带有 sps 和 pps 信息的 I 帧归类为关键帧。
VIDEO_FRAME_TYPE_DELTA_FRAME	4：Delta 帧。对于 H.264 编码格式，SDK 把 P 帧和不带 sps 和 pps 信息的 I 帧都归类为 Delta 帧。
VIDEO_FRAME_TYPE_B_FRAME	5：B 帧
VIDEO_FRAME_TYPE_DROPPABLE_FRAME	6：丢弃帧
VIDEO_FRAME_TYPE_UNKNOW	7：未知

ORIENTATION_MODE

enum agora::rtc::ORIENTATION_MODE

视频编码的方向模式。

枚举值
ORIENTATION_MODE_ADAPTIVE	0: （默认）该模式下 SDK 输出的视频方向与采集到的视频方向一致。接收端会根据收到的视频旋转信息对视频进行旋转。该模式适用于接收端可以调整视频方向的场景。如果采集的视频是横屏模式，则输出的视频也是横屏模式。如果采集的视频是竖屏模式，则输出的视频也是竖屏模式。
ORIENTATION_MODE_FIXED_LANDSCAPE	1: 该模式下 SDK 固定输出风景（横屏）模式的视频。如果采集到的视频是竖屏模式，则视频编码器会对其进行裁剪。该模式适用于接收端无法调整视频方向的场景，如直推 CDN。
ORIENTATION_MODE_FIXED_PORTRAIT	2: 该模式下 SDK 固定输出人像（竖屏）模式的视频，如果采集到的视频是横屏模式，则视频编码器会对其进行裁剪。该模式适用于接收端无法调整视频方向的场景，如直推 CDN。

DEGRADATION_PREFERENCE

enum agora::rtc::DEGRADATION_PREFERENCE

带宽受限时的视频编码降级偏好。

枚举值
MAINTAIN_QUALITY	0: （默认）带宽受限时，视频编码时优先降低视频帧率，维持视频质量不变。该降级偏好适用于画质优先的场景。
MAINTAIN_FRAMERATE	1: 带宽受限时，视频编码时优先降低视频质量，维持视频帧率不变。该降级偏好适用于流畅性优先且允许画质降低的场景。
MAINTAIN_BALANCED	2: 带宽受限时，视频编码时同时降低视频帧率和视频质量。MAINTAIN_BALANCED 的降幅比 MAINTAIN_QUALITY 和 MAINTAIN_FRAMERATE 降幅更低，适用于流畅性和画质均有限的场景。
MAINTAIN_RESOLUTION	3: 带宽受限时，视频编码时优先降低视频帧率。

VIDEO_CODEC_TYPE

enum agora::rtc::VIDEO_CODEC_TYPE

视频编码类型。

枚举值
VIDEO_CODEC_NONE	0: 无
VIDEO_CODEC_VP8	1: VP8
VIDEO_CODEC_H264	2: H.264
VIDEO_CODEC_H265	3: H.265
VIDEO_CODEC_VP9	5: VP9
VIDEO_CODEC_GENERIC	6: Generic
VIDEO_CODEC_GENERIC_H264	7: Generic H264
VIDEO_CODEC_AV1	12: AV1
VIDEO_CODEC_GENERIC_JPEG	20: JPEG

AUDIO_CODEC_TYPE

enum agora::rtc::AUDIO_CODEC_TYPE

音频编码类型。

枚举值
AUDIO_CODEC_OPUS	1: OPUS
AUDIO_CODEC_PCMA	3: PCMA
AUDIO_CODEC_PCMU	4: PCMU
AUDIO_CODEC_G722	5: G722
AUDIO_CODEC_AACLC	8: AAC LC
AUDIO_CODEC_HEAAC	9: HE AAC
AUDIO_CODEC_HEAAC2	11: HEAAC2

VIDEO_STREAM_TYPE

enum agora::rtc::VIDEO_STREAM_TYPE

视频流类型。

枚举值
VIDEO_STREAM_HIGH	0: 大流。分辨率和码率较高。
VIDEO_STREAM_LOW	1: 小流。分辨率和码率较低。

VIDEO_MIRROR_MODE_TYPE

enum agora::rtc::VIDEO_MIRROR_MODE_TYPE

镜像模式类型。

枚举值
VIDEO_MIRROR_MODE_AUTO	0：（默认）由 SDK 决定镜像模式。
VIDEO_MIRROR_MODE_ENABLED	1: 启用镜像模式。
VIDEO_MIRROR_MODE_DISABLED	2: 关闭镜像模式。

SIMULCAST_STREAM_MODE

enum agora::rtc::SIMULCAST_STREAM_MODE

发送视频流的模式。

枚举值
AUTO_SIMULCAST_STREAM	-1：默认不发送小流，直至收到接收端发起的订阅小流申请时，自动切换为发送小流模式。
DISABLE_SIMULCAST_STREAM	0：始终不发送小流。
ENABLE_SIMULCAST_STREAM	1：始终发送小流。

VIDEO_SOURCE_TYPE

enum agora::rtc::VIDEO_SOURCE_TYPE

视频源的类型。

枚举值
VIDEO_SOURCE_CAMERA_PRIMARY	0：（默认）第一个摄像头。
VIDEO_SOURCE_CAMERA	0：摄像头。
VIDEO_SOURCE_CAMERA_SECONDARY	1：第二个摄像头。
VIDEO_SOURCE_SCREEN_PRIMARY	2：第一个屏幕。
VIDEO_SOURCE_SCREEN	2：屏幕。
VIDEO_SOURCE_SCREEN_SECONDARY	3：第二个屏幕。
VIDEO_SOURCE_CUSTOM	4：自定义的视频源。
VIDEO_SOURCE_MEDIA_PLAYER	5：媒体播放器共享的视频源。
VIDEO_SOURCE_RTC_IMAGE_PNG	6：视频源为 PNG 图片。
VIDEO_SOURCE_RTC_IMAGE_JPEG	7：视频源为 JPEG 图片。
VIDEO_SOURCE_RTC_IMAGE_GIF	8：视频源为 GIF 图片。
VIDEO_SOURCE_REMOTE	9：视频源为网络获取的远端视频。
VIDEO_SOURCE_TRANSCODED	10：转码后的视频源。
VIDEO_SOURCE_UNKNOWN	11：未知的视频源。

CLIENT_ROLE_TYPE

enum agora::rtc::CLIENT_ROLE_TYPE

用户角色类型。

枚举值
CLIENT_ROLE_BROADCASTER	1: 主播。主播可以同时发送和接收媒体流。
CLIENT_ROLE_AUDIENCE	2: 观众。观众只能接收媒体流。

QUALITY_ADAPT_INDICATION

enum agora::rtc::QUALITY_ADAPT_INDICATION

视频质量变化提示。

枚举值
ADAPT_NONE	0：本地视频质量不变。
ADAPT_UP_BANDWIDTH	1：由于网络带宽增加导致质量提升。
ADAPT_DOWN_BANDWIDTH	2：由于网络带宽降低导致质量下降。

EXPERIENCE_QUALITY_TYPE

enum agora::rtc::EXPERIENCE_QUALITY_TYPE

接收远端音频时，本地用户的主观体验质量。

枚举值
EXPERIENCE_QUALITY_GOOD	0: 主观体验质量较好。
EXPERIENCE_QUALITY_BAD	1: 主观体验质量较差。

EXPERIENCE_POOR_REASON

enum agora::rtc::EXPERIENCE_POOR_REASON

接收远端音频时，本地用户主观体验质量较差的原因。

枚举值
EXPERIENCE_REASON_NONE	0: 无原因，说明主观体验质量较好。
REMOTE_NETWORK_QUALITY_POOR	1: 远端用户的网络较差。
LOCAL_NETWORK_QUALITY_POOR	2: 本地用户的网络较差。
WIRELESS_SIGNAL_POOR	4: 本地用户的 Wi-Fi 或者移动数据网络信号弱。
WIFI_BLUETOOTH_COEXIST	8: 本地用户同时开启 Wi-Fi 和蓝牙，二者信号互相干扰，导致音频传输质量下降。

AUDIO_PROFILE_TYPE

enum agora::rtc::AUDIO_PROFILE_TYPE

音频属性。设置采样率，码率，编码模式和声道数。

枚举值
AUDIO_PROFILE_DEFAULT	0: 默认音频场景。通信场景下：16 KHz 采样率，语音编码，单声道，编码码率最大值为 16 Kbps。直播场景下：48 KHz 采样率，音乐编码，单声道，编码码率最大值为 64 Kbps。
AUDIO_PROFILE_SPEECH_STANDARD	1: 指定 32 KHz 采样率，语音编码，单声道，编码码率最大值为 18 Kbps。
AUDIO_PROFILE_MUSIC_STANDARD	2: 指定 48 KHz 采样率，音乐编码，单声道，编码码率最大值为 64 Kbps。
AUDIO_PROFILE_MUSIC_STANDARD_STEREO	3: 指定 48 KHz 采样率，音乐编码，双声道，编码码率最大值为 80 Kbps。
AUDIO_PROFILE_MUSIC_HIGH_QUALITY	4: 指定 48 KHz 采样率，音乐编码，单声道，编码码率最大值为 96 Kbps。
AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO	5: 指定 48 KHz 采样率，音乐编码，双声道，编码码率最大值为 128 Kbps。
AUDIO_PROFILE_IOT	6: 指定 16 kHz 采样率，语音编码，单声道，应用回声消除算法 AES。
AUDIO_PROFILE_NUM	枚举值边界。

AUDIO_SCENARIO_TYPE

enum agora::rtc::AUDIO_SCENARIO_TYPE

音频应用场景。

枚举值
AUDIO_SCENARIO_DEFAULT	0: （默认）自动场景，根据用户角色和音频路由自动匹配合适的音质。
AUDIO_SCENARIO_GAME_STREAMING	3: 高音质场景，适用于音乐为主的场景。
AUDIO_SCENARIO_CHATROOM	5: 聊天室场景，适用于用户需要频繁上下麦的场景。该场景下，观众会收到申请麦克风权限的弹窗提示。
AUDIO_SCENARIO_CHORUS	7: 合唱场景，适用于网络条件良好，要求极低延时的实时合唱场景。
AUDIO_SCENARIO_MEETING	8: 会议场景，适用于人声为主的多人会议。
AUDIO_SCENARIO_NUM	枚举值边界。

LOCAL_AUDIO_STREAM_STATE

enum agora::rtc::LOCAL_AUDIO_STREAM_STATE

本地音频状态。

枚举值
LOCAL_AUDIO_STREAM_STATE_STOPPED	0: 本地音频位于初始状态。
LOCAL_AUDIO_STREAM_STATE_RECORDING	1: 音频录制设备成功启动。
LOCAL_AUDIO_STREAM_STATE_ENCODING	2: 第一个音频帧成功完成编码。
LOCAL_AUDIO_STREAM_STATE_FAILED	3: 本地音频启动失败。

LOCAL_AUDIO_STREAM_ERROR

enum agora::rtc::LOCAL_AUDIO_STREAM_ERROR

本地音频失败的原因。

枚举值
LOCAL_AUDIO_STREAM_ERROR_OK	0: 本地音频状态正常。
LOCAL_AUDIO_STREAM_ERROR_FAILURE	1: 原因未知。
LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION	2: 没有权限使用本地音频设备。
LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY	3: 麦克风被占用。
LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE	4: 本地音频录制失败。检查录制设备是否正常工作。
LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE	5: 本地音频编码失败。

LOCAL_VIDEO_STREAM_STATE

enum agora::rtc::LOCAL_VIDEO_STREAM_STATE

本地视频状态类型。

枚举值
LOCAL_VIDEO_STREAM_STATE_STOPPED	0: 初始状态。
LOCAL_VIDEO_STREAM_STATE_CAPTURING	1: 视频采集已开始。
LOCAL_VIDEO_STREAM_STATE_ENCODING	2: 第一个视频帧已编码。
LOCAL_VIDEO_STREAM_STATE_FAILED	3: 本地视频发送失败。

LOCAL_VIDEO_STREAM_ERROR

enum agora::rtc::LOCAL_VIDEO_STREAM_ERROR

本地视频出错原因。

枚举值
LOCAL_VIDEO_STREAM_ERROR_OK	0: 本地视频状态正常。
LOCAL_VIDEO_STREAM_ERROR_FAILURE	1: 出错原因不明确。
LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION	2: 没有权限启动本地视频采集设备。
LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY	3: 本地视频采集设备正在使用中。
LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE	4: 本地视频采集失败，建议检查采集设备是否正常工作。
LOCAL_VIDEO_STREAM_ERROR_ENCODE_FAILURE	5: 本地视频编码失败。

REMOTE_AUDIO_STATE

enum agora::rtc::REMOTE_AUDIO_STATE

远端音频流状态。

枚举值
REMOTE_AUDIO_STATE_STOPPED	0：远端音频默认初始状态。在 `REMOTE_AUDIO_STATE_REASON_LOCAL_MUTED`、 `REMOTE_AUDIO_STATE_REASON_REMOTE_MUTED` 或 `REMOTE_AUDIO_STATE_REASON_REMOTE_OFFLINE` 的情况下，会报告该状态。
REMOTE_AUDIO_STATE_STARTING	1: 本地用户已接收远端音频首包。
REMOTE_AUDIO_STATE_DECODING	2: 远端音频流正在解码，正常播放。在 `REMOTE_AUDIO_STATE_REASON_NETWORK_RECOVERY`、 `REMOTE_AUDIO_STATE_REASON_LOCAL_UNMUTED` 或 `REMOTE_AUDIO_STATE_REASON_REMOTE_UNMUTED` 的情况下，会报告该状态。
REMOTE_AUDIO_STATE_FROZEN	3: 远端音频流卡顿。在 `REMOTE_AUDIO_STATE_REASON_NETWORK_CONGESTION` 的情况下，会报告该状态。
REMOTE_AUDIO_STATE_FAILED	4: 远端音频流播放失败。在 `REMOTE_AUDIO_STATE_REASON_INTERNAL` 的情况下，会报告该状态。

REMOTE_AUDIO_STATE_REASON

enum agora::rtc::REMOTE_AUDIO_STATE_REASON

远端音频流状态切换原因。

枚举值
REMOTE_AUDIO_REASON_INTERNAL	0: 音频状态发生改变时，会报告该原因。
REMOTE_AUDIO_REASON_NETWORK_CONGESTION	1: 网络阻塞。
REMOTE_AUDIO_REASON_NETWORK_RECOVERY	2: 网络恢复正常。
REMOTE_AUDIO_REASON_LOCAL_MUTED	3: 本地用户停止接收远端音频流或本地用户禁用音频模块。
REMOTE_AUDIO_REASON_LOCAL_UNMUTED	4: 本地用户恢复接收远端音频流或本地用户启动音频模块。
REMOTE_AUDIO_REASON_REMOTE_MUTED	5: 远端用户停止发送音频流或远端用户禁用音频模块。
REMOTE_AUDIO_REASON_REMOTE_UNMUTED	6: 远端用户恢复发送音频流或远端用户启用音频模块。
REMOTE_AUDIO_REASON_REMOTE_OFFLINE	7: 远端用户离开频道。

REMOTE_VIDEO_STATE

enum agora::rtc::REMOTE_VIDEO_STATE

远端视频流状态。

枚举值
REMOTE_VIDEO_STATE_STOPPED	0: 远端视频默认初始状态。在 `REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED`、`REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED` 或 `REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE` 的情况下，会报告该状态。
REMOTE_VIDEO_STATE_STARTING	1: 本地用户已接收远端视频首包。
REMOTE_VIDEO_STATE_DECODING	2: 远端视频流正在解码，正常播放。在 `REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY`、`REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED`、`REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED` 或 `REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY` 的情况下，会报告该状态。
REMOTE_VIDEO_STATE_FROZEN	3: 远端视频流卡顿。在 `REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION` 或 `REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK` 的情况下，会报告该状态。
REMOTE_VIDEO_STATE_FAILED	4: 远端视频流播放失败。在 `REMOTE_VIDEO_STATE_REASON_INTERNAL` 的情况下，会报告该状态。

REMOTE_VIDEO_STATE_REASON

enum agora::rtc::REMOTE_VIDEO_STATE_REASON

远端视频流状态切换原因。

枚举值
REMOTE_VIDEO_STATE_REASON_INTERNAL	0: 视频状态发生改变时，会报告该原因。
REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION	1: 网络阻塞。
REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY	2: 网络恢复正常。
REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED	3: 本地用户停止接收远端视频流或本地用户禁用视频模块。
REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED	4: 本地用户恢复接收远端视频流或本地用户启动视频模块。
REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED	5: 远端用户停止发送视频流或远端用户禁用视频模块。
REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED	6: 远端用户恢复发送视频流或远端用户启用视频模块。
REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE	7: 远端用户离开频道。
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK	8: 弱网情况下，远端音视频流回退为音频流。
REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY	9: 网络情况改善时，远端音频流恢复为音视频流。

REMOTE_VIDEO_DOWNSCALE_LEVEL

enum agora::rtc::REMOTE_VIDEO_DOWNSCALE_LEVEL

远端视频缩小级别。级别越高，缩小程度越高。

枚举值
REMOTE_VIDEO_DOWNSCALE_LEVEL_NONE	0：不缩小。
REMOTE_VIDEO_DOWNSCALE_LEVEL_1	1：级别 1。
REMOTE_VIDEO_DOWNSCALE_LEVEL_2	2：级别 2。
REMOTE_VIDEO_DOWNSCALE_LEVEL_3	3：级别 3。
REMOTE_VIDEO_DOWNSCALE_LEVEL_4	4：级别 4。

CONNECTION_STATE_TYPE

enum agora::rtc::CONNECTION_STATE_TYPE

网络连接状态。

枚举值
CONNECTION_STATE_DISCONNECTED	1: 网络连接断开。
CONNECTION_STATE_CONNECTING	2: 建立网络连接中。
CONNECTION_STATE_CONNECTED	3: 网络已连接。
CONNECTION_STATE_RECONNECTING	4: 重新建立网络连接中。
CONNECTION_STATE_FAILED	5: 网络连接失败。

LASTMILE_PROBE_RESULT_STATE

enum agora::rtc::LASTMILE_PROBE_RESULT_STATE

Last mile 质量探测结果的状态。

枚举值
LASTMILE_PROBE_RESULT_COMPLETE	1: 表示本次 last mile 质量探测的结果是完整的。
LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE	2: 表示本次 last mile 质量探测未进行带宽预测，因此结果不完整。一个可能的原因是测试资源暂时受限。
LASTMILE_PROBE_RESULT_UNAVAILABLE	3: 未进行 last mile 质量探测。一个可能的原因是网络连接中断。

CONNECTION_CHANGED_REASON_TYPE

enum agora::rtc::CONNECTION_CHANGED_REASON_TYPE

连接状态变化原因。

枚举值
CONNECTION_CHANGED_CONNECTING	0: 建立网络连接中。
CONNECTION_CHANGED_JOIN_SUCCESS	1: 成功加入频道。
CONNECTION_CHANGED_INTERRUPTED	2: 网络连接中断。
CONNECTION_CHANGED_BANNED_BY_SERVER	3: 网络连接被服务器禁止。
CONNECTION_CHANGED_JOIN_FAILED	4: 加入频道失败。
CONNECTION_CHANGED_LEAVE_CHANNEL	5: 离开频道。
CONNECTION_CHANGED_INVALID_APP_ID	6: 不是有效的 APP ID。请更换有效的 APP ID 重新加入频道。
CONNECTION_CHANGED_INVALID_CHANNEL_NAME	7: 不是有效的频道名。请更换有效的频道名重新加入频道。
CONNECTION_CHANGED_INVALID_TOKEN	8: 生成的 Token 无效。一般有以下原因：在控制台上启用了 App Certificate，但加入频道未使用 Token。当启用了 App Certificate，必须使用 Token。在调用 `connect` 加入频道时指定的 uid 与生成 Token 时传入的 uid 不一致。
CONNECTION_CHANGED_TOKEN_EXPIRED	9: 生成的 Token 无效。
CONNECTION_CHANGED_REJECTED_BY_SERVER	10: 此用户被服务器禁止。
CONNECTION_CHANGED_SETTING_PROXY_SERVER	11: 由于设置了代理服务器，SDK 尝试重连。
CONNECTION_CHANGED_RENEW_TOKEN	12: 更新 Token 引起网络连接状态改变。
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED	13: 客户端 IP 地址变更，可能是由于网络类型，或网络运营商的 IP 或端口发生改变引起。
CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT	14: SDK 和服务器连接保活超时，进入自动重连状态。
CONNECTION_CHANGED_REJOIN_SUCCESS	15: 重新加入频道成功。
CONNECTION_CHANGED_LOST	16: SDK 和服务器失去连接。
CONNECTION_CHANGED_ECHO_TEST	17: 连接状态变化由回声测试引起。
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER	18: 用户更改了本地 IP 地址。

NETWORK_TYPE

enum agora::rtc::NETWORK_TYPE

网络连接类型。

枚举值
NETWORK_TYPE_UNKNOWN	-1: 网络连接类型未知。
NETWORK_TYPE_DISCONNECTED	0: 网络连接已断开。
NETWORK_TYPE_LAN	1: 网络类型为 LAN。
NETWORK_TYPE_WIFI	2: 网络类型为 Wi-Fi(包含热点）。
NETWORK_TYPE_MOBILE_2G	3: 网络类型为 2G 移动网络。
NETWORK_TYPE_MOBILE_3G	4: 网络类型为 3G 移动网络。
NETWORK_TYPE_MOBILE_4G	5: 网络类型为 4G 移动网络。

AREA_CODE

enum agora::rtc::AREA_CODE

访问区域。

枚举值
AREA_CODE_CN	0x00000001：中国大陆。
AREA_CODE_NA	0x00000002：北美区域。
AREA_CODE_EU	0x00000004：欧洲区域。
AREA_CODE_AS	0x00000008：除中国大陆以外的亚洲区域。
AREA_CODE_JP	0x00000010：日本。
AREA_CODE_IN	0x00000020：印度。
AREA_CODE_GLOB	0xFFFFFFFF：（默认）全球。

ENCRYPTION_MODE

enum agora::rtc::ENCRYPTION_MODE

内置加密模式。

枚举值
SM4_128_ECB	4: 128-bit SM4 加密，ECB 模式。

ENCRYPTION_ERROR_TYPE

enum agora::rtc::ENCRYPTION_ERROR_TYPE

内置加密的错误类型。

枚举值
ENCRYPTION_ERROR_INTERNAL_FAILURE	0：内部原因。
ENCRYPTION_ERROR_DECRYPTION_FAILURE	1：解密错误。请确保接收端和发送端使用的加密模式或密钥一致。
ENCRYPTION_ERROR_ENCRYPTION_FAILURE	2：加密错误。

MAX_USER_ACCOUNT_LENGTH_TYPE

enum agora::rtc::MAX_USER_ACCOUNT_LENGTH_TYPE

user account 的最大长度。

枚举值
MAX_USER_ACCOUNT_LENGTH	256：user account 的最大长度（字节）。

STREAM_SUBSCRIBE_STATE

enum agora::rtc::STREAM_SUBSCRIBE_STATE

流订阅状态。

枚举值
SUB_STATE_IDLE	0：加入频道后的初始订阅状态。
SUB_STATE_NO_SUBSCRIBED	1：订阅失败。
SUB_STATE_SUBSCRIBING	2：正在订阅。
SUB_STATE_SUBSCRIBED	3：收到了远端流，订阅成功。

STREAM_PUBLISH_STATE

enum agora::rtc::STREAM_PUBLISH_STATE

流发布状态。

枚举值
PUB_STATE_IDLE	0: 加入频道后的初始发布状态。
PUB_STATE_NO_PUBLISHED	1: 发布失败。
PUB_STATE_PUBLISHING	2: 正在发布。
PUB_STATE_PUBLISHED	3: 发布成功。

TCcMode

enum agora::rtc::TCcMode

阻塞控制模块选项。

枚举值
CC_ENABLED	0：开启阻塞控制模块。
CC_DISABLED	1：关闭阻塞控制模块。

BYTES_PER_SAMPLE

enum agora::rtc::BYTES_PER_SAMPLE

每个样本的字节数。

枚举值
TWO_BYTES_PER_SAMPLE	2：每个样本两个字节。

RAW_AUDIO_FRAME_OP_MODE_TYPE

enum agora::rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE

onRecordAudioFrame 或 onPlaybackAudioFrame 回调中返回的音频数据的使用模式。

枚举值
RAW_AUDIO_FRAME_OP_MODE_READ_ONLY	0: 只读模式，用户仅从 AudioFrame 获取原始数据，不作任何修改。
RAW_AUDIO_FRAME_OP_MODE_READ_WRITE	2: 读写模式, 用户从 AudioFrame 获取并修改数据，并返回给 SDK 进行编码传输。

RTMP_CONNECTION_ERROR

enum agora::rtc::RTMP_CONNECTION_ERROR

推流错误信息。

枚举值
RTMP_CONNECTION_ERR_OK	0: 推流成功。
RTMP_CONNECTION_ERR_FAILED	1: 一般性错误。
RTMP_CONNECTION_ERR_INVALID_URL	2: 推流 URL 无效。请检查输入的 URL 是否正确。
RTMP_CONNECTION_ERR_BAD_NAME	3: 该推流 URL 已用于推流。如果你想开始新的推流，请使用新的推流 URL。

RTMP_CONNECTION_STATE

enum agora::rtc::RTMP_CONNECTION_STATE

SDK 与 CDN 的连接状态。

枚举值
STATE_DISCONNECTED	1: SDK 与 CDN 断开连接。以下操作会让 SDK 进入该状态：调用 createRtmpConnection，即 SDK 与 CDN 的初始连接状态。调用 disconnect。
STATE_CONNECTING	2: SDK 正在连接 CDN。调用 connect 连接 CDN 的过程中，SDK 会进入该状态。
STATE_CONNECTED	3: SDK 已连接 CDN。调用 connect 成功连接 CDN 时，SDK 会进入该状态，你可以开始向 CDN 推流。
STATE_RECONNECTING	4: SDK 正在重新连接 CDN。在弱网环境或用户切换网络类型等情况下，如果 SDK 与 CDN 断开连接，SDK 会尝试重新连接 CDN 并进入该状态。
STATE_FAILED	5: SDK 连接 CDN 失败。以下情况会让 SDK 进入该状态：调用 connect 连接 CDN 失败时。在弱网环境或用户切换网络类型等情况下，SDK 重新连接 CDN 失败时。该状态下，如需连接 CDN，你需要先调用 disconnect 断开连接，再调用 connect。
STATE_RECONNECTED	6: SDK 已重新连接 CDN。在弱网环境或用户切换网络类型等情况下，如果 SDK 与 CDN 断开连接，则 SDK 重新连接 CDN 成功时会进入该状态。你可以继续向 CDN 推流。

PublishAudioError

enum agora::rtc::PublishAudioError

推送音频帧失败的错误码。

枚举值
PUBLISH_AUDIO_ERR_OK	0: 推送成功。
PUBLISH_AUDIO_ERR_FAILED	1: 一般性错误。

PublishVideoError

enum agora::rtc::PublishVideoError

推送视频帧失败的错误码。

枚举值
PUBLISH_VIDEO_ERR_OK	0: 推送成功。
PUBLISH_VIDEO_ERR_FAILED	1: 一般性错误。

ImageType

enum agora::rtc::ImageType

图像类型。

枚举值
kPng	PNG。
kJpeg	JPEG。
kGif	Gif。

StreamLayerIndexInternal

enum agora::rtc::StreamLayerIndexInternal

定义 YUV 视频流的索引，用于标识不同的流。

枚举值
STREAM_LAYER_1	`1`: 第 1 路流。
STREAM_LAYER_2	`2`: 第 2 路流。
STREAM_LAYER_3	`3`: 第 3 路流。
STREAM_LAYER_4	`4`: 第 4 路流。
STREAM_LAYER_5	`5`: 第 5 路流。
STREAM_LAYER_6	`6`: 第 6 路流。
STREAM_LOW	`7`: 视频小流。
STREAM_LAYER_COUNT_MAX	`8`: 枚举值边界。

VideoTrackType

enum agora::rtc::VideoTrackType

视频轨道类型。

枚举值
LOCAL_VIDEO_TRACK	本地视频轨道。
REMOTE_VIDEO_TRACK	远端视频轨道。

变量说明

STANDARD_BITRATE

const int agora::rtc::STANDARD_BITRATE = 0

(推荐) 标准码率模式。该模式下，视频的码率是基准码率的两倍。

COMPATIBLE_BITRATE

const int agora::rtc::COMPATIBLE_BITRATE = -1

适配码率模式。该模式下，视频码率与基准码率一致。直播时如果选择该模式，视频帧率可能会低于设置的值。

DEFAULT_CONNECTION_ID

static

const unsigned int agora::rtc::DEFAULT_CONNECTION_ID = 0

DUMMY_CONNECTION_ID

static

const unsigned int agora::rtc::DUMMY_CONNECTION_ID =(std::numeric_limits<unsigned int>::max)()

类型定义说明Copy Anchor Link

uid_tCopy Anchor Link

track_id_tCopy Anchor Link

conn_id_tCopy Anchor Link

USER_OFFLINE_REASON_TYPECopy Anchor Link

QUALITY_TYPECopy Anchor Link

VIDEO_ORIENTATIONCopy Anchor Link

FRAME_RATECopy Anchor Link

FRAME_WIDTHCopy Anchor Link

FRAME_HEIGHTCopy Anchor Link

VIDEO_FRAME_TYPECopy Anchor Link

ORIENTATION_MODECopy Anchor Link

DEGRADATION_PREFERENCECopy Anchor Link

VIDEO_CODEC_TYPECopy Anchor Link

AUDIO_CODEC_TYPECopy Anchor Link

VIDEO_STREAM_TYPECopy Anchor Link

VIDEO_MIRROR_MODE_TYPECopy Anchor Link

SIMULCAST_STREAM_MODECopy Anchor Link

VIDEO_SOURCE_TYPECopy Anchor Link

CLIENT_ROLE_TYPECopy Anchor Link

QUALITY_ADAPT_INDICATIONCopy Anchor Link

EXPERIENCE_QUALITY_TYPECopy Anchor Link

EXPERIENCE_POOR_REASONCopy Anchor Link

AUDIO_PROFILE_TYPECopy Anchor Link

AUDIO_SCENARIO_TYPECopy Anchor Link

LOCAL_AUDIO_STREAM_STATECopy Anchor Link

LOCAL_AUDIO_STREAM_ERRORCopy Anchor Link

LOCAL_VIDEO_STREAM_STATECopy Anchor Link

LOCAL_VIDEO_STREAM_ERRORCopy Anchor Link

REMOTE_AUDIO_STATECopy Anchor Link

REMOTE_AUDIO_STATE_REASONCopy Anchor Link

REMOTE_VIDEO_STATECopy Anchor Link

REMOTE_VIDEO_STATE_REASONCopy Anchor Link

REMOTE_VIDEO_DOWNSCALE_LEVELCopy Anchor Link

CONNECTION_STATE_TYPECopy Anchor Link

LASTMILE_PROBE_RESULT_STATECopy Anchor Link

CONNECTION_CHANGED_REASON_TYPECopy Anchor Link

NETWORK_TYPECopy Anchor Link

AREA_CODECopy Anchor Link

ENCRYPTION_MODECopy Anchor Link

ENCRYPTION_ERROR_TYPECopy Anchor Link

MAX_USER_ACCOUNT_LENGTH_TYPECopy Anchor Link

STREAM_SUBSCRIBE_STATECopy Anchor Link

STREAM_PUBLISH_STATECopy Anchor Link

TCcModeCopy Anchor Link

BYTES_PER_SAMPLECopy Anchor Link

RAW_AUDIO_FRAME_OP_MODE_TYPECopy Anchor Link

RTMP_CONNECTION_ERRORCopy Anchor Link

RTMP_CONNECTION_STATECopy Anchor Link

PublishAudioErrorCopy Anchor Link

PublishVideoErrorCopy Anchor Link

ImageTypeCopy Anchor Link

StreamLayerIndexInternalCopy Anchor Link

VideoTrackTypeCopy Anchor Link

变量说明Copy Anchor Link

STANDARD_BITRATECopy Anchor Link

COMPATIBLE_BITRATECopy Anchor Link

DEFAULT_CONNECTION_IDCopy Anchor Link

DUMMY_CONNECTION_IDCopy Anchor Link

咨询电话