# agora::rtc 命名空间参考 (/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## 类型定义说明 [#类型定义说明] ### uid_t [#uid_t] typedef unsigned int [agora::rtc::uid_t](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ab650539cb2bdcf8382d0aa32c6d70aa7) ### track_id_t [#track_id_t] typedef unsigned int [agora::rtc::track_id_t](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a728a2a0d7515f2c3376614be00173f7d) ### conn_id_t [#conn_id_t] typedef unsigned int [agora::rtc::conn_id_t](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ab669d53cb37e3274112d7fba3eaa27d9) ### USER_OFFLINE_REASON_TYPE [#user_offline_reason_type] enum [agora::rtc::USER_OFFLINE_REASON_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a56ebc30a718928cb6998ba1424900fef) 用户离线原因。 枚举值 USER_OFFLINE_QUIT 0: 用户主动离开。 USER_OFFLINE_DROPPED 1\:因过长时间收不到对方数据包,超时掉线。由于 SDK 使用的是不可靠通道,也有可能对方主动离开频道,但是本地没收到对方离开消息而误判为超时掉线。 USER_OFFLINE_BECOME_AUDIENCE 2: 用户身份从主播切换为观众。 ### QUALITY_TYPE [#quality_type] enum [agora::rtc::QUALITY_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#aeaf419fcafaa4d58da8b6d8718e31891) 网络质量类型。 枚举值 QUALITY_UNKNOWN 0: 质量未知。 QUALITY_EXCELLENT 1: 质量极好。 QUALITY_GOOD 2: 用户主观感觉和极好差不多,但码率可能略低于极好。 QUALITY_POOR 3: 用户主观感受有瑕疵但不影响沟通。 QUALITY_BAD 4: 勉强能沟通但不顺畅。 QUALITY_VBAD 5: 网络质量非常差,基本不能沟通。 QUALITY_DOWN 6: 网络连接断开,完全无法沟通。 ### VIDEO_ORIENTATION [#video_orientation] enum [agora::rtc::VIDEO_ORIENTATION](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#aedbc3d09c641940779abc983aa3ee3bc) 视频旋转信息。 枚举值 VIDEO_ORIENTATION_0 0: 顺时针旋转 0 度。 VIDEO_ORIENTATION_90 90: 顺时针旋转 90 度。 VIDEO_ORIENTATION_180 180: 顺时针旋转 180 度。 VIDEO_ORIENTATION_270 270: 顺时针旋转 270 度。 ### FRAME_RATE [#frame_rate] enum [agora::rtc::FRAME_RATE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a382d0a93e80539155ebd729e362684f1) 视频帧率。 枚举值 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 [#frame_width] enum [agora::rtc::FRAME_WIDTH](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a2f07c4ed608d97da9e6bfbdb7723d9dd) 视频帧宽度。 枚举值 FRAME_WIDTH_640 640:640 像素 ### FRAME_HEIGHT [#frame_height] enum [agora::rtc::FRAME_HEIGHT](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a29e02d842f9dbb4284039e6ee31a99f0) 视频帧高度。 枚举值 FRAME_HEIGHT_360 360:360 像素 ### VIDEO_FRAME_TYPE [#video_frame_type] enum [agora::rtc::VIDEO_FRAME_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#aecdd48fd8c80e68e723e4bea97cb4281) 视频帧类型。 枚举值 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 [#orientation_mode] enum [agora::rtc::ORIENTATION_MODE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#af3d825e24a1e5dcfb74279c69b81d0c7) 视频编码的方向模式。 枚举值 ORIENTATION_MODE_ADAPTIVE 0: (默认)该模式下 SDK 输出的视频方向与采集到的视频方向一致。接收端会根据收到的视频旋转信息对视频进行旋转。该模式适用于接收端可以调整视频方向的场景。 如果采集的视频是横屏模式,则输出的视频也是横屏模式。 如果采集的视频是竖屏模式,则输出的视频也是竖屏模式。 ORIENTATION_MODE_FIXED_LANDSCAPE 1: 该模式下 SDK 固定输出风景(横屏)模式的视频。如果采集到的视频是竖屏模式,则视频编码器会对其进行裁剪。该模式适用于接收端无法调整视频方向的场景,如直推 CDN。 ORIENTATION_MODE_FIXED_PORTRAIT 2: 该模式下 SDK 固定输出人像(竖屏)模式的视频,如果采集到的视频是横屏模式,则视频编码器会对其进行裁剪。该模式适用于接收端无法调整视频方向的场景,如直推 CDN。 ### DEGRADATION_PREFERENCE [#degradation_preference] enum [agora::rtc::DEGRADATION_PREFERENCE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ae02c6d4b2848c21a502e4c1643d85ef6) 带宽受限时的视频编码降级偏好。 枚举值 MAINTAIN_QUALITY 0: (默认)带宽受限时,视频编码时优先降低视频帧率,维持视频质量不变。该降级偏好适用于画质优先的场景。 MAINTAIN_FRAMERATE 1: 带宽受限时,视频编码时优先降低视频质量,维持视频帧率不变。该降级偏好适用于流畅性优先且允许画质降低的场景。 MAINTAIN_BALANCED 2: 带宽受限时,视频编码时同时降低视频帧率和视频质量。MAINTAIN_BALANCED 的降幅比 MAINTAIN_QUALITY 和 MAINTAIN_FRAMERATE 降幅更低, 适用于流畅性和画质均有限的场景。 MAINTAIN_RESOLUTION 3: 带宽受限时,视频编码时优先降低视频帧率。 ### VIDEO_CODEC_TYPE [#video_codec_type] enum [agora::rtc::VIDEO_CODEC_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a79ccac2a3f394deae680761453d15215) 视频编码类型。 枚举值 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 [#audio_codec_type] enum [agora::rtc::AUDIO_CODEC_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ac211c1a503d38d504c92b5f006240053) 音频编码类型。 枚举值 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 [#video_stream_type] enum [agora::rtc::VIDEO_STREAM_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a5f78a8dc3552e4ec308270198dd49b55) 视频流类型。 枚举值 VIDEO_STREAM_HIGH 0: 大流。分辨率和码率较高。 VIDEO_STREAM_LOW 1: 小流。分辨率和码率较低。 ### VIDEO_MIRROR_MODE_TYPE [#video_mirror_mode_type] enum [agora::rtc::VIDEO_MIRROR_MODE_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a8f684b7ea22afd313ea9fbff6d6aea13) 镜像模式类型。 枚举值 VIDEO_MIRROR_MODE_AUTO 0:(默认)由 SDK 决定镜像模式。 VIDEO_MIRROR_MODE_ENABLED 1: 启用镜像模式。 VIDEO_MIRROR_MODE_DISABLED 2: 关闭镜像模式。 ### SIMULCAST_STREAM_MODE [#simulcast_stream_mode] enum [agora::rtc::SIMULCAST_STREAM_MODE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a0ec618f678ca12272679cbb93e01f3f4) 发送视频流的模式。 枚举值 AUTO_SIMULCAST_STREAM -1:默认不发送小流,直至收到接收端发起的订阅小流申请时,自动切换为发送小流模式。 DISABLE_SIMULCAST_STREAM 0:始终不发送小流。 ENABLE_SIMULCAST_STREAM 1:始终发送小流。 ### VIDEO_SOURCE_TYPE [#video_source_type] enum [agora::rtc::VIDEO_SOURCE_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ac6699b3c40e047af097d877115dde751) 视频源类型。 枚举值 VIDEO_SOURCE_CAMERA_PRIMARY 0:主摄像头采集的视频。 VIDEO_SOURCE_CAMERA 0,与 `VIDEO_SOURCE_CAMERA_PRIMARY` 相同。 VIDEO_SOURCE_CAMERA_SECONDARY 1:第二个摄像头采集的视频。 VIDEO_SOURCE_SCREEN_PRIMARY 2:主屏幕共享的视频。 VIDEO_SOURCE_SCREEN 2,与 `VIDEO_SOURCE_SCREEN_PRIMARY` 相同。 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_CAMERA_THIRD 11:第三个摄像头采集的视频。 VIDEO_SOURCE_CAMERA_FOURTH 12:第四个摄像头采集的视频。 VIDEO_SOURCE_SCREEN_THIRD 13:第三个屏幕共享的视频。 VIDEO_SOURCE_SCREEN_FOURTH 14:第四个屏幕共享的视频。 VIDEO_SOURCE_SPEECH_DRIVEN 15:语音驱动的视频。 VIDEO_SOURCE_UNKNOWN 100 ### CLIENT_ROLE_TYPE [#client_role_type] enum [agora::rtc::CLIENT_ROLE_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a42f167813e36b5c11a8a1c659b877080) 用户角色类型。 枚举值 CLIENT_ROLE_BROADCASTER 1: 主播。主播可以同时发送和接收媒体流。 CLIENT_ROLE_AUDIENCE 2: 观众。观众只能接收媒体流。 ### QUALITY_ADAPT_INDICATION [#quality_adapt_indication] enum [agora::rtc::QUALITY_ADAPT_INDICATION](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ab8ebad21ea6a6b579c03f05c4533a071) 视频质量变化提示。 枚举值 ADAPT_NONE 0:本地视频质量不变。 ADAPT_UP_BANDWIDTH 1:由于网络带宽增加导致质量提升。 ADAPT_DOWN_BANDWIDTH 2:由于网络带宽降低导致质量下降。 ### EXPERIENCE_QUALITY_TYPE [#experience_quality_type] enum [agora::rtc::EXPERIENCE_QUALITY_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a8d5b01851e8fcbee10e5bd85fb9bf15a) 接收远端音频时,本地用户的主观体验质量。 枚举值 EXPERIENCE_QUALITY_GOOD 0: 主观体验质量较好。 EXPERIENCE_QUALITY_BAD 1: 主观体验质量较差。 ### EXPERIENCE_POOR_REASON [#experience_poor_reason] enum [agora::rtc::EXPERIENCE_POOR_REASON](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a830f382d595a185632d0fece36d67d54) 接收远端音频时,本地用户主观体验质量较差的原因。 枚举值 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 [#audio_profile_type] enum [agora::rtc::AUDIO_PROFILE_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a75448342947f6e98becc2b27d2edca55) 音频属性。设置采样率,码率,编码模式和声道数。 枚举值 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 [#audio_scenario_type] enum [agora::rtc::AUDIO_SCENARIO_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a2c5708461a9e1568bbda636d95055533) 音频应用场景。 枚举值 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 [#local_audio_stream_state] enum [agora::rtc::LOCAL_AUDIO_STREAM_STATE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a19311f858629420654fcc0da9d043332) 本地音频状态。 枚举值 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 [#local_audio_stream_error] enum [agora::rtc::LOCAL_AUDIO_STREAM_ERROR](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a3929991eea3a522dcbf6ac078810045e) 本地音频失败的原因。 枚举值 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 [#local_video_stream_state] enum [agora::rtc::LOCAL_VIDEO_STREAM_STATE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a7c8ce313cb6ccb0d186953bd06e6200b) 本地视频状态类型。 枚举值 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 [#local_video_stream_error] enum [agora::rtc::LOCAL_VIDEO_STREAM_ERROR](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#aca8292c30c50a78f6fbd1ef1b264d842) 本地视频出错原因。 枚举值 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 [#remote_audio_state] enum [agora::rtc::REMOTE_AUDIO_STATE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#aa83ef274510d1063e840d6104fd12516) 远端音频流状态。 枚举值 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 [#remote_audio_state_reason] enum [agora::rtc::REMOTE_AUDIO_STATE_REASON](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a532f4584f6ed5962012e1f08bef6f0fc) 远端音频流状态切换原因。 枚举值 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 [#remote_video_state] enum [agora::rtc::REMOTE_VIDEO_STATE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a8098bde3bb614a7716d0f39105b8f1d8) 远端视频流状态。 枚举值 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 [#remote_video_state_reason] enum [agora::rtc::REMOTE_VIDEO_STATE_REASON](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ae31fce5548860cb0a62e4c232fb18bff) 远端视频流状态切换原因。 枚举值 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 [#remote_video_downscale_level] enum [agora::rtc::REMOTE_VIDEO_DOWNSCALE_LEVEL](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a986ba95b84f37af9ae5790dd90765baa) 远端视频缩小级别。级别越高,缩小程度越高。 枚举值 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 [#connection_state_type] enum [agora::rtc::CONNECTION_STATE_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a430364c3f2cbf4419b898077cf6977f7) 网络连接状态。 枚举值 CONNECTION_STATE_DISCONNECTED 1: 网络连接断开。 CONNECTION_STATE_CONNECTING 2: 建立网络连接中。 CONNECTION_STATE_CONNECTED 3: 网络已连接。 CONNECTION_STATE_RECONNECTING 4: 重新建立网络连接中。 CONNECTION_STATE_FAILED 5: 网络连接失败。 ### LASTMILE_PROBE_RESULT_STATE [#lastmile_probe_result_state] enum [agora::rtc::LASTMILE_PROBE_RESULT_STATE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#aa6c9106e765c0ebb15be1b3e4e384f65) 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 [#connection_changed_reason_type] enum [agora::rtc::CONNECTION_CHANGED_REASON_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a329573b5363b2065b4069e5bf6013144) 连接状态变化原因。 枚举值 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 [#network_type] enum [agora::rtc::NETWORK_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ab5e06b511f978f1a997008401da46505) 网络连接类型。 枚举值 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 [#area_code] enum [agora::rtc::AREA_CODE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a85a66bc360e0d01a3f675c6a0fe95f5e) 访问区域。 枚举值 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 [#encryption_mode] enum [agora::rtc::ENCRYPTION_MODE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a906cebebbabf534c86ca71de0d1a4cf0) 内置加密模式。 枚举值 SM4_128_ECB 4: 128-bit SM4 加密,ECB 模式。 ### ENCRYPTION_ERROR_TYPE [#encryption_error_type] enum [agora::rtc::ENCRYPTION_ERROR_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a32a0270f2e3dab57953457ac1871b521) 内置加密的错误类型。 枚举值 ENCRYPTION_ERROR_INTERNAL_FAILURE 0:内部原因。 ENCRYPTION_ERROR_DECRYPTION_FAILURE 1:解密错误。请确保接收端和发送端使用的加密模式或密钥一致。 ENCRYPTION_ERROR_ENCRYPTION_FAILURE 2:加密错误。 ### MAX_USER_ACCOUNT_LENGTH_TYPE [#max_user_account_length_type] enum [agora::rtc::MAX_USER_ACCOUNT_LENGTH_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a895ba93435851fd5ddbccd92e6d5356f) user account 的最大长度。 枚举值 MAX_USER_ACCOUNT_LENGTH 256:user account 的最大长度(字节)。 ### STREAM_SUBSCRIBE_STATE [#stream_subscribe_state] enum [agora::rtc::STREAM_SUBSCRIBE_STATE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ac405a073458682fd6464c82d49fece3c) 流订阅状态。 枚举值 SUB_STATE_IDLE 0:加入频道后的初始订阅状态。 SUB_STATE_NO_SUBSCRIBED 1:订阅失败。 SUB_STATE_SUBSCRIBING 2:正在订阅。 SUB_STATE_SUBSCRIBED 3:收到了远端流,订阅成功。 ### STREAM_PUBLISH_STATE [#stream_publish_state] enum [agora::rtc::STREAM_PUBLISH_STATE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a58eeb8b495ca1c91d38785f064132537) 流发布状态。 枚举值 PUB_STATE_IDLE 0: 加入频道后的初始发布状态。 PUB_STATE_NO_PUBLISHED 1: 发布失败。 PUB_STATE_PUBLISHING 2: 正在发布。 PUB_STATE_PUBLISHED 3: 发布成功。 ### TCcMode [#tccmode] enum [agora::rtc::TCcMode](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a54de466c4f3f991c714bb5719d706b63) 阻塞控制模块选项。 枚举值 CC_ENABLED 0:开启阻塞控制模块。 CC_DISABLED 1:关闭阻塞控制模块。 ### BYTES_PER_SAMPLE [#bytes_per_sample] enum [agora::rtc::BYTES_PER_SAMPLE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a74143af8b2847d195090020877e7369d) 每个样本的字节数。 枚举值 TWO_BYTES_PER_SAMPLE 2:每个样本两个字节。 ### RAW_AUDIO_FRAME_OP_MODE_TYPE [#raw_audio_frame_op_mode_type] enum [agora::rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ae5df06fc9c5b15135e22047c01e565bb) `onRecordAudioFrame` 或 `onPlaybackAudioFrame` 回调中返回的音频数据的使用模式。 枚举值 RAW_AUDIO_FRAME_OP_MODE_READ_ONLY 0: 只读模式,用户仅从 AudioFrame 获取原始数据,不作任何修改。 RAW_AUDIO_FRAME_OP_MODE_READ_WRITE 2: 读写模式, 用户从 AudioFrame 获取并修改数据,并返回给 SDK 进行编码传输。 ### RTMP_CONNECTION_ERROR [#rtmp_connection_error] enum [agora::rtc::RTMP_CONNECTION_ERROR](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#aff7596486950cd8ca8a3010d8c8710de) 推流错误信息。 枚举值 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 [#rtmp_connection_state] enum [agora::rtc::RTMP_CONNECTION_STATE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a843a00f1c45fdfe18856a8f835018681) SDK 与 CDN 的连接状态。 枚举值 STATE_DISCONNECTED 1: SDK 与 CDN 断开连接。 以下操作会让 SDK 进入该状态: - 调用 [createRtmpConnection](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-service#adae5bb15639f9559a1399082590955e5),即 SDK 与 CDN 的初始连接状态。 - 调用 [disconnect](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtmp-connection#ac3fcd6d1efd903f1bb75797fb709584e)。 STATE_CONNECTING 2: SDK 正在连接 CDN。 调用 [connect](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtmp-connection#a5e89428056585b3b0643af03ff197ec4) 连接 CDN 的过程中,SDK 会进入该状态。 STATE_CONNECTED 3: SDK 已连接 CDN。 调用 [connect](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtmp-connection#a5e89428056585b3b0643af03ff197ec4) 成功连接 CDN 时,SDK 会进入该状态, 你可以开始向 CDN 推流。 STATE_RECONNECTING 4: SDK 正在重新连接 CDN。 在弱网环境或用户切换网络类型等情况下,如果 SDK 与 CDN 断开连接,SDK 会尝试重新连接 CDN 并进入该状态。 STATE_FAILED 5: SDK 连接 CDN 失败。 以下情况会让 SDK 进入该状态: - 调用 [connect](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtmp-connection#a5e89428056585b3b0643af03ff197ec4) 连接 CDN 失败时。 - 在弱网环境或用户切换网络类型等情况下,SDK 重新连接 CDN 失败时。 该状态下,如需连接 CDN,你需要先调用 [disconnect](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtmp-connection#ac3fcd6d1efd903f1bb75797fb709584e) 断开连接, 再调用 [connect](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtmp-connection#a5e89428056585b3b0643af03ff197ec4)。 STATE_RECONNECTED 6: SDK 已重新连接 CDN。 在弱网环境或用户切换网络类型等情况下,如果 SDK 与 CDN 断开连接,则 SDK 重新连接 CDN 成功时会进入该状态。 你可以继续向 CDN 推流。 ### PublishAudioError [#publishaudioerror] enum [agora::rtc::PublishAudioError](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ae1713f658284be303aaa022bcf018d47) 推送音频帧失败的错误码。 枚举值 PUBLISH_AUDIO_ERR_OK 0: 推送成功。 PUBLISH_AUDIO_ERR_FAILED 1: 一般性错误。 ### PublishVideoError [#publishvideoerror] enum [agora::rtc::PublishVideoError](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a68e2825c220df8afbe45a98f59ccd63e) 推送视频帧失败的错误码。 枚举值 PUBLISH_VIDEO_ERR_OK 0: 推送成功。 PUBLISH_VIDEO_ERR_FAILED 1: 一般性错误。 ### ImageType [#imagetype] enum [agora::rtc::ImageType](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a2bb24f13233850a63fb152366902bd75) 图像类型。 枚举值 kPng PNG。 kJpeg JPEG。 kGif Gif。 ### StreamLayerIndexInternal [#streamlayerindexinternal] enum [agora::rtc::StreamLayerIndexInternal](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#ac7c53aef1d848fde23b24e9c9e14a26d) 定义 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 [#videotracktype] enum [agora::rtc::VideoTrackType](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a1a5e96c615b82373b20c842f8b20ccf9) 视频轨道类型。 枚举值 LOCAL_VIDEO_TRACK 本地视频轨道。 REMOTE_VIDEO_TRACK 远端视频轨道。 ## 变量说明 [#变量说明] ### STANDARD_BITRATE [#standard_bitrate] const int agora::rtc::STANDARD_BITRATE = 0 (推荐) 标准码率模式。该模式下,视频的码率是基准码率的两倍。 ### COMPATIBLE_BITRATE [#compatible_bitrate] const int agora::rtc::COMPATIBLE_BITRATE = -1 适配码率模式。该模式下,视频码率与基准码率一致。直播时如果选择该模式,视频帧率可能会低于设置的值。 ### DEFAULT_CONNECTION_ID [#default_connection_id] const unsigned int agora::rtc::DEFAULT_CONNECTION_ID = 0 ### DUMMY_CONNECTION_ID [#dummy_connection_id] const unsigned int agora::rtc::DUMMY_CONNECTION_ID =(std::numeric_limits<unsigned int>::max)()