# PositionInfo ```cpp struct bytertc::PositionInfo ``` 用户在空间音频坐标系里的位置信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | Position | [position](#PositionInfo-position) | | HumanOrientation | [orientation](#PositionInfo-orientation) | ## 变量说明 ### position ```cpp Position bytertc::PositionInfo::position ``` 用户在空间音频坐标系里的位置，需自行建立空间直角坐标系。参看 [Position](#Position) ### orientation ```cpp HumanOrientation bytertc::PositionInfo::orientation ``` 用户在空间音频坐标系里的三维朝向信息。三个向量需要两两垂直。参看 [HumanOrientation](#HumanOrientation)。 # LocalAudioStreamError ```cpp enum bytertc::LocalAudioStreamError ``` 本地音频流状态改变时的错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLocalAudioStreamErrorOk | 0 | 本地音频状态正常 | | kLocalAudioStreamErrorFailure | 1 | 本地音频出错原因未知 | | kLocalAudioStreamErrorDeviceNoPermission | 2 | 没有权限启动本地音频录制设备 | | kLocalAudioStreamErrorRecordFailure | 4 | 本地音频录制失败，建议你检查录制设备是否正常工作 | | kLocalAudioStreamErrorEncodeFailure | 5 | 本地音频编码失败 | | kLocalAudioStreamErrorNoRecordingDevice | 6 | 没有可用的音频录制设备 | # ZoomConfigType ```cpp enum bytertc::ZoomConfigType ``` 数码变焦参数类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kZoomConfigTypeFocusOffset | 0 | 设置缩放系数 | | kZoomConfigTypeMoveOffset | 1 | 设置移动步长 | # AudioFrameSource ```cpp enum bytertc::AudioFrameSource ``` 音频文件录制内容来源。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioFrameSourceMic | 0 | 本地麦克风采集的音频数据。 | | kAudioFrameSourcePlayback | 1 | 远端所有用户混音后的数据 | | kAudioFrameSourceMixed | 2 | 本地麦克风和所有远端用户音频流的混音后的数据 | # CameraID ```cpp enum bytertc::CameraID ``` 摄像头。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kCameraIDFront | 0 | 移动端前置摄像头，PC 端内置摄像头 | | kCameraIDBack | 1 | 移动端后置摄像头，PC 端无定义 | | kCameraIDInvalid | 3 | 无效值 | # AudioDeviceInfo ```cpp struct bytertc::AudioDeviceInfo ``` 音频设备信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | char[MAX_DEVICE_ID_LENGTH] | [device_id](#AudioDeviceInfo-device_id) | | char[MAX_DEVICE_ID_LENGTH] | [device_name](#AudioDeviceInfo-device_name) | | char[MAX_DEVICE_ID_LENGTH] | [device_short_name](#AudioDeviceInfo-device_short_name) | | char[MAX_DEVICE_ID_LENGTH] | [device_container_id](#AudioDeviceInfo-device_container_id) | | int64_t | [device_vid](#AudioDeviceInfo-device_vid) | | int64_t | [device_pid](#AudioDeviceInfo-device_pid) | | DeviceTransportType | [transport_type](#AudioDeviceInfo-transport_type) | | AudioAbilityType | [volume_settable](#AudioDeviceInfo-volume_settable) | | bool | [is_system_default](#AudioDeviceInfo-is_system_default) | ## 变量说明 ### device_id ```cpp char bytertc::AudioDeviceInfo::device_id[MAX_DEVICE_ID_LENGTH] ``` 设备 ID ### device_name ```cpp char bytertc::AudioDeviceInfo::device_name[MAX_DEVICE_ID_LENGTH] ``` 设备全称，包含设备类型与设备名称。例如 "扬声器 (XYZ Audio Adapter)" ### device_short_name ```cpp char bytertc::AudioDeviceInfo::device_short_name[MAX_DEVICE_ID_LENGTH] ``` 设备名称，不含设备类型。例如 "XYZ Audio Adapter" ### device_container_id ```cpp char bytertc::AudioDeviceInfo::device_container_id[MAX_DEVICE_ID_LENGTH] ``` 设备所连接的声卡 ID，便于选择使用同一声卡的扬声器和麦克风。 ### device_vid ```cpp int64_t bytertc::AudioDeviceInfo::device_vid ``` 设备的厂商 ID ### device_pid ```cpp int64_t bytertc::AudioDeviceInfo::device_pid ``` 设备的产品编码 ### transport_type ```cpp DeviceTransportType bytertc::AudioDeviceInfo::transport_type ``` 设备的传输方式 ### volume_settable ```cpp AudioAbilityType bytertc::AudioDeviceInfo::volume_settable ``` 是否支持设置音量 ### is_system_default ```cpp bool bytertc::AudioDeviceInfo::is_system_default ``` 是否系统默认设备 # RoomEvent ```cpp enum bytertc::RoomEvent ``` 房间事件码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRoomEventUserNotifyStop | -2013 | 当房间内人数超过 500 人时，停止向房间内已有用户发送 `onUserJoined` 和 `onUserLeave` 回调，并通过广播提示房间内所有用户。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。 | | kRoomEventForbidden | -2012 | 房间/用户被封禁，通过房间事件通知封禁时间。 | | kRoomEventRetryOnServerError | -2014 | 房间/用户被封禁，通过房间事件通知封禁时间。 | # DesktopCaptureParameters ```cpp struct bytertc::DesktopCaptureParameters ``` 屏幕共享的编码参数配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [max_width](#DesktopCaptureParameters-max_width) | | int | [max_height](#DesktopCaptureParameters-max_height) | | int | [frame_rate](#DesktopCaptureParameters-frame_rate) | | int | [bitrate](#DesktopCaptureParameters-bitrate) | | int | [min_bitrate](#DesktopCaptureParameters-min_bitrate) | | bool | [capture_mouse_cursor](#DesktopCaptureParameters-capture_mouse_cursor) | | view_t* | [excluded_window_list](#DesktopCaptureParameters-excluded_window_list) | | int | [excluded_window_num](#DesktopCaptureParameters-excluded_window_num) | | HighlightConfig | [highlight_config](#DesktopCaptureParameters-highlight_config) | ## 变量说明 ### max_width ```cpp int bytertc::DesktopCaptureParameters::max_width = 1920 ``` 屏幕采集编码最大宽度，单位 px。 ### max_height ```cpp int bytertc::DesktopCaptureParameters::max_height = 1080 ``` 屏幕采集编码最大高度，单位 px。 ### frame_rate ```cpp int bytertc::DesktopCaptureParameters::frame_rate = 15 ``` 屏幕采集编码帧率, 单位 fps。 ### bitrate ```cpp int bytertc::DesktopCaptureParameters::bitrate = -1 ``` 屏幕采集编码码率, -1 为自动码率, SDK 会根据宽高信息选择合适的码率，单位 kbps ### min_bitrate ```cpp int bytertc::DesktopCaptureParameters::min_bitrate = 0 ``` 最小编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。最小编码码率必须小于或等于最大编码，否则不对视频流进行编码发送。 ### capture_mouse_cursor ```cpp bool bytertc::DesktopCaptureParameters::capture_mouse_cursor = true ``` 是否捕获鼠标光标。 ### excluded_window_list ```cpp view_t* bytertc::DesktopCaptureParameters::excluded_window_list = nullptr ``` 抓取屏幕时排除窗口列表。这个参数仅在抓取屏幕时生效。 ### excluded_window_num ```cpp int bytertc::DesktopCaptureParameters::excluded_window_num = 0 ``` 抓取屏幕时排除的窗口数量。 ### highlight_config ```cpp HighlightConfig bytertc::DesktopCaptureParameters::highlight_config ``` 高亮边框的配置。 # AVSyncState ```cpp enum bytertc::AVSyncState ``` 音视频同步状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAVSyncStateAVStreamSyncBegin | 0 | 音视频开始同步 | | kAVSyncStateAudioStreamRemove | 1 | 音视频同步过程中音频移除，但不影响当前的同步关系 | | kAVSyncStateVdieoStreamRemove | 2 | 音视频同步过程中视频移除，但不影响当前的同步关系 | # VideoFrameData ```cpp struct bytertc::VideoFrameData ``` 视频帧数据 ## 成员变量 | 类型 | 名称 | | --- | --- | | VideoBufferType | [buffer_type](#VideoFrameData-buffer_type) | | VideoPixelFormat | [pixel_format](#VideoFrameData-pixel_format) | | VideoContentType | [content_type](#VideoFrameData-content_type) | | int | [number_of_planes](#VideoFrameData-number_of_planes) | | uint8_t*[4] | [plane_data](#VideoFrameData-plane_data) | | int[4] | [plane_stride](#VideoFrameData-plane_stride) | | uint8_t* | [sei_data](#VideoFrameData-sei_data) | | int | [sei_data_size](#VideoFrameData-sei_data_size) | | uint8_t* | [roi_data](#VideoFrameData-roi_data) | | int | [roi_data_size](#VideoFrameData-roi_data_size) | | int | [width](#VideoFrameData-width) | | int | [height](#VideoFrameData-height) | | VideoRotation | [rotation](#VideoFrameData-rotation) | | int64_t | [timestamp_us](#VideoFrameData-timestamp_us) | | void* | [hw_buffer](#VideoFrameData-hw_buffer) | | void* | [hw_context](#VideoFrameData-hw_context) | | float[16] | [texture_matrix](#VideoFrameData-texture_matrix) | | uint32_t | [texture_id](#VideoFrameData-texture_id) | ## 变量说明 ### buffer_type ```cpp VideoBufferType bytertc::VideoFrameData::buffer_type = kVideoBufferTypeRawMemory ``` 视频帧缓冲区类型，默认为原始内存，详见 [VideoBufferType](#VideoBufferType)。必填。 ### pixel_format ```cpp VideoPixelFormat bytertc::VideoFrameData::pixel_format = kVideoPixelFormatUnknown ``` 视频帧像素格式，详见 [VideoPixelFormat](#VideoPixelFormat)。当 `buffer_type` 为 `kVideoFrameTypeGLTexture` 必填。 ### content_type ```cpp VideoContentType bytertc::VideoFrameData::content_type = kVideoContentTypeNormalFrame ``` 视频帧内容类型，参看 [VideoContentType](#VideoContentType) ### number_of_planes ```cpp int bytertc::VideoFrameData::number_of_planes = 0 ``` 视频帧平面个数。当 `buffer_type` 为 `kVideoBufferTypeRawMemory` 时，必填。 ### plane_data ```cpp uint8_t* bytertc::VideoFrameData::plane_data[4] = { nullptr } ``` 视频帧平面数组。当 `buffer_type` 为 `kVideoBufferTypeRawMemory` 时，必填。 ### plane_stride ```cpp int bytertc::VideoFrameData::plane_stride[4] = { 0 } ``` stride 数组。stride 指视频帧平面相邻两行图像数据之间的内存长度（单位字节）。当 `buffer_type` 为 `kVideoBufferTypeRawMemory` 时，必填。 ### sei_data ```cpp uint8_t* bytertc::VideoFrameData::sei_data = nullptr ``` SEI 数据 ### sei_data_size ```cpp int bytertc::VideoFrameData::sei_data_size = 0 ``` SEI 数据大小 ### roi_data ```cpp uint8_t* bytertc::VideoFrameData::roi_data = nullptr ``` 视频帧感兴趣区域数据 ### roi_data_size ```cpp int bytertc::VideoFrameData::roi_data_size = 0 ``` 视频帧感兴趣区域数据数据长度 ### width ```cpp int bytertc::VideoFrameData::width = 0 ``` 视频帧宽度。必填。 ### height ```cpp int bytertc::VideoFrameData::height = 0 ``` 视频帧高度。必填。 ### rotation ```cpp VideoRotation bytertc::VideoFrameData::rotation = kVideoRotation0 ``` 视频旋转角度，参看 [VideoRotation](#VideoRotation)。 ### timestamp_us ```cpp int64_t bytertc::VideoFrameData::timestamp_us = 0 ``` 视频帧时间戳，单位：微秒。必填。 ### hw_buffer ```cpp void* bytertc::VideoFrameData::hw_buffer = nullptr ``` 硬件加速缓冲区指针 ### hw_context ```cpp void* bytertc::VideoFrameData::hw_context = nullptr ``` 硬件加速上下文对象句柄 ### texture_matrix ```cpp float bytertc::VideoFrameData::texture_matrix[16] = { 0 } ``` 纹理矩阵(仅针对纹理类型的 frame 生效) ### texture_id ```cpp uint32_t bytertc::VideoFrameData::texture_id = 0 ``` 纹理 ID(仅针对纹理类型的 frame 生效)。当 `buffer_type` 为 `kVideoBufferTypeRawMemory` 或 `kVideoFrameTypeGLTexture` 必填。 # VideoBufferType ```cpp enum bytertc::VideoBufferType ``` 视频缓冲区类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoBufferTypeRawMemory | 0 | 原始内存数据 | | kVideoBufferTypeGLTexture | 2 | OpenGL 纹理数据类型 | | kVideoBufferTypeCuda | 3 | cuda 数据类型 | | kVideoBufferTypeD3D11 | 4 | direct3d11 纹理 | | kVideoBufferTypeVAAPI | 5 | vaapi 数据格式 | # AudioFrameCallbackMethod ```cpp enum class bytertc::AudioFrameCallbackMethod ``` 音频回调方法 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRecord | 0 | 本地麦克风录制的音频数据回调 | | kPlayback | 1 | 订阅的远端所有用户混音后的音频数据回调 | | kMixed | 2 | 本地麦克风录制和订阅的远端所有用户混音后的音频数据回调 | | kRemoteUser | 3 | 订阅的远端每个用户混音前的音频数据回调 | | kRecordScreen | 4 | 本地屏幕录制的音频数据回调 | | kCaptureMixed | 5 | 本地麦克风录制和本地 `MediaPlayer`, `EffectPlayer` 播放的音频混音后的音频数据回调 | # MixedStreamPushTargetConfig ```cpp struct bytertc::MixedStreamPushTargetConfig ``` 合流/WTN 流的转推目标参数。如无特别说明，参数可适用于 WTN 流和合流转推任务。如无特别说明，参数可用于启动和更新任务。 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [push_wtn_stream_id](#MixedStreamPushTargetConfig-push_wtn_stream_id) | | const char* | [push_cdn_url](#MixedStreamPushTargetConfig-push_cdn_url) | | MixedStreamPushTargetType | [push_target_type](#MixedStreamPushTargetConfig-push_target_type) | ## 变量说明 ### push_wtn_stream_id ```cpp const char* bytertc::MixedStreamPushTargetConfig::push_wtn_stream_id = nullptr ``` WTN 流 ID。合流任务不支持设置本参数。 ### push_cdn_url ```cpp const char* bytertc::MixedStreamPushTargetConfig::push_cdn_url = nullptr ``` 推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 `/^rtmps?:\\/\\//`。建议设置。 - 本参数不支持过程中更新。 - WTN 流任务不支持设置本参数。 ### push_target_type ```cpp MixedStreamPushTargetType bytertc::MixedStreamPushTargetConfig::push_target_type = kMixedStreamPushTargetTypeToCDN ``` 推流任务类型。 # SnapshotErrorCode ```cpp enum bytertc::SnapshotErrorCode ``` 截图错误码 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSnapshotErrorCodeOk | 0 | 截图成功。 | | kSnapshotErrorCodeCreateFail | -1 | 截图错误。生成图片数据失败或 RGBA 编码失败。 | | kSnapshotErrorCodeStreamInvalid | -2 | 截图错误。流无效。 | | kSnapshotErrorCodeTimeout | -3 | 截图错误。截图超时，超时时间 1 秒。 | | kSnapshotErrorCodeFileSaveError | -4 | 截图错误。图片保存失败。 | # VideoContentType ```cpp enum bytertc::VideoContentType ``` 视频帧内容类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoContentTypeNormalFrame | 0 | 普通视频 | | kVideoContentTypeBlackFrame | 1 | 黑帧 | # ReceiveRange ```cpp struct bytertc::ReceiveRange ``` 本地用户能收听到、且具有衰减效果的音频接收范围 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [min](#ReceiveRange-min) | | int | [max](#ReceiveRange-max) | ## 变量说明 ### min ```cpp int bytertc::ReceiveRange::min ``` 能够接收语音、并且具有衰减效果的最小距离值，该值须 ≥ 0，但 ≤ max。小于该值的范围内没有范围语音效果，即收听到的音频音量相同。 ### max ```cpp int bytertc::ReceiveRange::max ``` 能够收听语音的最大距离值，该值须 \> 0 且 ≥ min。当收听者和声源距离处于 [min, max) 之间时，收听到的音量根据距离呈衰减效果。超出该值范围的音频将无法收听到。 # AudioReportMode ```cpp enum bytertc::AudioReportMode ``` 音量回调模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioReportModeNormal | 0 | 默认始终开启音量回调。 | | kAudioReportModeDisconnect | 1 | 可见用户进房并停止推流后，关闭音量回调。 | | kAudioReportModeReset | 2 | 可见用户进房并停止推流后，开启音量回调，回调值重置为 0。 | # SyncInfoStreamType ```cpp enum bytertc::SyncInfoStreamType ``` 媒体流信息同步的流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSyncInfoStreamTypeAudio | 0 | 音频流 | # LocalVideoStats ```cpp struct bytertc::LocalVideoStats ``` 本地视频流统计信息，统计周期为 2s 。本地用户发布视频流成功后，SDK 会周期性地通过 `onLocalStreamStats` 通知用户发布的视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [sent_kbitrate](#LocalVideoStats-sent_kbitrate) | | int | [input_frame_rate](#LocalVideoStats-input_frame_rate) | | int | [sent_frame_rate](#LocalVideoStats-sent_frame_rate) | | int | [encoder_output_frame_rate](#LocalVideoStats-encoder_output_frame_rate) | | int | [renderer_output_frame_rate](#LocalVideoStats-renderer_output_frame_rate) | | int | [stats_interval](#LocalVideoStats-stats_interval) | | float | [video_loss_rate](#LocalVideoStats-video_loss_rate) | | int | [rtt](#LocalVideoStats-rtt) | | int | [encoded_bitrate](#LocalVideoStats-encoded_bitrate) | | int | [encoded_frame_width](#LocalVideoStats-encoded_frame_width) | | int | [encoded_frame_height](#LocalVideoStats-encoded_frame_height) | | int | [encoded_frame_count](#LocalVideoStats-encoded_frame_count) | | VideoCodecType | [codec_type](#LocalVideoStats-codec_type) | | bool | [is_screen](#LocalVideoStats-is_screen) | | int | [jitter](#LocalVideoStats-jitter) | | int | [codec_elapse_per_frame](#LocalVideoStats-codec_elapse_per_frame) | ## 变量说明 ### sent_kbitrate ```cpp int bytertc::LocalVideoStats::sent_kbitrate ``` 发送码率。此次统计周期内实际发送的分辨率最大的视频流的发送码率，单位为 Kbps ### input_frame_rate ```cpp int bytertc::LocalVideoStats::input_frame_rate ``` 采集帧率。此次统计周期内的视频采集帧率，单位为 fps 。 ### sent_frame_rate ```cpp int bytertc::LocalVideoStats::sent_frame_rate ``` 发送帧率。此次统计周期内实际发送的分辨率最大的视频流的视频发送帧率，单位为 fps 。 ### encoder_output_frame_rate ```cpp int bytertc::LocalVideoStats::encoder_output_frame_rate ``` 编码器输出帧率。当前编码器在此次统计周期内实际发送的分辨率最大的视频流的输出帧率，单位为 fps 。 ### renderer_output_frame_rate ```cpp int bytertc::LocalVideoStats::renderer_output_frame_rate ``` 本地渲染帧率。此次统计周期内的本地视频渲染帧率，单位为 fps 。 ### stats_interval ```cpp int bytertc::LocalVideoStats::stats_interval ``` 统计间隔，单位为 ms 。此字段用于设置回调的统计周期，默认设置为 2s 。 ### video_loss_rate ```cpp float bytertc::LocalVideoStats::video_loss_rate ``` 视频丢包率。此次统计周期内的视频上行丢包率，取值范围为 [0，1] 。 ### rtt ```cpp int bytertc::LocalVideoStats::rtt ``` 往返时延，单位为 ms 。 ### encoded_bitrate ```cpp int bytertc::LocalVideoStats::encoded_bitrate ``` 视频编码码率。此次统计周期内的实际发送的分辨率最大的视频流视频编码码率，单位为 Kbps 。 ### encoded_frame_width ```cpp int bytertc::LocalVideoStats::encoded_frame_width ``` 实际发送的分辨率最大的视频流的视频编码宽度，单位为 px 。 ### encoded_frame_height ```cpp int bytertc::LocalVideoStats::encoded_frame_height ``` 实际发送的分辨率最大的视频流的视频编码高度，单位为 px 。 ### encoded_frame_count ```cpp int bytertc::LocalVideoStats::encoded_frame_count ``` 此次统计周期内实际发送的分辨率最大的视频流的发送的视频帧总数。 ### codec_type ```cpp VideoCodecType bytertc::LocalVideoStats::codec_type ``` 视频的编码类型，具体参考 [VideoCodecType](#VideoCodecType) 。 ### is_screen ```cpp bool bytertc::LocalVideoStats::is_screen ``` 预留字段。 ### jitter ```cpp int bytertc::LocalVideoStats::jitter ``` 视频上行网络抖动，单位为 ms 。 ### codec_elapse_per_frame ```cpp int bytertc::LocalVideoStats::codec_elapse_per_frame ``` 视频编码平均耗时，单位 ms。 # Public API ## 成员变量 | 类型 | 名称 | | --- | --- | | struct bytertc::MixedStreamPushTargetConfig | [MixedStreamPushTargetConfig](#mixedstreampushtargetconfig) | | const unsigned int | [MAX_DEVICE_ID_LENGTH](#max_device_id_length) | | RtcRoomStats | [ConnectionStats](#connectionstats) | | VideoSolutionDescription | [deprecated] [VideoProfile](#videoprofile) | ## 变量说明 ### MixedStreamPushTargetConfig ```cpp typedef struct bytertc::MixedStreamPushTargetConfig bytertc::MixedStreamPushTargetConfig ``` 推流任务类型。 ### MAX_DEVICE_ID_LENGTH ```cpp const unsigned int bytertc::MAX_DEVICE_ID_LENGTH = 512 ``` ID 最大长度 ### ConnectionStats ```cpp typedef RtcRoomStats bytertc::streamingrtc::ConnectionStats ``` 参看 [RtcRoomStats](#RtcRoomStats)。 ### VideoProfile ```cpp typedef VideoSolutionDescription bytertc::VideoProfile ``` > Deprecated since 3.45 and will be deleted in 3.51. # ReturnStatus ```cpp enum bytertc::ReturnStatus ``` 方法调用结果。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kReturnStatusSuccess | 0 | 成功。 | | kReturnStatusFailure | -1 | 失败。 | | kReturnStatusParameterErr | -2 | 参数错误。 | | kReturnStatusWrongState | -3 | 接口状态错误。 | | kReturnStatusHasInRoom | -4 | 失败，用户已在房间内。 | | kReturnStatusHasInLogin | -5 | 失败，用户已登录。 | | kReturnStatusHasInEchoTest | -6 | 失败，用户已经在进行通话回路测试中。 | | kReturnStatusNeitherVideoNorAudio | -7 | 失败，音视频均未采集。 | | kReturnStatusRoomIdInUse | -8 | 失败，该 roomId 已被使用。 | | kReturnStatusScreenNotSupport | -9 | 失败，屏幕流不支持。 | | kReturnStatusNotSupport | -10 | 失败，不支持该操作。 | | kReturnStatusResourceOverflow | -11 | 失败，资源已占用。 | | kReturnStatusVideoNotSupport | -12 | 失败，不支持视频接口调用。 | | kReturnStatusGameSceneNotSupport | -13 | 游戏场景不支持调用该接口，会与游戏房间模块的 [enableMicrophone](70095#IGameRoom-enablemicrophone) 接口互相冲突 | | kReturnStatusAudioNoFrame | -101 | 失败，没有音频帧。 | | kReturnStatusAudioNotImplemented | -102 | 失败，未实现。 | | kReturnStatusAudioNoPermission | -103 | 失败，采集设备无麦克风权限，尝试初始化设备失败。 | | kReturnStatusAudioDeviceNotExists | -104 | 失败，设备不存在。当前没有设备或设备被移除时返回该值。 | | kReturnStatusAudioDeviceFormatNotSupport | -105 | 失败，设备音频格式不支持。 | | kReturnStatusAudioDeviceNoDevice | -106 | 失败，系统无可用设备。 | | kReturnStatusAudioDeviceCannotUse | -107 | 失败，当前设备不可用，需更换设备。 | | kReturnStatusAudioDeviceInitFailed | -108 | 系统错误，设备初始化失败。 | | kReturnStatusAudioDeviceStartFailed | -109 | 系统错误，设备开启失败。 | | kReturnStatusAudioDeviceProcessNotExist | -110 | 指定的音频进程不存在，采集失败。 | | kReturnStatusAudioDeviceSpecifyingProcessUnsupport | -111 | 不支持指定进程采集音频 | | kReturnStatusNativeInvalid | -201 | 失败，无效对象。 | | kReturnStatusVideoTimeStampWarning | -202 | 警告。推送视频帧到 RTC SDK 时，相邻视频帧的时间戳差异应当和推帧操作的间隔相同。如果不同，会收到此警告。 | | kReturnStatusAecSceneWarning | -302 | 告警，配置下发了无效的aec场景。 | | kReturnStatusAecTypeWarning | -303 | 警告，配置下发了错误的aec类型。 | # EchoTestResult ```cpp enum class bytertc::EchoTestResult ``` 音视频回路测试结果 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kTestSuccess | 0 | 接收到采集的音视频的回放，通话回路检测成功 | | kTestTimeout | 1 | 测试超过 60s 仍未完成，已自动停止 | | kTestIntervalShort | 2 | 上一次测试结束和下一次测试开始之间的时间间隔少于 5s | | kAudioDeviceError | 3 | 音频采集异常 | | kVideoDeviceError | 4 | 视频采集异常 | | kAudioReceiveError | 5 | 音频接收异常 | | kVideoReceiveError | 6 | 视频接收异常 | | kInternalError | 7 | 内部错误，不可恢复 | # MixedStreamVideoCodecType ```cpp enum bytertc::MixedStreamVideoCodecType ``` 视频编码格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamVideoCodecTypeH264 | 0 | H.264 格式，默认值。 | | kMixedStreamVideoCodecTypeByteVC1 | 1 | ByteVC1 格式。 | # ByteWatermark ```cpp struct bytertc::ByteWatermark ``` 水印图片相对视频流的位置和大小。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [x](#ByteWatermark-x) | | float | [y](#ByteWatermark-y) | | float | [width](#ByteWatermark-width) | | float | [height](#ByteWatermark-height) | ## 变量说明 ### x ```cpp float bytertc::ByteWatermark::x ``` 水印图片相对视频流左上角的横向偏移与视频流宽度的比值，取值范围为 [0,1)。 ### y ```cpp float bytertc::ByteWatermark::y ``` 水印图片相对视频流左上角的纵向偏移与视频流高度的比值，取值范围为 [0,1)。 ### width ```cpp float bytertc::ByteWatermark::width ``` 水印图片宽度与视频流宽度的比值，取值范围 [0,1)。 ### height ```cpp float bytertc::ByteWatermark::height ``` 水印图片高度与视频流高度的比值，取值范围为 [0,1)。 # RoomMessageSendResult ```cpp enum bytertc::RoomMessageSendResult ``` 房间内广播消息发送结果 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRoomMessageSendResultSuccess | 200 | 消息发送成功 | | kRoomMessageSendResultTimeout | 1 | 发送超时，没有发送 | | kRoomMessageSendResultNetworkDisconnected | 2 | 通道断开，没有发送 | | kRoomMessageSendResultExceedQPS | 5 | 超过 QPS 限制 | | kRoomMessageSendResultNotJoin | 100 | 失败，发送方未加入房间 | | kRoomMessageSendResultNoConnection | 102 | 失败，没有可用的数据传输通道连接 | | kRoomMessageSendResultExceedMaxLength | 103 | 消息超过最大长度。默认消息最大长度为 1 KB；若[启用了 RTS 高级功能](https://console.volcengine.com/rtc/cloudRTC?tab=RTSMode)，消息最大长度为 64 KB。 | | kRoomMessageSendResultUnknown | 1000 | 失败，未知错误 | # MixedStreamPushTargetType ```cpp enum bytertc::MixedStreamPushTargetType ``` 合流推送目标类型，指定混流后的媒体流推送到 CDN 还是 WTN。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamPushTargetTypeToCDN | 0 | 推送到 CDN | | kMixedStreamPushTargetTypeToWTN | 1 | 推送到 WTN | # SubscribeMediaType ```cpp enum bytertc::SubscribeMediaType ``` 订阅媒体的类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRTCSubscribeMediaTypeNone | 0 | 既不订阅音频，也不订阅视频 | | kRTCSubscribeMediaTypeAudioOnly | 1 | 只订阅音频，不订阅视频 | | kRTCSubscribeMediaTypeVideoOnly | 2 | 只订阅视频，不订阅音频 | | kRTCSubscribeMediaTypeVideoAndAudio | 3 | 同时订阅音频和视频 | # AudioPropertiesConfig ```cpp struct bytertc::AudioPropertiesConfig ``` 音频属性信息提示的相关配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [interval](#AudioPropertiesConfig-interval) | | bool | [enable_spectrum](#AudioPropertiesConfig-enable_spectrum) | | bool | [enable_vad](#AudioPropertiesConfig-enable_vad) | | AudioReportMode | [local_main_report_mode](#AudioPropertiesConfig-local_main_report_mode) | | float | [smooth](#AudioPropertiesConfig-smooth) | | AudioPropertiesMode | [audio_report_mode](#AudioPropertiesConfig-audio_report_mode) | | bool | [enable_voice_pitch](#AudioPropertiesConfig-enable_voice_pitch) | ## 变量说明 ### interval ```cpp int bytertc::AudioPropertiesConfig::interval = 0 ``` 信息提示间隔，单位：ms - `<= 0`：关闭信息提示 - `(0,100]`：开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms - `> 100`：开启信息提示，并将信息提示间隔设置为此值 ### enable_spectrum ```cpp bool bytertc::AudioPropertiesConfig::enable_spectrum = false ``` 是否开启音频频谱检测。 ### enable_vad ```cpp bool bytertc::AudioPropertiesConfig::enable_vad = false ``` 是否开启人声检测 (VAD)。 ### local_main_report_mode ```cpp AudioReportMode bytertc::AudioPropertiesConfig::local_main_report_mode = kAudioReportModeNormal ``` 音量回调配置模式。详见 [AudioReportMode](#AudioReportMode)。 ### smooth ```cpp float bytertc::AudioPropertiesConfig::smooth = 1.0f ``` 适用于音频属性信息提示的平滑系数。取值范围是 `(0.0, 1.0]`。默认值为 `1.0`，不开启平滑效果；值越小，提示音量平滑效果越明显。如果要开启平滑效果，可以设置为 `0.3`。 ### audio_report_mode ```cpp AudioPropertiesMode bytertc::AudioPropertiesConfig::audio_report_mode = kAudioPropertiesModeMicrophone ``` [onLocalAudioPropertiesReport](70096#IRTCEngineEventHandler-onlocalaudiopropertiesreport) 中包含音频数据的范围。参看 [AudioPropertiesMode](#AudioPropertiesMode)。默认仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据。 ### enable_voice_pitch ```cpp bool bytertc::AudioPropertiesConfig::enable_voice_pitch = false ``` 是否回调本地用户的人声基频。 # AudioRoute ```cpp enum bytertc::AudioRoute ``` 音频播放设备 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioRouteDefault | -1 | 默认设备 | | kAudioRouteHeadset | 1 | 有线耳机 | | kAudioRouteEarpiece | 2 | 听筒 | | kAudioRouteSpeakerphone | 3 | 扬声器 | | kAudioRouteHeadsetBluetooth | 4 | 蓝牙耳机 | | kAudioRouteHeadsetUSB | 5 | USB 设备 | # VideoMetadataBuffer ```cpp struct bytertc::VideoMetadataBuffer ``` 视频帧中包含的 metadata 信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | char* | [data](#VideoMetadataBuffer-data) | | int | [size](#VideoMetadataBuffer-size) | | int64_t | [timestamp_us](#VideoMetadataBuffer-timestamp_us) | ## 变量说明 ### data ```cpp char* bytertc::VideoMetadataBuffer::data ``` 接收或者发送的 metadata ### size ```cpp int bytertc::VideoMetadataBuffer::size ``` 接收或者发送的 metadata 数据大小，不能超过 1024 ### timestamp_us ```cpp int64_t bytertc::VideoMetadataBuffer::timestamp_us ``` 包含 metadata 视频帧的时间戳，单位微秒 # MediaDeviceState ```cpp enum bytertc::MediaDeviceState ``` 媒体设备状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaDeviceStateStarted | 1 | 设备已开启 | | kMediaDeviceStateStopped | 2 | 设备已停止 | | kMediaDeviceStateRuntimeError | 3 | 设备运行时错误

例如，当媒体设备的预期行为是正常采集，但没有收到采集数据时，将回调该状态。 | | kMediaDeviceStatePaused | 4 | 设备已暂停。包括：

采集过程中，目标应用窗体最小化到任务栏。
开启采集或采集过程中，目标应用窗体被隐藏。
采集过程中，目标应用窗体正在被拉伸。
采集过程中，目标应用窗体正在被拖动。

| | kMediaDeviceStateResumed | 5 | 设备已恢复 | | kMediaDeviceStateAdded | 10 | 设备已插入

你可以调用获取设备接口更新设备列表。 | | kMediaDeviceStateRemoved | 11 | 设备被移除

你可以调用获取设备接口更新设备列表。 | | kMediaDeviceStateInterruptionBegan | 12 | 用户合盖打断了视频通话。如果系统未休眠或关机，将在开盖后自动恢复视频通话。 | | kMediaDeviceStateInterruptionEnded | 13 | 视频通话已从合盖打断中恢复 | | kMediaDeviceStateBecomeSystemDefault | 14 | 设备成为系统默认 | | kMediaDeviceStateResignSystemDefault | 15 | 设备不再是系统默认 | | kMediaDeviceStateListUpdated | 16 | 获取设备列表超时后，收到设备列表通知。

再次调用获取设备接口更新设备列表。 | # RemoteVideoState ```cpp enum bytertc::RemoteVideoState ``` 远端视频流状态。状态改变时，会收到 `onRemoteVideoStateChanged` 回调 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteVideoStateStopped | 0 | 远端视频流默认初始状态，视频尚未开始播放。 | | kRemoteVideoStateStarting | 1 | 本地用户已接收远端视频流首包。 | | kRemoteVideoStateDecoding | 2 | 远端视频流正在解码，正常播放。 | | kRemoteVideoStateFrozen | 3 | 远端视频流卡顿，可能有网络等原因。 | | kRemoteVideoStateFailed | 4 | 远端视频流播放失败。 | # Rectangle ```cpp struct bytertc::Rectangle ``` 矩形区域，用于指定屏幕区域。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [x](#Rectangle-x) | | int | [y](#Rectangle-y) | | int | [width](#Rectangle-width) | | int | [height](#Rectangle-height) | ## 变量说明 ### x ```cpp int bytertc::Rectangle::x = 0 ``` 矩形区域左上角的 x 坐标。 ### y ```cpp int bytertc::Rectangle::y = 0 ``` 矩形区域左上角的 y 坐标。 ### width ```cpp int bytertc::Rectangle::width = 0 ``` 矩形宽度。 ### height ```cpp int bytertc::Rectangle::height = 0 ``` 矩形高度。 # VoiceChangerType ```cpp enum bytertc::VoiceChangerType ``` 变声特效类型。如需更多类型，联系技术支持。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVoiceChangerTypeOriginal | 0 | 原声，不含特效 | | kVoiceChangerTypeGiant | 1 | 巨人 | | kVoiceChangerTypeChipmunk | 2 | 花栗鼠 | | kVoiceChangerTypeMinionst | 3 | 小黄人 | | kVoiceChangerTypeVibrato | 4 | 颤音 | | kVoiceChangerTypeRobot | 5 | 机器人 | # LocalProxyState ```cpp enum bytertc::LocalProxyState ``` 本地代理连接状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLocalProxyStateInited | 0 | TCP 代理服务器连接成功。 | | kLocalProxyStateConnected | 1 | 本地代理连接成功。 | | kLocalProxyStateError | 2 | 本地代理连接出现错误。 | # MediaDeviceError ```cpp enum bytertc::MediaDeviceError ``` 媒体设备错误类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaDeviceErrorOK | 0 | 媒体设备正常 | | kMediaDeviceErrorDeviceNoPermission | 1 | 没有权限启动媒体设备 | | kMediaDeviceErrorDeviceBusy | 2 | 媒体设备已经在使用中 | | kMediaDeviceErrorDeviceFailure | 3 | 媒体设备错误 | | kMediaDeviceErrorDeviceNotFound | 4 | 未找到指定的媒体设备 | | kMediaDeviceErrorDeviceDisconnected | 5 | 媒体设备被移除。

对象为采集屏幕流时，表明窗体被关闭或显示器被移除。 | | kMediaDeviceErrorDeviceNoCallback | 6 | 设备没有数据回调 | | kMediaDeviceErrorDeviceUNSupportFormat | 7 | 设备采样率不支持 | | kMediaDeviceErrorAudioServerNeedRestart | 13 | 系统服务错误或长时间不响应，建议重启音频服务进程或重启设备。 | # RTCAudioDeviceType ```cpp enum bytertc::RTCAudioDeviceType ``` 音频设备类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRTCAudioDeviceTypeUnknown | -1 | 未知设备类型 | | kRTCAudioDeviceTypeRenderDevice | 0 | 音频渲染设备 | | kRTCAudioDeviceTypeCaptureDevice | 1 | 音频采集设备 | | kRTCAudioDeviceTypeScreenCaptureDevice | 2 | 屏幕流音频设备 | # MixedStreamTaskEvent ```cpp enum bytertc::MixedStreamTaskEvent ``` 转推任务事件 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamTaskEventStartSuccess | 1 | 任务发起成功。 | | kMixedStreamTaskEventStartFailed | 2 | 任务发起失败。 | | kMixedStreamTaskEventUpdateSuccess | 3 | 任务更新成功。 | | kMixedStreamTaskEventUpdateFailed | 4 | 任务更新失败。 | | kMixedStreamTaskEventStopSuccess | 5 | 任务停止。 | | kMixedStreamTaskEventStopFailed | 6 | 结束任务失败。 | | kMixedStreamTaskEventWarning | 7 | Warning 事件 | # MixedStreamSEIContentMode ```cpp enum bytertc::MixedStreamSEIContentMode ``` 服务端合流转推 SEI 内容。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamSEIContentModeDefault | 0 | 视频流中包含全部的 SEI 信息。默认设置。 | | kMixedStreamSEIContentModeEnableVolumeIndication | 1 | 随非关键帧传输的 SEI 数据中仅包含音量信息。

当设置 `MixedStreamControlConfig.enable_volume_indication` 为 True 时，此参数设置生效。 | # MixedStreamAudioProfile ```cpp enum bytertc::MixedStreamAudioProfile ``` AAC 编码规格。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamAudioProfileLC | 0 | AAC-LC 规格，默认值。 | | kMixedStreamAudioProfileHEv1 | 1 | HE-AAC v1 规格。 | | kMixedStreamAudioProfileHEv2 | 2 | HE-AAC v2 规格。 | # FaceDetectResult ```cpp struct bytertc::FaceDetectResult ``` 人脸检测结果 ## 成员变量 | 类型 | 名称 | | --- | --- | | const int | [max_face_num](#FaceDetectResult-max_face_num) | | int | [detect_result](#FaceDetectResult-detect_result) | | int | [face_count](#FaceDetectResult-face_count) | | Rectangle[max_face_num] | [rect](#FaceDetectResult-rect) | | int | [image_width](#FaceDetectResult-image_width) | | int | [image_height](#FaceDetectResult-image_height) | | int64_t | [frame_timestamp_us](#FaceDetectResult-frame_timestamp_us) | ## 变量说明 ### max_face_num ```cpp const int bytertc::FaceDetectResult::max_face_num = 10 ``` 人脸信息存储上限，最多可存储 10 个人脸信息 ### detect_result ```cpp int bytertc::FaceDetectResult::detect_result = 0 ``` 人脸检测结果 - 0：检测成功 - !0：检测失败。详见[错误码](https://www.volcengine.com/docs/6705/102042)。 ### face_count ```cpp int bytertc::FaceDetectResult::face_count = 0 ``` 检测到的人脸的数量 ### rect ```cpp Rectangle bytertc::FaceDetectResult::rect[max_face_num] ``` 识别到人脸的矩形框。数组的长度和检测到的人脸数量一致。参看 [Rectangle](#Rectangle)。 ### image_width ```cpp int bytertc::FaceDetectResult::image_width = 0 ``` 原始图片宽度(px) ### image_height ```cpp int bytertc::FaceDetectResult::image_height = 0 ``` 原始图片高度(px) ### frame_timestamp_us ```cpp int64_t bytertc::FaceDetectResult::frame_timestamp_us = 0 ``` 进行人脸识别的视频帧的时间戳。 # WTNSubscribeState ```cpp enum bytertc::WTNSubscribeState ``` WTN 媒体流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kWTNSubscribeStateSubscribed | 0 | 订阅 WTN 媒体流 | | kWTNSubscribeStateUnsubscribed | 1 | 取消订阅 WTN 媒体流 | # RecordingInfo ```cpp struct bytertc::RecordingInfo ``` 本地录制的详细信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [file_path](#RecordingInfo-file_path) | | VideoCodecType | [video_codec_type](#RecordingInfo-video_codec_type) | | int | [width](#RecordingInfo-width) | | int | [height](#RecordingInfo-height) | ## 变量说明 ### file_path ```cpp const char* bytertc::RecordingInfo::file_path ``` 录制文件的绝对路径，包含文件名和文件后缀 ### video_codec_type ```cpp VideoCodecType bytertc::RecordingInfo::video_codec_type ``` 录制文件的视频编码类型，参看 [VideoCodecType](#VideoCodecType) ### width ```cpp int bytertc::RecordingInfo::width ``` 录制视频的宽，单位：像素。纯音频录制请忽略该字段 ### height ```cpp int bytertc::RecordingInfo::height ``` 录制视频的高，单位：像素。纯音频录制请忽略该字段 # P2PRole ```cpp enum bytertc::streamingrtc::P2PRole ``` 串流引擎角色 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kP2PRoleClient | 0 | 客户端 | | kP2PRoleServer | 1 | 服务端 | # HWDeviceType ```cpp enum bytertc::HWDeviceType ``` 硬件加速设备类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kHWDeviceTypeNone | 0 | 未知的设备类型 | | kHWDeviceTypeD3D11 | 1 | direct3d 11 视频加速设备 | | kHWDeviceTypeCuda | 2 | cuda 硬件加速设备 | | kHWDeviceTypeQsv | 3 | intel 平台下 qsv 加速设备 | | kHWDeviceTypeDxva2 | 4 | windows 平台 dx 硬件加速设备 | | kHWDeviceTypeMediaCodec | 5 | Android 平台下硬件加速设备 mediacodec | | kHWDeviceTypeVideoToolbox | 6 | IOS、MACOS 平台下硬件加速设备 VideoToolbox | | kHWDeviceTypeEglContext | 7 | android、linux 平台下硬件加速设备 egl context | | kHWDeviceTypeVaapi | 8 | linux、windows 平台下硬件加速设备 va context | # AudioSourceType ```cpp enum bytertc::AudioSourceType ``` 音频输入源类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioSourceTypeExternal | 0 | 自定义采集音频源 | | kAudioSourceTypeInternal | 1 | RTC SDK 内部采集音频源 | # VideoSinkMirrorType ```cpp enum bytertc::VideoSinkMirrorType ``` 是否将视频帧镜像。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoSinkMirrorTypeON | 1 | 开启镜像。 | | kVideoSinkMirrorTypeOFF | 2 | （默认值）不开启镜像。 | # SubtitleMessage ```cpp struct bytertc::SubtitleMessage ``` 字幕具体内容。 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [user_id](#SubtitleMessage-user_id) | | const char* | [text](#SubtitleMessage-text) | | const char* | [language](#SubtitleMessage-language) | | SubtitleMode | [mode](#SubtitleMessage-mode) | | int | [sequence](#SubtitleMessage-sequence) | | bool | [definite](#SubtitleMessage-definite) | ## 变量说明 ### user_id ```cpp const char* bytertc::SubtitleMessage::user_id ``` 说话者的用户 ID。 ### text ```cpp const char* bytertc::SubtitleMessage::text ``` 字幕文本, 采用 UTF-8 编码。 ### language ```cpp const char* bytertc::SubtitleMessage::language ``` 字幕语种，根据字幕模式为原文或译文对应的语种。 ### mode ```cpp SubtitleMode bytertc::SubtitleMessage::mode ``` 字幕模式，参看 [SubtitleMode](#SubtitleMode)。 ### sequence ```cpp int bytertc::SubtitleMessage::sequence ``` 字幕文本序列号，同一发言人的完整发言和不完整发言会按递增顺序单独分别编号。 ### definite ```cpp bool bytertc::SubtitleMessage::definite ``` 语音识别出的文本是否为一段完整的一句话。 True 代表是, False 代表不是。 # RemoteStreamKey ```cpp struct bytertc::RemoteStreamKey ``` 远端流信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [room_id](#RemoteStreamKey-room_id) | | const char* | [user_id](#RemoteStreamKey-user_id) | | StreamIndex | [stream_index](#RemoteStreamKey-stream_index) | ## 变量说明 ### room_id ```cpp const char* bytertc::RemoteStreamKey::room_id ``` 媒体流所在房间的房间 ID。如果此媒体流是通过 `startForwardStreamToRooms` 转发到你所在房间的媒体流时，你应将房间 ID 设置为你所在的房间 ID。 ### user_id ```cpp const char* bytertc::RemoteStreamKey::user_id ``` 用户 ID ### stream_index ```cpp StreamIndex bytertc::RemoteStreamKey::stream_index ``` 预留字段。 # PerformanceAlarmMode ```cpp enum bytertc::PerformanceAlarmMode ``` 是否开启发布性能回退 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kPerformanceAlarmModeNormal | 0 | 未开启发布性能回退 | | kPerformanceAlarmModeSimulcast | 1 | 已开启发布性能回退 | # MuteState ```cpp enum bytertc::MuteState ``` 音视频流的发送/播放状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMuteStateOff | 0 | 发送 | | kMuteStateOn | 1 | 停止发送 | # IVideoFrame ```cpp class bytertc::IVideoFrame ``` 视频帧接口 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual VideoBufferType | [bufferType](#IVideoFrame-buffertype) | | virtual VideoPixelFormat | [pixelFormat](#IVideoFrame-pixelformat) | | virtual VideoContentType | [contentType](#IVideoFrame-contenttype) | | virtual int64_t | [timestampUs](#IVideoFrame-timestampus) | | virtual int | [width](#IVideoFrame-width) | | virtual int | [height](#IVideoFrame-height) | | virtual VideoRotation | [rotation](#IVideoFrame-rotation) | | virtual int | [numberOfPlanes](#IVideoFrame-numberofplanes) | | virtual uint8_t* | [planeData](#IVideoFrame-planedata) | | virtual int | [planeStride](#IVideoFrame-planestride) | | virtual uint8_t* | [seiData](#IVideoFrame-seidata) | | virtual void* | [hwBuffer](#IVideoFrame-hwbuffer) | | virtual void* | [hwContext](#IVideoFrame-hwcontext) | | virtual void | [textureMatrix](#IVideoFrame-texturematrix) | | virtual uint32_t | [textureId](#IVideoFrame-textureid) | | virtual void | [addRef](#IVideoFrame-addref) | | virtual long | [releaseRef](#IVideoFrame-releaseref) | | virtual CameraID | [cameraId](#IVideoFrame-cameraid) | ## 函数说明 ### bufferType ```cpp virtual VideoBufferType bufferType() = 0; ``` 获取视频帧缓冲区类型，参看 [VideoBufferType](#VideoBufferType)。 ### pixelFormat ```cpp virtual VideoPixelFormat pixelFormat() = 0; ``` 获取视频帧像素格式，参看 [VideoPixelFormat](#VideoPixelFormat)。 ### contentType ```cpp virtual VideoContentType contentType() = 0; ``` 获取视频帧内容类型，参看 [VideoContentType](#VideoContentType)。 ### timestampUs ```cpp virtual int64_t timestampUs() = 0; ``` 获取视频帧时间戳，单位：微秒 ### width ```cpp virtual int width() = 0; ``` 获取视频帧宽度 ### height ```cpp virtual int height() = 0; ``` 获取视频帧高度 ### rotation ```cpp virtual VideoRotation rotation() = 0; ``` 获取视频帧旋转角度，参看 [VideoRotation](#VideoRotation) ### numberOfPlanes ```cpp virtual int numberOfPlanes() = 0; ``` 获取视频帧平面数量 ### planeData ```cpp virtual uint8_t* planeData(int plane_index) = 0; ``` 获取视频帧平面 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | plane_index | int | plane 索引 | ### planeStride ```cpp virtual int planeStride(int plane_index) = 0; ``` 获取视频帧平面相邻两行图像数据之间的内存长度（单位字节） **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | plane_index | int | plane 索引 | ### seiData ```cpp virtual uint8_t* seiData(int& size) = 0; ``` 获取 SEI 数据指针 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | size | int& | SEI 数据字节数 | ### hwBuffer ```cpp virtual void* hwBuffer() = 0; ``` 获取硬件缓冲区指针 ### hwContext ```cpp virtual void* hwContext() = 0; ``` 获取硬件加速上下文对象句柄 ### textureMatrix ```cpp virtual void textureMatrix(float matrix[16]) = 0; ``` 获取纹理矩阵(仅针对纹理类型的 frame 生效) **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | matrix | float[16] | 纹理矩阵 | ### textureId ```cpp virtual uint32_t textureId() = 0; ``` 获取纹理 ID(仅针对纹理类型的 frame 生效) ### addRef ```cpp virtual void addRef() = 0; ``` 视频帧引用计数加一 **注意** 视频帧消费者希望对视频帧进行异步处理时（例如切换线程进行渲染），需要调用此接口增加引用计数。异步处理结束则需要调用 `releaseRef` 使引用计数减1 ### releaseRef ```cpp virtual long releaseRef() = 0; ``` 视频帧引用计数减一 **注意** 视频帧引用计数减为 0 时，视频帧对象会被释放。视频帧对象释放后，不应该继续使用视频帧。 ### cameraId ```cpp virtual CameraID cameraId() = 0; ``` 获取视频帧的摄像头位置信息，参看 [CameraID](#CameraID) # VideoEncoderConfig ```cpp struct bytertc::VideoEncoderConfig ``` 视频编码配置。参考 [设置视频发布参数](https://www.volcengine.com/docs/6348/70122) ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#VideoEncoderConfig-width) | | int | [height](#VideoEncoderConfig-height) | | int | [frame_rate](#VideoEncoderConfig-frame_rate) | | int | [max_bitrate](#VideoEncoderConfig-max_bitrate) | | int | [min_bitrate](#VideoEncoderConfig-min_bitrate) | | VideoEncodePreference | [encoder_preference](#VideoEncoderConfig-encoder_preference) | ## 变量说明 ### width ```cpp int bytertc::VideoEncoderConfig::width ``` 视频宽度，单位：像素 ### height ```cpp int bytertc::VideoEncoderConfig::height ``` 视频高度，单位：像素 ### frame_rate ```cpp int bytertc::VideoEncoderConfig::frame_rate ``` 视频帧率，单位：fps ### max_bitrate ```cpp int bytertc::VideoEncoderConfig::max_bitrate = SEND_KBPS_AUTO_CALCULATE ``` 最大编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。内部采集模式下默认值为 -1，即适配码率模式，系统将根据输入的分辨率和帧率自动计算适用的码率。设为 0 则不对视频流进行编码发送。 ### min_bitrate ```cpp int bytertc::VideoEncoderConfig::min_bitrate = 0 ``` 视频最小编码码率, 单位 kbps。编码码率不会低于 `minBitrate`。默认值为 `0`。范围：[0, maxBitrate)，当 `maxBitrate` < `minBitrate` 时，为适配码率模式。以下情况，设置本参数无效： - 当 `maxBitrate` 为 `0` 时，不对视频流进行编码发送。 - 当 `maxBitrate` < `0` 时，适配码率模式。 ### encoder_preference ```cpp VideoEncodePreference bytertc::VideoEncoderConfig::encoder_preference = VideoEncodePreference::kVideoEncodePreferenceFramerate ``` 编码策略偏好，默认为帧率优先。参看 [VideoEncodePreference](#VideoEncodePreference)。 # AudioMixingState ```cpp enum bytertc::AudioMixingState ``` 音频混音文件播放状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioMixingStatePreloaded | 0 | 混音已加载 | | kAudioMixingStatePlaying | 1 | 混音正在播放 | | kAudioMixingStatePaused | 2 | 混音暂停 | | kAudioMixingStateStopped | 3 | 混音停止 | | kAudioMixingStateFailed | 4 | 混音播放失败 | | kAudioMixingStateFinished | 5 | 混音播放结束 | | kAudioMixingStatePCMEnabled | 6 | 准备 PCM 混音 | | kAudioMixingStatePCMDisabled | 7 | PCM 混音播放结束 | # AudioSelectionPriority ```cpp enum bytertc::AudioSelectionPriority ``` 音频选路优先级设置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioSelectionPriorityNormal | 0 | 正常，参加音频选路 | | kAudioSelectionPriorityHigh | 1 | 高优先级，跳过音频选路 | # MixedStreamAudioCodecType ```cpp enum bytertc::MixedStreamAudioCodecType ``` 音频编码格式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamAudioCodecTypeAAC | 0 | AAC 格式。 | # ScreenParameters ```cpp struct bytertc::ScreenParameters ``` 屏幕共享参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [frame_rate](#ScreenParameters-frame_rate) | | int | [kbitrate](#ScreenParameters-kbitrate) | | int | [min_kbitrate](#ScreenParameters-min_kbitrate) | ## 变量说明 ### frame_rate ```cpp int bytertc::ScreenParameters::frame_rate = 15 ``` 编码帧率,单位为 fps ### kbitrate ```cpp int bytertc::ScreenParameters::kbitrate = -1 ``` 屏幕采集编码码率, `-1` 为自动码率, SDK 会根据宽高信息选择合适的码率，单位 kbps ### min_kbitrate ```cpp int bytertc::ScreenParameters::min_kbitrate = 0 ``` 视频最小编码码率, 单位 kbps。编码码率不会低于 `min_kbitrate`。默认值为 `0`。范围：[0, kbitrate)，当 `kbitrate` < `min_kbitrate` 时，为适配码率模式。以下情况，设置本参数无效： - 当 `kbitrate` 为 `0` 时，不对视频流进行编码发送。 - 当 `kbitrate` < `0` 时，适配码率模式。 # MixedStreamVideoConfig ```cpp struct bytertc::MixedStreamVideoConfig ``` 视频合流配置参数。值不合法或未设置时，自动使用默认值。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int32_t | [width](#MixedStreamVideoConfig-width) | | int32_t | [height](#MixedStreamVideoConfig-height) | | int32_t | [fps](#MixedStreamVideoConfig-fps) | | int32_t | [gop](#MixedStreamVideoConfig-gop) | | int32_t | [bitrate](#MixedStreamVideoConfig-bitrate) | | MixedStreamVideoCodecType | [video_codec](#MixedStreamVideoConfig-video_codec) | | bool | [enable_bframe](#MixedStreamVideoConfig-enable_bframe) | ## 变量说明 ### width ```cpp int32_t bytertc::MixedStreamVideoConfig::width = MIXED_STREAM_VIDEO_DEFAULT_WIDTH ``` 合流视频宽度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 360 px。建议设置。设置值为非偶数时，自动向上取偶数。 ### height ```cpp int32_t bytertc::MixedStreamVideoConfig::height = MIXED_STREAM_DEFAULT_VIDEO_HEIGHT ``` 合流视频高度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 640 px。建议设置。设置值为非偶数时，自动向上取偶数。 ### fps ```cpp int32_t bytertc::MixedStreamVideoConfig::fps = 15 ``` 合流视频帧率。单位为 FPS，取值范围为 [1,60]，默认值为 15 FPS。建议设置。 ### gop ```cpp int32_t bytertc::MixedStreamVideoConfig::gop = 2 ``` 视频 I 帧时间间隔。单位为秒，取值范围为 [1, 5]，默认值为 2 秒。建议设置。 WTN 流任务不支持设置本参数。本参数不支持过程中更新。 ### bitrate ```cpp int32_t bytertc::MixedStreamVideoConfig::bitrate = 500 ``` 合流视频码率。单位为 Kbps，取值范围为 [1,10000]，默认值为 `500`。建议设置。 ### video_codec ```cpp MixedStreamVideoCodecType bytertc::MixedStreamVideoConfig::video_codec = MixedStreamVideoCodecType::kMixedStreamVideoCodecTypeH264 ``` 视频编码格式，参看 [MixedStreamVideoCodecType](#MixedStreamVideoCodecType)。默认值为 `0`。建议设置。 WTN 流的视频编码格式只能为设置为 `0`，H264。本参数不支持过程中更新。 ### enable_bframe ```cpp bool bytertc::MixedStreamVideoConfig::enable_bframe = false ``` 是否在服务端合流转推中开启 B 帧。 - true：是 - false：否 # NetworkDetectionStopReason ```cpp enum bytertc::NetworkDetectionStopReason ``` 通话前探测的停止原因 `onNetworkDetectionStopped` 回调的参数类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kNetworkDetectionStopReasonUser | 0 | 用户主动停止 | | kNetworkDetectionStopReasonTimeout | 1 | 探测超过三分钟 | | kNetworkDetectionStopReasonConnectionLost | 2 | 探测网络连接断开。
当超过 12s 没有收到回复，SDK 将断开网络连接，并且不再尝试重连。 | | kNetworkDetectionStopReasonStreaming | 3 | 本地开始推拉流，停止探测 | | kNetworkDetectionStopReasonInnerErr | 4 | 网络探测失败，内部异常 | # MixedStreamControlConfig ```cpp struct bytertc::MixedStreamControlConfig ``` 服务端合流控制参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | bool | [enable_volume_indication](#MixedStreamControlConfig-enable_volume_indication) | | float | [volume_indication_interval](#MixedStreamControlConfig-volume_indication_interval) | | int | [talk_volume](#MixedStreamControlConfig-talk_volume) | | bool | [is_add_volume_value](#MixedStreamControlConfig-is_add_volume_value) | | MixedStreamSEIContentMode | [sei_content_mode](#MixedStreamControlConfig-sei_content_mode) | | int | [sei_payload_type](#MixedStreamControlConfig-sei_payload_type) | | const char* | [sei_payload_uuid](#MixedStreamControlConfig-sei_payload_uuid) | | MixedStreamMediaType | [media_type](#MixedStreamControlConfig-media_type) | | MixedStreamPushMode | [push_stream_mode](#MixedStreamControlConfig-push_stream_mode) | ## 变量说明 ### enable_volume_indication ```cpp bool bytertc::MixedStreamControlConfig::enable_volume_indication = false ``` > Available since 3.56 是否开启单独发送声音提示 SEI 的功能： - true：开启； - false：（默认）关闭。开启后，你可以通过 `MixedStreamControlConfig.sei_content_mode` 控制 SEI 的内容是否只携带声音信息。 ### volume_indication_interval ```cpp float bytertc::MixedStreamControlConfig::volume_indication_interval = 2.0f ``` > Available since 3.56 声音提示间隔，单位为秒，取值范围为 [0.3,+∞)，默认值为 2。此值仅取整百毫秒。若传入两位及以上小数，则四舍五入取第一位小数的值。例如，若传入 0.36，则取 0.4。 ### talk_volume ```cpp int bytertc::MixedStreamControlConfig::talk_volume = 0 ``` > Available since 3.56 有效音量大小，取值范围为 [0, 255]，默认值为 0。超出取值范围则自动调整为默认值，即 0。 ### is_add_volume_value ```cpp bool bytertc::MixedStreamControlConfig::is_add_volume_value = false ``` > Available since 3.56 声音信息 SEI 是否包含音量值： - true：是。 - false：（默认）否。 ### sei_content_mode ```cpp MixedStreamSEIContentMode bytertc::MixedStreamControlConfig::sei_content_mode = kMixedStreamSEIContentModeDefault ``` > Available since 3.56 设置 SEI 内容。参看 [MixedStreamSEIContentMode](#MixedStreamSEIContentMode)。默认值为 `0`，视频流中包含全部的 SEI 信息 ### sei_payload_type ```cpp int bytertc::MixedStreamControlConfig::sei_payload_type = 100 ``` > Available since 3.56 SEI 信息的 payload type。默认值为 `100`，只支持设置 `5` 和 `100`。在转推直播的过程中，该参数不支持变更。 ### sei_payload_uuid ```cpp const char* bytertc::MixedStreamControlConfig::sei_payload_uuid = nullptr ``` > Available since 3.56 SEI 信息的 payload UUID。 **注意** PayloadType 为 `5` 时，必须填写 PayloadUUID，否则会收到错误回调，错误码为 1091。 PayloadType 不是 `5` 时，不需要填写 PayloadUUID，如果填写会被后端忽略。该参数长度需为 32 位，否则会收到错误码为 1091 的回调。该参数每个字符的范围需为 [0, 9] [a, f] [A, F] 该参数不应带有`-`字符，如系统自动生成的 UUID 中带有`-`，则应删去。在转推直播的过程中，该参数不支持变更。 ### media_type ```cpp MixedStreamMediaType bytertc::MixedStreamControlConfig::media_type = MixedStreamMediaType::kMixedStreamMediaTypeAudioAndVideo ``` > Available since 3.57 设置合流推到 CDN 时输出的媒体流类型。参看 [MixedStreamMediaType](#MixedStreamMediaType)。默认输出音视频流。支持输出纯音频流，但暂不支持输出纯视频流。 ### push_stream_mode ```cpp MixedStreamPushMode bytertc::MixedStreamControlConfig::push_stream_mode = MixedStreamPushMode::kMixedStreamPushModeOnStream ``` > Available since 3.57 设置是否在没有用户发布流的情况下发起转推直播，默认不允许。具体参看 [MixedStreamPushMode](#MixedStreamPushMode)。该参数在发起合流任务后的转推直播过程中不支持动态变更。 # VirtualBackgroundSource ```cpp struct bytertc::VirtualBackgroundSource ``` 虚拟背景对象。 ## 成员变量 | 类型 | 名称 | | --- | --- | | VirtualBackgroundSourceType | [source_type](#VirtualBackgroundSource-source_type) | | uint32_t | [source_color](#VirtualBackgroundSource-source_color) | | const char* | [source_path](#VirtualBackgroundSource-source_path) | ## 变量说明 ### source_type ```cpp VirtualBackgroundSourceType bytertc::VirtualBackgroundSource::source_type = kVirtualBackgroundSourceTypeColor ``` 虚拟背景类型，详见 [VirtualBackgroundSourceType](#VirtualBackgroundSourceType) 。 ### source_color ```cpp uint32_t bytertc::VirtualBackgroundSource::source_color = 0xFFFFFFFF ``` 纯色背景使用的颜色。格式为 0xAARRGGBB 。 ### source_path ```cpp const char* bytertc::VirtualBackgroundSource::source_path = nullptr ``` 自定义背景图片的绝对路径。 - 支持的格式为 jpg、jpeg、png。 - 图片分辨率超过 1080P 时，图片会被等比缩放至和视频一致。 - 图片和视频宽高比一致时，图片会被直接缩放至和视频一致。 - 图片和视频长宽比不一致时，为保证图片内容不变形，图片按短边缩放至与视频帧一致，使图片填满视频帧，对多出的高或宽进行剪裁。 - 自定义图片带有局部透明效果时，透明部分由黑色代替。 # RenderTargetType ```cpp enum bytertc::RenderTargetType ``` 渲染目标类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRenderTargetTypeView | 0 | 指定渲染目标类型为 SurfaceView/TextureView (Android), UIView(iOS), NSView(macOS), HWND (Windows) | | kRenderTargetTypeSurface | 1 | 仅在 Android 平台生效，指定渲染目标类型为 Surface | # SVCLayer ```cpp enum bytertc::SVCLayer ``` 时域分层定义 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSVCLayerDefault | 0 | 不指定分层（默认值） | | kSVCLayerBase | 1 | T0 层 | | kSVCLayerMain | 2 | T0+T1 层 | | kSVCLayerHigh | 3 | T0+T1+T2 层 | # HttpProxyState ```cpp enum bytertc::HttpProxyState ``` HTTP/HTTPS 代理状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kHttpProxyStateInit | 0 | HTTP/HTTPS 初始化状态 | | kHttpProxyStateConnected | 1 | HTTP/HTTPS 连接成功 | | kHttpProxyStateError | 2 | HTTP/HTTPS 连接失败 | # RecordingConfig ```cpp struct bytertc::RecordingConfig ``` 本地录制参数配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [dir_path](#RecordingConfig-dir_path) | | RecordingFileType | [file_type](#RecordingConfig-file_type) | ## 变量说明 ### dir_path ```cpp const char* bytertc::RecordingConfig::dir_path ``` 录制文件保存的绝对路径，需精确到文件夹，文件名由 RTC 自动生成。你需要确保对该路径具有读写权限。 ### file_type ```cpp RecordingFileType bytertc::RecordingConfig::file_type ``` 录制存储文件格式，参看 [RecordingFileType](#RecordingFileType) # LoginType ```cpp enum bytertc::LoginType ``` 用户登录的类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLoginTypeFirst | 0 | 首次登录。用户手动调用 `login`，收到登录成功。 | | kLoginTypeReconnected | 1 | 重连。用户网络较差，失去与服务器的连接，SDK 自动重连登录成功。 | # ScreenCaptureParameters ```cpp struct bytertc::ScreenCaptureParameters ``` 屏幕共享内部采集参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | Rectangle | [region_rect](#ScreenCaptureParameters-region_rect) | | MouseCursorCaptureState | [capture_mouse_cursor](#ScreenCaptureParameters-capture_mouse_cursor) | | ScreenFilterConfig | [filter_config](#ScreenCaptureParameters-filter_config) | | HighlightConfig | [highlight_config](#ScreenCaptureParameters-highlight_config) | ## 变量说明 ### region_rect ```cpp Rectangle bytertc::ScreenCaptureParameters::region_rect ``` 采集区域，参看 [Rectangle](#Rectangle)。 ### capture_mouse_cursor ```cpp MouseCursorCaptureState bytertc::ScreenCaptureParameters::capture_mouse_cursor = MouseCursorCaptureState::kMouseCursorCaptureStateOn ``` 是否采集鼠标状态，参看 [MouseCursorCaptureState](#MouseCursorCaptureState)。 ### filter_config ```cpp ScreenFilterConfig bytertc::ScreenCaptureParameters::filter_config ``` 屏幕过滤设置，填写不需要采集的窗口 ID，参看 [ScreenFilterConfig](#ScreenFilterConfig)。 ### highlight_config ```cpp HighlightConfig bytertc::ScreenCaptureParameters::highlight_config ``` 采集区域的边框高亮设置，参看 [HighlightConfig](#HighlightConfig)。 # VideoRotationMode ```cpp enum bytertc::VideoRotationMode ``` 视频旋转模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoRotationModeFollowApp | 0 | 跟随 App 界面方向 | | kVideoRotationModeFollowGSensor | 1 | 跟随设备重力方向 | # EarMonitorMode ```cpp enum bytertc::EarMonitorMode ``` 是否开启耳返功能。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kEarMonitorModeOff | 0 | 关闭 | | kEarMonitorModeOn | 1 | 开启 | # ManagedMemory ```cpp struct bytertc::ManagedMemory ``` 自定义内存释放器 ## 成员变量 | 类型 | 名称 | | --- | --- | | uint8_t* | [data](#ManagedMemory-data) | | int | [size](#ManagedMemory-size) | | void* | [user_opaque](#ManagedMemory-user_opaque) | | int(*)(uint8_t*data, int size, void*user_opaque) | [memory_deleter](#ManagedMemory-memory_deleter) | ## 变量说明 ### data ```cpp uint8_t* bytertc::ManagedMemory::data = nullptr ``` 内存数据地址 ### size ```cpp int bytertc::ManagedMemory::size = 0 ``` 内存空间的大小 ### user_opaque ```cpp void* bytertc::ManagedMemory::user_opaque = nullptr ``` 用户自定义数据 ### memory_deleter ```cpp int(* bytertc::ManagedMemory::memory_deleter) (uint8_t *data, int size, void *user_opaque) = nullptr ``` 自定义内存释放方法指针，如果指针不为空，方法会被调用，用来释放内存空间。函数传入的参数分别是本结构体内 data、size、user_opaque 3 个字段。 # NetworkQuality ```cpp enum bytertc::NetworkQuality ``` 媒体流网络质量。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kNetworkQualityUnknown | 0 | 网络质量未知。 | | kNetworkQualityExcellent | 1 | 网络质量极好。 | | kNetworkQualityGood | 2 | 主观感觉和 kNetworkQualityExcellent 差不多，但码率可能略低。 | | kNetworkQualityPoor | 3 | 主观感受有瑕疵但不影响沟通。 | | kNetworkQualityBad | 4 | 勉强能沟通但不顺畅。 | | kNetworkQualityVbad | 5 | 网络质量非常差，基本不能沟通。 | | kNetworkQualityDown | 6 | 网络连接断开，无法通话。网络可能由于 12s 内无应答、开启飞行模式、拔掉网线等原因断开。

更多网络状态信息参见 [连接状态提示](https://www.volcengine.com/docs/6348/95376)。 | # RemoteVideoStats ```cpp struct bytertc::RemoteVideoStats ``` 远端视频流统计信息，统计周期为 2s 。本地用户订阅远端视频流成功后，SDK 会周期性地通过 `onRemoteStreamStats` 通知本地用户订阅的远端视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#RemoteVideoStats-width) | | int | [height](#RemoteVideoStats-height) | | float | [video_loss_rate](#RemoteVideoStats-video_loss_rate) | | int | [received_kbitrate](#RemoteVideoStats-received_kbitrate) | | int | [decoder_output_frame_rate](#RemoteVideoStats-decoder_output_frame_rate) | | int | [renderer_output_frame_rate](#RemoteVideoStats-renderer_output_frame_rate) | | int | [stall_count](#RemoteVideoStats-stall_count) | | int | [stall_duration](#RemoteVideoStats-stall_duration) | | long | [e2e_delay](#RemoteVideoStats-e2e_delay) | | bool | [is_screen](#RemoteVideoStats-is_screen) | | int | [stats_interval](#RemoteVideoStats-stats_interval) | | int | [rtt](#RemoteVideoStats-rtt) | | int | [frozen_rate](#RemoteVideoStats-frozen_rate) | | VideoCodecType | [codec_type](#RemoteVideoStats-codec_type) | | int | [video_index](#RemoteVideoStats-video_index) | | int | [jitter](#RemoteVideoStats-jitter) | | int | [codec_elapse_per_frame](#RemoteVideoStats-codec_elapse_per_frame) | | int | [cap_to_render_delay](#RemoteVideoStats-cap_to_render_delay) | | int | [av_sync_diff_ms](#RemoteVideoStats-av_sync_diff_ms) | ## 变量说明 ### width ```cpp int bytertc::RemoteVideoStats::width ``` 视频宽度 ### height ```cpp int bytertc::RemoteVideoStats::height ``` 视频高度 ### video_loss_rate ```cpp float bytertc::RemoteVideoStats::video_loss_rate ``` 视频丢包率。统计周期内的视频下行丢包率，取值范围：[0，1] 。 ### received_kbitrate ```cpp int bytertc::RemoteVideoStats::received_kbitrate ``` 接收码率。统计周期内的视频接收码率，单位为 kbps 。 ### decoder_output_frame_rate ```cpp int bytertc::RemoteVideoStats::decoder_output_frame_rate ``` 解码器输出帧率。统计周期内的视频解码器输出帧率，单位 fps 。 ### renderer_output_frame_rate ```cpp int bytertc::RemoteVideoStats::renderer_output_frame_rate ``` 渲染帧率。统计周期内的视频渲染帧率，单位 fps 。 ### stall_count ```cpp int bytertc::RemoteVideoStats::stall_count ``` 卡顿次数。统计周期内的卡顿次数。 ### stall_duration ```cpp int bytertc::RemoteVideoStats::stall_duration ``` 卡顿时长。统计周期内的视频卡顿总时长。单位 ms 。 ### e2e_delay ```cpp long bytertc::RemoteVideoStats::e2e_delay ``` 用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为 ms 。 ### is_screen ```cpp bool bytertc::RemoteVideoStats::is_screen ``` 预留字段。 ### stats_interval ```cpp int bytertc::RemoteVideoStats::stats_interval ``` 统计间隔，此次统计周期的间隔，单位为 ms 。此字段用于设置回调的统计周期，目前设置为 2s 。 ### rtt ```cpp int bytertc::RemoteVideoStats::rtt ``` 往返时延，单位为 ms 。 ### frozen_rate ```cpp int bytertc::RemoteVideoStats::frozen_rate ``` 远端用户在进房后发生视频卡顿的累计时长占视频总有效时长的百分比（\%）。视频有效时长是指远端用户进房发布视频流后，除停止发送视频流和禁用视频模块之外的视频时长。 ### codec_type ```cpp VideoCodecType bytertc::RemoteVideoStats::codec_type ``` 视频的编码类型，具体参考 [VideoCodecType](#VideoCodecType) 。 ### video_index ```cpp int bytertc::RemoteVideoStats::video_index ``` 对应多种分辨率的流的下标。 ### jitter ```cpp int bytertc::RemoteVideoStats::jitter ``` 视频下行网络抖动，单位为 ms。 ### codec_elapse_per_frame ```cpp int bytertc::RemoteVideoStats::codec_elapse_per_frame ``` 视频解码平均耗时，单位 ms。 ### cap_to_render_delay ```cpp int bytertc::RemoteVideoStats::cap_to_render_delay ``` 用户体验级别的端到端延时。从发送端开始采集到接收端渲染完成的延时，单位为 ms 。 ### av_sync_diff_ms ```cpp int bytertc::RemoteVideoStats::av_sync_diff_ms ``` 音画同步差异，单位为 ms 。 # RemoteAudioState ```cpp enum bytertc::RemoteAudioState ``` 远端音频流状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteAudioStateStopped | 0 | 不接收远端音频流。 | | kRemoteAudioStateStarting | 1 | 开始接收远端音频流首包。 | | kRemoteAudioStateDecoding | 2 | 远端音频流正在解码，正常播放。 | | kRemoteAudioStateFrozen | 3 | 远端音频流卡顿。 | # AggregationOption ```cpp enum bytertc::AggregationOption ``` > Available since 3.56 流聚合策略 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAggregationOptionMin | 0 | 流聚合向下取值（默认策略） | | kAggregationOptionMax | 1 | 流聚合向上取值 | | kAggregationOptionMajority | 2 | 流聚合按比例取值，比例相同时，向下取值 | # DestInfo ```cpp struct bytertc::DestInfo ``` 单流转推配置目标房间信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [room_id](#DestInfo-room_id) | | const char* | [user_id](#DestInfo-user_id) | ## 变量说明 ### room_id ```cpp const char* bytertc::DestInfo::room_id ``` 跨房间转发媒体流过程中目标房间 ID ### user_id ```cpp const char* bytertc::DestInfo::user_id ``` 转发目标房间中自定义用户ID # UserWorkerType ```cpp enum bytertc::UserWorkerType ``` 定义 linux 用户的用户功能 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kUserWorkerTypeNormal | 0 | 正常用户，没有任何特殊属性 | | kUserWorkerTypeSupportSip | 1 << 0 | 用户支持 SIP 流，信令只下发 SIP 流 | | kUserWorkerTypeByteVc1Transcoder | 1 << 1 | 用户支持屏幕流的 bytevc1 到 H264 转码 | | kUserWorkerTypeNeedUserListAndCb | 1 << 2 | 用户需要信令服务器下发全量的用户列表和回调函数 | | kUserWorkerTypeNeedStreamCallBack | 1 << 3 | 用户需要在房间进入多人模式时获取房间内所有流的相关回调 | | kUserWorkerTypeAudioSelectionExemption | 1 << 4 | 用户选择设置不支持音频选路功能 | # RemoteStreamSwitch ```cpp struct bytertc::RemoteStreamSwitch ``` 流切换信息。本地用户订阅的远端流触发回退策略时的流切换信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [uid](#RemoteStreamSwitch-uid) | | bool | [is_screen](#RemoteStreamSwitch-is_screen) | | int | [before_video_index](#RemoteStreamSwitch-before_video_index) | | int | [after_video_index](#RemoteStreamSwitch-after_video_index) | | bool | [before_enable](#RemoteStreamSwitch-before_enable) | | bool | [after_enable](#RemoteStreamSwitch-after_enable) | | FallbackOrRecoverReason | [reason](#RemoteStreamSwitch-reason) | ## 变量说明 ### uid ```cpp const char* bytertc::RemoteStreamSwitch::uid ``` 订阅的音视频流的发布者的用户 ID。 ### is_screen ```cpp bool bytertc::RemoteStreamSwitch::is_screen ``` 预留字段。 ### before_video_index ```cpp int bytertc::RemoteStreamSwitch::before_video_index ``` 流切换前本地用户订阅的视频流的分辨率对应的索引。 ### after_video_index ```cpp int bytertc::RemoteStreamSwitch::after_video_index ``` 流切换后本地用户订阅的视频流的分辨率对应的索引。 ### before_enable ```cpp bool bytertc::RemoteStreamSwitch::before_enable ``` 流切换前是否有视频流。 ### after_enable ```cpp bool bytertc::RemoteStreamSwitch::after_enable ``` 流切换后是否有视频流。 ### reason ```cpp FallbackOrRecoverReason bytertc::RemoteStreamSwitch::reason ``` 触发流回退的原因，详见类型 [FallbackOrRecoverReason](#FallbackOrRecoverReason) 。 # VideoDeviceFacing ```cpp enum bytertc::VideoDeviceFacing ``` 视频设备朝向类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoDeviceFacingFront | 0 | 前置摄像头 | | kVideoDeviceFacingBack | 1 | 后置摄像头 | | kVideoDeviceFacingUnknown | 2 | 未知类型 | # ForwardStreamState ```cpp enum bytertc::ForwardStreamState ``` 媒体流跨房间转发状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kForwardStreamStateIdle | 0 | 空闲状态

成功调用 `stopForwardStreamToRooms` 后，所有目标房间为空闲状态。
成功调用 `updateForwardStreamToRooms` 减少目标房间后，本次减少的目标房间为空闲状态。

| | kForwardStreamStateSuccess | 1 | 开始转发

调用 `startForwardStreamToRooms` 成功向所有房间开始转发媒体流后，返回此状态。
调用 `updateForwardStreamToRooms` 后，成功向新增目标房间开始转发媒体流后，返回此状态。

| | kForwardStreamStateFailure | 2 | 转发失败，失败详情参考 [ForwardStreamError](#ForwardStreamError)

调用 `startForwardStreamToRooms` 或 `updateForwardStreamToRooms` 后，如遇转发失败，返回此状态。 | # SEICountPerFrame ```cpp enum bytertc::SEICountPerFrame ``` SEI 发送模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSEICountPerFrameSingle | 0 | 单发模式。
在 1 帧间隔内多次发送 SEI 数据时，SEI 数据会按顺序跟随连续的视频帧逐帧发送，单个视频帧最多只有一个 SEI 数据。
例如，假设在某一帧间隔内需要发送 3 个 SEI 数据，那么第 1 个 SEI 会在当前帧发送，第 2 个 SEI 会在下一帧发送，第 3 个 SEI 会在再下一帧发送。 | | kSEICountPerFrameMulti | 1 | 多发模式。
在 1 帧间隔内多次发送 SEI 数据时，这些 SEI 数据会全部在下一个视频帧上发送。这种模式可以降低发送延迟，但单个视频帧会携带多个 SEI 数据。
例如，假设在某一帧间隔内有 3 个 SEI 数据需要发送，这 3 个 SEI 数据将全部在下一个视频帧上发送。 | # RemoteVideoSinkPosition ```cpp enum bytertc::RemoteVideoSinkPosition ``` 远端视频帧回调位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteVideoSinkPositionAfterPostProcess | 1 | （默认值）后处理后。 | # VideoSolution ```cpp struct bytertc::VideoSolution ``` > Deprecated since 3.36 along with setVideoEncoderConfig(StreamIndex index, const VideoSolution* solutions, int solution_num) = 0; 视频流参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#VideoSolution-width) | | int | [height](#VideoSolution-height) | | int | [fps](#VideoSolution-fps) | | int | [max_send_kbps](#VideoSolution-max_send_kbps) | | int | [min_send_kbps](#VideoSolution-min_send_kbps) | | VideoEncodePreference | [encode_preference](#VideoSolution-encode_preference) | ## 变量说明 ### width ```cpp int bytertc::VideoSolution::width ``` 视频宽度，单位：像素 ### height ```cpp int bytertc::VideoSolution::height ``` 视频高度，单位：像素 ### fps ```cpp int bytertc::VideoSolution::fps ``` 视频帧率 ### max_send_kbps ```cpp int bytertc::VideoSolution::max_send_kbps = SEND_KBPS_AUTO_CALCULATE ``` 最大发送编码码率（kbps），建议使用默认的自动码率。\

-1：自动码率\

\

0：不开启上限\

\

>0：填写预估码率\

### min_send_kbps ```cpp int bytertc::VideoSolution::min_send_kbps = 0 ``` ### encode_preference ```cpp VideoEncodePreference bytertc::VideoSolution::encode_preference = VideoEncodePreference::kVideoEncodePreferenceFramerate ``` 视频编码质量策略，参看 [VideoEncodePreference](#VideoEncodePreference) # EarMonitorAudioFilter ```cpp enum bytertc::EarMonitorAudioFilter ``` 耳返音频是否经过本地音频处理。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kEarMonitorAudioFilterNone | 0x1 | 无音频处理。 | | kEarMonitorAudioFilterReuseAudioProcessing | 0x8000 | 经本地音频处理后的音频，包括 3A、变声、混响等 SDK 提供处理能力以及自定义音频处理。 | # DataFrameType ```cpp enum bytertc::DataFrameType ``` 数据帧类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kDataFrameTypeSei | 0 | SEI 视频帧 | # SubscribeStateChangeReason ```cpp enum bytertc::SubscribeStateChangeReason ``` 订阅状态变化原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSubscribeStateChangeReasonSubscribe | 0 | 本端调用订阅 | | kSubscribeStateChangeReasonUnsubscribe | 1 | 本端取消订阅 | | kSubscribeStateChangeReasonRemotePublish | 2 | 远端发布流 | | kSubscribeStateChangeReasonRemoteUnpublish | 3 | 远端取消发布流 | | kSubscribeStateChangeReasonStreamFailed5xx | 4 | 由于服务器错误导致订阅失败。SDK 会自动重试订阅 | | kSubscribeStateChangeReasonStreamFailed404 | 5 | 当前房间中找不到订阅的音视频流导致订阅失败。SDK 会自动重试订阅，若仍订阅失败则建议你退出重试。 | | kSubscribeStateChangeReasonOverStreamSubscribeLimit | 6 | 当用户订阅的音视频流总数已达上限时，继续订阅更多流时会失败，同时用户会收到此错误通知。 | | kSubscribeStateChangeReasonNoSubscribePermission | 7 | 用户订阅所在房间中的音视频流失败，失败原因为用户没有订阅流的权限。 | # RtcRoomStats ```cpp struct bytertc::RtcRoomStats ``` 通话相关的统计信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [tx_lostrate](#RtcRoomStats-tx_lostrate) | | float | [rx_lostrate](#RtcRoomStats-rx_lostrate) | | int | [rtt](#RtcRoomStats-rtt) | | unsigned int | [duration](#RtcRoomStats-duration) | | unsigned int | [tx_bytes](#RtcRoomStats-tx_bytes) | | unsigned int | [rx_bytes](#RtcRoomStats-rx_bytes) | | unsigned short | [tx_kbitrate](#RtcRoomStats-tx_kbitrate) | | unsigned short | [rx_kbitrate](#RtcRoomStats-rx_kbitrate) | | unsigned short | [rx_audio_kbitrate](#RtcRoomStats-rx_audio_kbitrate) | | unsigned short | [tx_audio_kbitrate](#RtcRoomStats-tx_audio_kbitrate) | | unsigned short | [rx_video_kbitrate](#RtcRoomStats-rx_video_kbitrate) | | unsigned short | [tx_video_kbitrate](#RtcRoomStats-tx_video_kbitrate) | | unsigned short | [rx_screen_kbitrate](#RtcRoomStats-rx_screen_kbitrate) | | unsigned short | [tx_screen_kbitrate](#RtcRoomStats-tx_screen_kbitrate) | | unsigned int | [user_count](#RtcRoomStats-user_count) | | double | [cpu_app_usage](#RtcRoomStats-cpu_app_usage) | | unsigned short | [tx_cellular_kbitrate](#RtcRoomStats-tx_cellular_kbitrate) | | unsigned short | [rx_cellular_kbitrate](#RtcRoomStats-rx_cellular_kbitrate) | ## 变量说明 ### tx_lostrate ```cpp float bytertc::RtcRoomStats::tx_lostrate ``` 当前应用的上行丢包率，取值范围为 [0, 1] ### rx_lostrate ```cpp float bytertc::RtcRoomStats::rx_lostrate ``` 当前应用的下行丢包率，取值范围为 [0, 1] ### rtt ```cpp int bytertc::RtcRoomStats::rtt ``` 客户端到服务端数据传输的往返时延（单位 ms） ### duration ```cpp unsigned int bytertc::RtcRoomStats::duration ``` 本地用户在本次通话中的参与时长，单位为 s ### tx_bytes ```cpp unsigned int bytertc::RtcRoomStats::tx_bytes ``` 本地用户的总发送字节数 (bytes)，累计值 ### rx_bytes ```cpp unsigned int bytertc::RtcRoomStats::rx_bytes ``` 本地用户的总接收字节数 (bytes)，累计值 ### tx_kbitrate ```cpp unsigned short bytertc::RtcRoomStats::tx_kbitrate ``` 发送码率（kbps），获取该数据时的瞬时值 ### rx_kbitrate ```cpp unsigned short bytertc::RtcRoomStats::rx_kbitrate ``` 接收码率（kbps），获取该数据时的瞬时值 ### rx_audio_kbitrate ```cpp unsigned short bytertc::RtcRoomStats::rx_audio_kbitrate ``` 音频接收码率（kbps），获取该数据时的瞬时值 ### tx_audio_kbitrate ```cpp unsigned short bytertc::RtcRoomStats::tx_audio_kbitrate ``` 音频包的发送码率（kbps），获取该数据时的瞬时值 ### rx_video_kbitrate ```cpp unsigned short bytertc::RtcRoomStats::rx_video_kbitrate ``` 视频接收码率（kbps），获取该数据时的瞬时值 ### tx_video_kbitrate ```cpp unsigned short bytertc::RtcRoomStats::tx_video_kbitrate ``` 视频发送码率（kbps），获取该数据时的瞬时值 ### rx_screen_kbitrate ```cpp unsigned short bytertc::RtcRoomStats::rx_screen_kbitrate ``` 屏幕接收码率，获取该数据时的瞬时值，单位为 Kbps ### tx_screen_kbitrate ```cpp unsigned short bytertc::RtcRoomStats::tx_screen_kbitrate ``` 屏幕发送码率，获取该数据时的瞬时值，单位为 Kbps ### user_count ```cpp unsigned int bytertc::RtcRoomStats::user_count ``` 当前房间内的可见用户人数 ### cpu_app_usage ```cpp double bytertc::RtcRoomStats::cpu_app_usage ``` 当前应用的 CPU 使用率 (\%) ### tx_cellular_kbitrate ```cpp unsigned short bytertc::RtcRoomStats::tx_cellular_kbitrate ``` 蜂窝路径发送的码率 (kbps)，为获取该数据时的瞬时值 ### rx_cellular_kbitrate ```cpp unsigned short bytertc::RtcRoomStats::rx_cellular_kbitrate ``` 蜂窝路径接收码率 (kbps)，为获取该数据时的瞬时值 # VideoCodecMode ```cpp enum bytertc::VideoCodecMode ``` 视频编码模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoCodecModeAuto | 0 | 自动选择 | | kVideoCodecModeHardware | 1 | 硬编码 | | kVideoCodecModeSoftware | 2 | 软编码 | # ProblemFeedbackRoomInfo ```cpp struct bytertc::ProblemFeedbackRoomInfo ``` 音视频质量反馈的房间信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [room_id](#ProblemFeedbackRoomInfo-room_id) | | const char* | [user_id](#ProblemFeedbackRoomInfo-user_id) | ## 变量说明 ### room_id ```cpp const char* bytertc::ProblemFeedbackRoomInfo::room_id = nullptr ``` 房间 ID。 ### user_id ```cpp const char* bytertc::ProblemFeedbackRoomInfo::user_id = nullptr ``` 本地用户 ID。 # IEncodedVideoFrame ```cpp class bytertc::IEncodedVideoFrame ``` 视频帧信息 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual VideoCodecType | [codecType](#IEncodedVideoFrame-codectype) | | virtual int64_t | [timestampUs](#IEncodedVideoFrame-timestampus) | | virtual int64_t | [timestampDtsUs](#IEncodedVideoFrame-timestampdtsus) | | virtual int | [width](#IEncodedVideoFrame-width) | | virtual int | [height](#IEncodedVideoFrame-height) | | virtual VideoPictureType | [pictureType](#IEncodedVideoFrame-picturetype) | | virtual VideoRotation | [rotation](#IEncodedVideoFrame-rotation) | | virtual uint8_t* | [data](#IEncodedVideoFrame-data) | | virtual int | [dataSize](#IEncodedVideoFrame-datasize) | | virtual IEncodedVideoFrame* | [shallowCopy](#IEncodedVideoFrame-shallowcopy) | | virtual void | [release](#IEncodedVideoFrame-release) | ## 函数说明 ### codecType ```cpp virtual VideoCodecType codecType() const = 0; ``` 获取视频编码类型 **返回值** 视频编码类型，参看 [VideoCodecType](#VideoCodecType) ### timestampUs ```cpp virtual int64_t timestampUs() const = 0; ``` 获取视频采集时间戳 **返回值** 视频采集时间戳，单位：微秒 ### timestampDtsUs ```cpp virtual int64_t timestampDtsUs() const = 0; ``` 获取视频编码时间戳 **返回值** 视频编码时间戳，单位：微秒 ### width ```cpp virtual int width() const = 0; ``` 获取视频帧宽度 **返回值** 视频帧宽度，单位：px ### height ```cpp virtual int height() const = 0; ``` 获取视频帧高度 **返回值** 视频帧高度，单位：px ### pictureType ```cpp virtual VideoPictureType pictureType() const = 0; ``` 获取视频编码帧类型 **返回值** 视频编码帧类型，参看 [VideoPictureType](#VideoPictureType) ### rotation ```cpp virtual VideoRotation rotation() const = 0; ``` 获取视频帧旋转角度 **返回值** 视频帧旋转角度，参看 [VideoRotation](#VideoRotation) ### data ```cpp virtual uint8_t* data() const = 0; ``` 获取视频帧数据指针地址 **返回值** 视频帧数据指针地址 ### dataSize ```cpp virtual int dataSize() const = 0; ``` 获取视频帧数据大小 **返回值** 视频帧数据大小 ### shallowCopy ```cpp virtual IEncodedVideoFrame* shallowCopy() const = 0; ``` 浅拷贝视频帧并返回指针 ### release ```cpp virtual void release() = 0; protected: ``` 释放视频帧 # RecordingProgress ```cpp struct bytertc::RecordingProgress ``` 本地录制进度 ## 成员变量 | 类型 | 名称 | | --- | --- | | unsigned long long | [duration](#RecordingProgress-duration) | | unsigned long long | [file_size](#RecordingProgress-file_size) | ## 变量说明 ### duration ```cpp unsigned long long bytertc::RecordingProgress::duration ``` 当前文件的累计录制时长，单位：毫秒 ### file_size ```cpp unsigned long long bytertc::RecordingProgress::file_size ``` 当前录制文件的大小，单位：byte # FallbackOrRecoverReason ```cpp enum bytertc::FallbackOrRecoverReason ``` 远端订阅流发生回退或恢复的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kFallbackOrRecoverReasonUnknown | -1 | 其他原因，非带宽和性能原因引起的回退或恢复。默认值 | | kFallbackOrRecoverReasonSubscribeFallbackByBandwidth | 0 | 由带宽不足导致的订阅端音视频流回退。 | | kFallbackOrRecoverReasonSubscribeFallbackByPerformance | 1 | 由性能不足导致的订阅端音视频流回退。 | | kFallbackOrRecoverReasonSubscribeRecoverByBandwidth | 2 | 由带宽恢复导致的订阅端音视频流恢复。 | | kFallbackOrRecoverReasonSubscribeRecoverByPerformance | 3 | 由性能恢复导致的订阅端音视频流恢复。 | | kFallbackOrRecoverReasonPublishFallbackByBandwidth | 4 | 由带宽不足导致的发布端音视频流回退。 | | kFallbackOrRecoverReasonPublishFallbackByPerformance | 5 | 由性能不足导致的发布端音视频流回退。 | | kFallbackOrRecoverReasonPublishRecoverByBandwidth | 6 | 由带宽恢复导致的发布端音视频流恢复。 | | kFallbackOrRecoverReasonPublishRecoverByPerformance | 7 | 由性能恢复导致的发布端音视频流恢复。 | # SubscribeState ```cpp enum bytertc::SubscribeState ``` 订阅状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSubscribeStateSubscribed | 0 | 订阅成功 | | kSubscribeStateUnsubscribed | 1 | 订阅失败 | # EncodedVideoFrameBuilder ```cpp struct bytertc::EncodedVideoFrameBuilder ``` 视频帧参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | VideoCodecType | [codec_type](#EncodedVideoFrameBuilder-codec_type) | | VideoPictureType | [picture_type](#EncodedVideoFrameBuilder-picture_type) | | VideoRotation | [rotation](#EncodedVideoFrameBuilder-rotation) | | uint8_t* | [data](#EncodedVideoFrameBuilder-data) | | int | [size](#EncodedVideoFrameBuilder-size) | | int | [width](#EncodedVideoFrameBuilder-width) | | int | [height](#EncodedVideoFrameBuilder-height) | | int64_t | [timestamp_us](#EncodedVideoFrameBuilder-timestamp_us) | | int64_t | [timestamp_dts_us](#EncodedVideoFrameBuilder-timestamp_dts_us) | | int(*)(uint8_t*data, int size, void*user_opaque) | [memory_deleter](#EncodedVideoFrameBuilder-memory_deleter) | ## 变量说明 ### codec_type ```cpp VideoCodecType bytertc::EncodedVideoFrameBuilder::codec_type = kVideoCodecTypeUnknown ``` 视频帧编码格式，参看 [VideoCodecType](#VideoCodecType) ### picture_type ```cpp VideoPictureType bytertc::EncodedVideoFrameBuilder::picture_type = kVideoPictureTypeUnknown ``` 视频帧编码类型，参看 [VideoPictureType](#VideoPictureType) ### rotation ```cpp VideoRotation bytertc::EncodedVideoFrameBuilder::rotation = kVideoRotation0 ``` 视频帧旋转角度，参看 [VideoRotation](#VideoRotation) ### data ```cpp uint8_t* bytertc::EncodedVideoFrameBuilder::data = nullptr ``` 视频帧数据指针 **注意** IEncodedVideoFrame 会获取数据的所有权 ### size ```cpp int bytertc::EncodedVideoFrameBuilder::size = 0 ``` 视频帧数据大小 ### width ```cpp int bytertc::EncodedVideoFrameBuilder::width = 0 ``` 视频帧宽度，单位：px ### height ```cpp int bytertc::EncodedVideoFrameBuilder::height = 0 ``` 视频帧高度，单位：px ### timestamp_us ```cpp int64_t bytertc::EncodedVideoFrameBuilder::timestamp_us = 0 ``` 视频采集时间戳，单位：微秒 ### timestamp_dts_us ```cpp int64_t bytertc::EncodedVideoFrameBuilder::timestamp_dts_us = 0 ``` 视频编码时间戳，单位：微秒 ### memory_deleter ```cpp int(* bytertc::EncodedVideoFrameBuilder::memory_deleter) (uint8_t *data, int size, void *user_opaque) = nullptr ``` 用户定义的视频帧释放回调函数指针，如果指针不为空，方法会被调用用来释放内存空间 # PushSingleStreamParam ```cpp struct bytertc::PushSingleStreamParam ``` 单流转推直播配置参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [room_id](#PushSingleStreamParam-room_id) | | const char* | [user_id](#PushSingleStreamParam-user_id) | | const char* | [uri](#PushSingleStreamParam-uri) | | bool | [is_screen_stream](#PushSingleStreamParam-is_screen_stream) | | DestInfo* | [dest_info](#PushSingleStreamParam-dest_info) | | int32_t | [dest_info_size](#PushSingleStreamParam-dest_info_size) | | SingleStreamPushType | [push_type](#PushSingleStreamParam-push_type) | ## 变量说明 ### room_id ```cpp const char* bytertc::PushSingleStreamParam::room_id ``` 媒体流所在的房间 ID ### user_id ```cpp const char* bytertc::PushSingleStreamParam::user_id ``` 媒体流所属的用户 ID ### uri ```cpp const char* bytertc::PushSingleStreamParam::uri ``` 推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 `/^rtmps?:\\/\\//`。本参数不支持过程中更新。 ### is_screen_stream ```cpp bool bytertc::PushSingleStreamParam::is_screen_stream ``` 预留字段。 ### dest_info ```cpp DestInfo* bytertc::PushSingleStreamParam::dest_info = nullptr ``` 转推目标房间数组，默认值为nullptr ### dest_info_size ```cpp int32_t bytertc::PushSingleStreamParam::dest_info_size = 0 ``` 转推目标房间数量,`dest_info` 的数组长度，默认值为0,取值范围[0, 8] ### push_type ```cpp SingleStreamPushType bytertc::PushSingleStreamParam::push_type = kPushToCDN ``` 单流转推类型，指定将媒体流转推到 CDN 还是 RTC 房间，默认值为转推到 CDN。 # VoiceEqualizationConfig ```cpp struct bytertc::VoiceEqualizationConfig ``` 语音均衡效果。 ## 成员变量 | 类型 | 名称 | | --- | --- | | VoiceEqualizationBandFrequency | [frequency](#VoiceEqualizationConfig-frequency) | | int | [gain](#VoiceEqualizationConfig-gain) | ## 变量说明 ### frequency ```cpp VoiceEqualizationBandFrequency bytertc::VoiceEqualizationConfig::frequency ``` 频带。参看 [VoiceEqualizationBandFrequency](#VoiceEqualizationBandFrequency)。 ### gain ```cpp int bytertc::VoiceEqualizationConfig::gain ``` 频带增益（dB）。取值范围是 `[-15, 15]`。 # SourceWantedData ```cpp struct bytertc::SourceWantedData ``` 性能回退相关数据 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#SourceWantedData-width) | | int | [height](#SourceWantedData-height) | | int | [frame_rate](#SourceWantedData-frame_rate) | ## 变量说明 ### width ```cpp int bytertc::SourceWantedData::width ``` 如果未开启发送性能回退，此值表示推荐的视频输入宽度；如果开启了发送性能回退，此值表示当前推流的最大宽度。 ### height ```cpp int bytertc::SourceWantedData::height ``` 如果未开启发送性能回退，此值表示推荐的视频输入高度；如果开启了发送性能回退，此值表示当前推流的最大高度。 ### frame_rate ```cpp int bytertc::SourceWantedData::frame_rate ``` 如果未开启发送性能回退，此值表示推荐的视频输入帧率，单位 fps；如果开启了发送性能回退，此值表示当前推流的最大帧率，单位 fps。 # VoiceEqualizationBandFrequency ```cpp enum bytertc::VoiceEqualizationBandFrequency ``` 音频均衡效果。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVoiceEqualizationBandFrequency31 | 0 | 中心频率为 31Hz 的频带。 | | kVoiceEqualizationBandFrequency62 | 1 | 中心频率为 62Hz 的频带。 | | kVoiceEqualizationBandFrequency125 | 2 | 中心频率为 125Hz 的频带。 | | kVoiceEqualizationBandFrequency250 | 3 | 中心频率为 250Hz 的频带。 | | kVoiceEqualizationBandFrequency500 | 4 | 中心频率为 500Hz 的频带。 | | kVoiceEqualizationBandFrequency1k | 5 | 中心频率为 1kHz 的频带。 | | kVoiceEqualizationBandFrequency2k | 6 | 中心频率为 2kHz 的频带。 | | kVoiceEqualizationBandFrequency4k | 7 | 中心频率为 4kHz 的频带。 | | kVoiceEqualizationBandFrequency8k | 8 | 中心频率为 8kHz 的频带。 | | kVoiceEqualizationBandFrequency16k | 9 | 中心频率为 16kHz 的频带。 | # MixedStreamLayoutRegionType ```cpp enum bytertc::MixedStreamLayoutRegionType ``` 合流布局区域类型，视频区或水印图片区。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamLayoutRegionTypeVideoStream | 0 | 视频。 | | kMixedStreamLayoutRegionTypeImage | 1 | 水印图片。 | # AudioPlaybackDevice ```cpp enum bytertc::AudioPlaybackDevice ``` 音频播放设备 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioPlaybackDeviceHeadset | 1 | 有线耳机 | | kAudioPlaybackDeviceEarpiece | 2 | 听筒 | | kAudioPlaybackDeviceSpeakerphone | 3 | 扬声器 | | kAudioPlaybackDeviceHeadsetBluetooth | 4 | 蓝牙耳机 | | kAudioPlaybackDeviceHeadsetUSB | 5 | USB 设备 | # PauseResumeControlMediaType ```cpp enum bytertc::PauseResumeControlMediaType ``` 暂停/恢复接收远端的媒体流类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRTCPauseResumeControlMediaTypeAudio | 0 | 只控制音频，不影响视频 | | kRTCPauseResumeControlMediaTypeVideo | 1 | 只控制视频，不影响音频 | | kRTCPauseResumeControlMediaTypeVideoAndAudio | 2 | 同时控制音频和视频 | # BackgroundMode ```cpp enum bytertc::BackgroundMode ``` 背景模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kBackgroundModeNone | 0 | 无 | | kBackgroundModeBlur | 1 | 虚化 | | kBackgroundModeA | 2 | 背景 1 | | kBackgroundModeB | 3 | 背景 2 | # PlayerError ```cpp enum bytertc::PlayerError ``` 播放错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kPlayerErrorOK | 0 | 正常 | | kPlayerErrorFormatNotSupport | 1 | 不支持此类型 | | kPlayerErrorInvalidPath | 2 | 无效的播放路径 | | kPlayerErrorInvalidState | 3 | 未满足前序接口调用的要求。请查看具体接口文档。 | | kPlayerErrorInvalidPosition | 4 | 设置播放位置出错。 | | kPlayerErrorInvalidVolume | 5 | 音量参数不合法。 | | kPlayerErrorInvalidPitch | 6 | 音调参数设置不合法。 | | kPlayerErrorInvalidAudioTrackIndex | 7 | 音轨参数设置不合法。 | | kPlayerErrorInvalidPlaybackSpeed | 8 | 播放速度参数设置不合法 | | kPlayerErrorInvalidEffectId | 9 | 音效 ID 异常。还未加载或播放文件，就调用其他 API。 | | kPlayerErrorCurrentlyPlaying | 10 | 资源正在播放中 | # VoiceReverbType ```cpp enum bytertc::VoiceReverbType ``` 混响特效类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVoiceReverbTypeOriginal | 0 | 原声，不含特效 | | kVoiceReverbTypeEcho | 1 | 回声 | | kVoiceReverbTypeConcert | 2 | 演唱会 | | kVoiceReverbTypeEthereal | 3 | 空灵 | | kVoiceReverbTypeKTV | 4 | KTV | | kVoiceReverbTypeStudio | 5 | 录音棚 | | kVoiceReverbTypeVirtualStereo | 6 | 虚拟立体声 | | kVoiceReverbTypeSpacious | 7 | 空旷 | | kVoiceReverbType3D | 8 | 3D 人声 | # MediaPlayerCustomSource ```cpp struct bytertc::MediaPlayerCustomSource ``` 音频源 ## 成员变量 | 类型 | 名称 | | --- | --- | | MediaPlayerCustomSourceMode | [mode](#MediaPlayerCustomSource-mode) | | MediaPlayerCustomSourceStreamType | [type](#MediaPlayerCustomSource-type) | ## 变量说明 ### mode ```cpp MediaPlayerCustomSourceMode bytertc::MediaPlayerCustomSource::mode = kMediaPlayerCustomSourceModePush ``` 数据源模式，详见 [MediaPlayerCustomSourceMode](#MediaPlayerCustomSourceMode)。 ### type ```cpp MediaPlayerCustomSourceStreamType bytertc::MediaPlayerCustomSource::type = kMediaPlayerCustomSourceStreamTypeRaw ``` 数据源类型，详见 [MediaPlayerCustomSourceStreamType](#MediaPlayerCustomSourceStreamType) # AudioAlignmentMode ```cpp enum bytertc::AudioAlignmentMode ``` 远端音频流精准对齐模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioAlignmentModeOff | 0 | 不对齐 | | kAudioAlignmentModeAudioMixing | 1 | 远端音频流都对齐伴奏进度同步播放 | # BluetoothMode ```cpp enum bytertc::BluetoothMode ``` 蓝牙模式, 仅能在媒体模式下被设置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kBluetoothModeAuto | 0 | 自动选择模式 | | kBluetoothModeA2DP | 1 | 使用 A2DP 模式 | | kBluetoothModeHFP | 2 | HFP 模式 | # ProblemFeedbackOption ```cpp enum bytertc::ProblemFeedbackOption ``` 音视频质量反馈问题类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kProblemFeedbackOptionNone | 0 | 没有问题 | | kProblemFeedbackOptionOtherMessage | 1ULL << 0 | 其他问题 | | kProblemFeedbackOptionDisconnected | 1ULL << 1 | 连接失败 | | kProblemFeedbackOptionEarBackDelay | 1ULL << 2 | 耳返延迟大 | | kProblemFeedbackOptionLocalNoise | 1ULL << 10 | 本端有杂音 | | kProblemFeedbackOptionLocalAudioLagging | 1ULL << 11 | 本端声音卡顿 | | kProblemFeedbackOptionLocalNoAudio | 1ULL << 12 | 本端无声音 | | kProblemFeedbackOptionLocalAudioStrength | 1ULL << 13 | 本端声音大/小 | | kProblemFeedbackOptionLocalEcho | 1ULL << 14 | 本端有回声 | | kProblemFeedbackOptionLocalVideoFuzzy | 1ULL << 24 | 本端视频模糊 | | kProblemFeedbackOptionLocalNotSync | 1ULL << 25 | 本端音视频不同步 | | kProblemFeedbackOptionLocalVideoLagging | 1ULL << 26 | 本端视频卡顿 | | kProblemFeedbackOptionLocalNoVideo | 1ULL << 27 | 本端无画面 | | kProblemFeedbackOptionRemoteNoise | 1ULL << 37 | 远端有杂音 | | kProblemFeedbackOptionRemoteAudioLagging | 1ULL << 38 | 远端声音卡顿 | | kProblemFeedbackOptionRemoteNoAudio | 1ULL << 39 | 远端无声音 | | kProblemFeedbackOptionRemoteAudioStrength | 1ULL << 40 | 远端声音大/小 | | kProblemFeedbackOptionRemoteEcho | 1ULL << 41 | 远端有回声 | | kProblemFeedbackOptionRemoteVideoFuzzy | 1ULL << 51 | 远端视频模糊 | | kProblemFeedbackOptionRemoteNotSync | 1ULL << 52 | 远端音视频不同步 | | kProblemFeedbackOptionRemoteVideoLagging | 1ULL << 53 | 远端视频卡顿 | | kProblemFeedbackOptionRemoteNoVideo | 1ULL << 54 | 远端无画面 | # MessageConfig ```cpp enum bytertc::MessageConfig ``` 消息类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMessageConfigReliableOrdered | 0 | 低延时可靠有序消息 | | kMessageConfigUnreliableOrdered | 1 | 超低延时有序消息 | | kMessageConfigUnreliableUnordered | 2 | 超低延时无序消息 | # ServerACKMsg ```cpp struct bytertc::ServerACKMsg ``` 服务端消息发送结果回调内容 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [length](#ServerACKMsg-length) | | char* | [ack_msg](#ServerACKMsg-ack_msg) | ## 变量说明 ### length ```cpp int bytertc::ServerACKMsg::length ``` 回调消息长度 ### ack_msg ```cpp char* bytertc::ServerACKMsg::ack_msg ``` 回调消息内容 # FirstFramePlayState ```cpp enum bytertc::FirstFramePlayState ``` 首帧播放状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kFirstFramePlayStatePlaying | 0 | 播放中 | | kFirstFramePlayStatePlayed | 1 | 播放成功 | | kFirstFramePlayStateEnd | 2 | 播放失败 | # VideoOrientation ```cpp enum bytertc::VideoOrientation ``` 视频帧朝向 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoOrientationAdaptive | 0 | （默认）使用相机输出的原始视频帧的角度，不对视频帧进行额外旋转。 | | kVideoOrientationPortrait | 1 | 固定为竖屏，将相机采集到的视频帧转换为竖屏，在整个 RTC 链路中传递竖屏帧。 | | kVideoOrientationLandscape | 2 | 固定为横屏，将相机采集到的视频帧转换为横屏，在整个 RTC 链路中传递横屏帧。 | # GameRoomType ```cpp enum bytertc::GameRoomType ``` 房间类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kGameRoomTypeTeam | 0 | 小队房间。 | | kGameRoomTypeWorld | 1 | 世界房间。 | # HardwareEchoDetectionResult ```cpp enum bytertc::HardwareEchoDetectionResult ``` 通话前回声检测结果 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kHardwareEchoDetectionResultCanceled | 0 | 主动调用 `stopHardwareEchoDetection` 结束流程时，未有回声检测结果。 | | kHardwareEchoDetectionResultUnknown | 1 | 未检测出结果。建议重试，如果仍然失败请联系技术支持协助排查。 | | kHardwareEchoDetectionResultNormal | 2 | 无回声 | | kHardwareEchoDetectionResultPoor | 3 | 有回声。可通过 UI 建议用户使用耳机设备入会。 | # PlayerState ```cpp enum bytertc::PlayerState ``` 播放状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kPlayerStateIdle | 0 | 播放未启动 | | kPlayerStatePreloaded | 1 | 已加载 | | kPlayerStateOpened | 2 | 已打开 | | kPlayerStatePlaying | 3 | 正在播放 | | kPlayerStatePaused | 4 | 播放已暂停 | | kPlayerStateStopped | 5 | 播放已被主动停止 | | kPlayerStateFailed | 6 | 播放失败 | | kPlayerStateFinished | 7 | 播放自然结束 | | kPlayerStateLoopFinished | 8 | 循环播放结束 | # PublishState ```cpp enum bytertc::PublishState ``` 发布状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kPublishStatePublished | 0 | 发布成功 | | kPublishStateUnpublished | 1 | 发布失败 | # VideoRotation ```cpp enum bytertc::VideoRotation ``` 视频帧旋转信息 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoRotation0 | 0 | 不旋转 | | kVideoRotation90 | 90 | 顺时针旋转 90 度 | | kVideoRotation180 | 180 | 顺时针旋转 180 度 | | kVideoRotation270 | 270 | 顺时针旋转 270 度 | # SysStats ```cpp struct bytertc::SysStats ``` App 使用的 CPU 和内存信息。该信息由 SDK 周期性（2s）通过 `onSysStats` 回调通知给用户。 ## 成员变量 | 类型 | 名称 | | --- | --- | | unsigned int | [cpu_cores](#SysStats-cpu_cores) | | double | [cpu_app_usage](#SysStats-cpu_app_usage) | | double | [memory_usage](#SysStats-memory_usage) | | unsigned long long | [full_memory](#SysStats-full_memory) | | unsigned long long | [total_memory_usage](#SysStats-total_memory_usage) | | unsigned long long | [free_memory](#SysStats-free_memory) | | double | [memory_ratio](#SysStats-memory_ratio) | | double | [total_memory_ratio](#SysStats-total_memory_ratio) | ## 变量说明 ### cpu_cores ```cpp unsigned int bytertc::SysStats::cpu_cores ``` 当前系统 CPU 核数。 ### cpu_app_usage ```cpp double bytertc::SysStats::cpu_app_usage ``` 当前应用的 CPU 使用率，取值范围为 [0, 1]。 ### memory_usage ```cpp double bytertc::SysStats::memory_usage ``` 当前应用的内存使用量（单位 MB）。 ### full_memory ```cpp unsigned long long bytertc::SysStats::full_memory ``` 全量内存（单位 MB）。 ### total_memory_usage ```cpp unsigned long long bytertc::SysStats::total_memory_usage ``` 系统已使用内存（单位 MB）。 ### free_memory ```cpp unsigned long long bytertc::SysStats::free_memory ``` 空闲可分配内存（单位 MB）。 ### memory_ratio ```cpp double bytertc::SysStats::memory_ratio ``` 当前应用的内存使用率（单位 \%）。 ### total_memory_ratio ```cpp double bytertc::SysStats::total_memory_ratio ``` 系统内存使用率（单位 \%）。 # LocalAudioStreamState ```cpp enum bytertc::LocalAudioStreamState ``` 本地音频流状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLocalAudioStreamStateStopped | 0 | 本地音频默认初始状态。

麦克风停止工作时回调该状态，对应错误码 kLocalAudioStreamErrorOk | | kLocalAudioStreamStateRecording | 1 | 本地音频录制设备启动成功。

采集到音频首帧时回调该状态，对应错误码 kLocalAudioStreamErrorOk | | kLocalAudioStreamStateEncoding | 2 | 本地音频首帧编码成功。

音频首帧编码成功时回调该状态，对应错误码 kLocalAudioStreamErrorOk | | kLocalAudioStreamStateFailed | 3 | 本地音频启动失败，在以下时机回调该状态：

本地录音设备启动失败，对应错误码 kLocalAudioStreamErrorRecordFailure
检测到没有录音设备权限，对应错误码 kLocalAudioStreamErrorDeviceNoPermission
音频编码失败，对应错误码 kLocalAudioStreamErrorEncodeFailure

| | kLocalAudioStreamStateMute | 4 | 本地音频静音成功后回调该状态。

调用 [setAudioCaptureDeviceMute](70095#IAudioDeviceManager-setaudiocapturedevicemute) 成功后回调，对应错误码 [LocalAudioStreamError](#LocalAudioStreamError) 中的 kLocalAudioStreamErrorOk 。 | | kLocalAudioStreamStateUnmute | 5 | 本地音频解除静音成功后回调该状态。

调用 [setAudioCaptureDeviceMute](70095#IAudioDeviceManager-setaudiocapturedevicemute) 成功后回调，对应错误码 [LocalAudioStreamError](#LocalAudioStreamError) 中的 kLocalAudioStreamErrorOk 。 | # ConnectionState ```cpp enum bytertc::ConnectionState ``` SDK 与信令服务器连接状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kConnectionStateDisconnected | 1 | 连接断开超过 12s，此时 SDK 会尝试自动重连。 | | kConnectionStateConnecting | 2 | 首次请求建立连接，正在连接中。 | | kConnectionStateConnected | 3 | 首次连接成功。 | | kConnectionStateReconnecting | 4 | 涵盖了以下情况：

首次连接时，10 秒连接不成功;
连接成功后，断连 10 秒。自动重连中。

| | kConnectionStateReconnected | 5 | 连接断开后，重连成功。 | | kConnectionStateLost | 6 | 处于 `kConnectionStateDisconnected` 状态超过 10 秒，且期间重连未成功。SDK 仍将继续尝试重连。 | | kConnectionStateFailed | 7 | 连接失败，服务端状态异常。SDK 不会自动重连，请重新进房，或联系技术支持。 | # VideoRateInfo ```cpp struct bytertc::VideoRateInfo ``` 自定义编码流信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [fps](#VideoRateInfo-fps) | | int | [bitrate_kbps](#VideoRateInfo-bitrate_kbps) | | int | [min_bitrate_kbps](#VideoRateInfo-min_bitrate_kbps) | ## 变量说明 ### fps ```cpp int bytertc::VideoRateInfo::fps = 0 ``` 帧率，单位 fps ### bitrate_kbps ```cpp int bytertc::VideoRateInfo::bitrate_kbps = 0 ``` 码率，单位 kbps ### min_bitrate_kbps ```cpp int bytertc::VideoRateInfo::min_bitrate_kbps = 0 ``` 视频最小编码码率, 单位 kbps。编码码率不会低于 `min_bitrate_kbps`。默认值为 `0`。范围：[0, bitrate_kbps)，当 `bitrate_kbps` < `min_bitrate_kbps` 时，为适配码率模式。以下情况，设置本参数无效： - 当 `bitrate_kbps` 为 `0` 时，不对视频流进行编码发送。 - 当 `bitrate_kbps` < `0` 时，适配码率模式。 # GameSceneType ```cpp enum bytertc::GameSceneType ``` 游戏场景类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kGameSceneTypeNormal | 0 | 普通场景。

同一个小队房间的队友，仅支持在同一个世界房间内通话。 | | kGameSceneTypeThemePark | 1 | 主题公园场景。

同一个小队房间的队友，支持跨世界房间通话。 | # ContentHint ```cpp enum bytertc::ContentHint ``` 内部采集屏幕视频流的内容类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kContentHintDetails | 0 | 细节内容。当共享文档、图片时，建议使用该内容类型。默认值。 | | kContentHintMotion | 1 | 动画内容。当共享视频、游戏时，建议使用该内容类型。 | # UserVisibilityChangeError ```cpp enum bytertc::UserVisibilityChangeError ``` 用户可见性状态改变错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kUserVisibilityChangeErrorOk | 0 | 成功。 | | kUserVisibilityChangeErrorUnknown | 1 | 未知错误。 | | kUserVisibilityChangeErrorTooManyVisibleUser | 2 | 房间内可见用户达到上限。 | # VideoStreamType ```cpp enum bytertc::VideoStreamType ``` 远端视频类型目前 C++ sdk 只支持 kVideoStreamTypeHigh 类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoStreamTypeHigh | 0 | 高分辨率视频流 | | kVideoStreamTypeLow | 1 | 低分辨率视频 | # AudioEffectPlayerConfig ```cpp struct bytertc::AudioEffectPlayerConfig ``` 混音配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | AudioMixingType | [type](#AudioEffectPlayerConfig-type) | | int | [play_count](#AudioEffectPlayerConfig-play_count) | | int | [pitch](#AudioEffectPlayerConfig-pitch) | | int | [start_pos](#AudioEffectPlayerConfig-start_pos) | ## 变量说明 ### type ```cpp AudioMixingType bytertc::AudioEffectPlayerConfig::type = kAudioMixingTypePlayoutAndPublish ``` 混音播放类型，详见 [AudioMixingType](#AudioMixingType) ### play_count ```cpp int bytertc::AudioEffectPlayerConfig::play_count = 1 ``` 混音播放次数 - play_count <= 0：无限循环 - play_count == 1：播放一次（默认） - play_count \> 1：播放 play_count 次 ### pitch ```cpp int bytertc::AudioEffectPlayerConfig::pitch = 0 ``` 与音乐文件原始音调相比的升高/降低值，取值范围为 `[-12，12]`，默认值为 0。每相邻两个值的音高距离相差半音，正值表示升调，负值表示降调。 ### start_pos ```cpp int bytertc::AudioEffectPlayerConfig::start_pos = 0 ``` 混音起始位置。默认值为 0，单位为毫秒。 # MediaPlayerConfig ```cpp struct bytertc::MediaPlayerConfig ``` 混音配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [play_count](#MediaPlayerConfig-play_count) | | int | [start_pos](#MediaPlayerConfig-start_pos) | | int64_t | [callback_on_progress_interval](#MediaPlayerConfig-callback_on_progress_interval) | | bool | [sync_progress_to_record_frame](#MediaPlayerConfig-sync_progress_to_record_frame) | | bool | [auto_play](#MediaPlayerConfig-auto_play) | | AudioMixingType | [type](#MediaPlayerConfig-type) | ## 变量说明 ### play_count ```cpp int bytertc::MediaPlayerConfig::play_count = 1 ``` 混音播放次数 - play_count <= 0：无限循环 - play_count == 1：播放一次（默认） - play_count \> 1：播放 play_count 次 ### start_pos ```cpp int bytertc::MediaPlayerConfig::start_pos = 0 ``` 混音起始位置。默认值为 0，单位为毫秒。 ### callback_on_progress_interval ```cpp int64_t bytertc::MediaPlayerConfig::callback_on_progress_interval = 0 ``` 设置音频文件混音时，收到 [onMediaPlayerPlayingProgress](70096#IMediaPlayerEventHandler-onmediaplayerplayingprogress) 的间隔。单位毫秒。 - interval \> 0 时，触发回调。实际间隔为 10 的倍数。如果输入数值不能被 10 整除，将自动向上取整。例如传入 `52`，实际间隔为 60 ms。 - interval <= 0 时，不会触发回调。 ### sync_progress_to_record_frame ```cpp bool bytertc::MediaPlayerConfig::sync_progress_to_record_frame = false ``` 在采集音频数据时，附带本地混音文件播放进度的时间戳。启用此功能会提升远端人声和音频文件混音播放时的同步效果。 - 仅在单个音频文件混音时使用有效。 - `true` 时开启此功能，`false` 时关闭此功能，默认为关闭。 ### auto_play ```cpp bool bytertc::MediaPlayerConfig::auto_play = true ``` 是否自动播放。如果不自动播放，调用 [start](70095#IMediaPlayer-start) 播放音乐文件。 ### type ```cpp AudioMixingType bytertc::MediaPlayerConfig::type = kAudioMixingTypePlayoutAndPublish ``` 混音播放类型，详见 [AudioMixingType](#AudioMixingType) # RoomProfileType ```cpp enum bytertc::RoomProfileType ``` 房间模式根据所需场景，选择合适的房间模式，应用不同的音视频算法、视频参数和网络配置调用 `setAudioProfile` 改变音频参数配置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRoomProfileTypeCommunication | 0 | 默认场景，通用模式

与 `kRoomProfileTypeMeeting = 16` 配置相同。

你可以联系技术支持更换默认配置参数。 | | kRoomProfileTypeGame | 2 | 游戏语音模式，低功耗、低流量消耗。

低端机在此模式下运行时，进行了额外的性能优化：

部分低端机型配置编码帧长 40/60
部分低端机型关闭软件 3A 音频处理
增强对 iOS 其他屏幕录制进行的兼容性，避免音频录制被 RTC 打断。

| | kRoomProfileTypeCloudGame | 3 | 云游戏模式。

如果你的游戏场景需要低延迟的配置，使用此设置。

此设置下，弱网抗性较差。 | | kRoomProfileTypeLowLatency | 4 | 云渲染模式。超低延时配置。

如果你的应用并非游戏但又对延时要求较高时，选用此模式

该模式下，音视频通话延时会明显降低，但同时弱网抗性、通话音质等均会受到一定影响。 | | kRoomProfileTypeChatRoom | 6 | 适用于 3 人及以上纯语音通话。

通话中，闭麦时为是媒体模式，上麦后切换为通话模式。 | | kRoomProfileTypeInteractivePodcast | 10 | 适用于单主播和观众进行音视频互动的直播。通话模式，上下麦不会有模式切换，避免音量突变现象 | | kRoomProfileTypeChorus | 12 | 适合在线实时合唱场景，高音质，超低延迟。使用本配置前请联系技术支持进行协助完成其他配置。 | | kRoomProfileTypeGameStreaming | 14 | 适用于 1 vs 1 游戏串流，支持公网或局域网。 | | kRoomProfileTypeMeeting | 16 | 适用于云端会议中的个人设备 | | kRoomProfileTypeMeetingRoom | 17 | 适用于云端会议中的会议室终端设备，例如 Rooms，投屏盒子等。 | | kRoomProfileTypeClassroom | 18 | 适用于课堂互动，房间内所有成员都可以进行音视频互动

当你的场景中需要同时互动的成员超过 10 人时使用此模式 | | kRoomProfileTypeCall | 19 | 注重流畅性，缺省码率相对低。适用于通话。 | | kRoomProfileTypeLive | 20 | 直播模式。更注重画质，视频缺省码率相对高。适用于直播互动。 | # IVideoSink ```cpp class bytertc::IVideoSink ``` 自定义视频渲染器 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual bool | [onFrame](#IVideoSink-onframe) | | virtual int | [getRenderElapse](#IVideoSink-getrenderelapse) | | virtual void | [release](#IVideoSink-release) | ## 函数说明 ### onFrame ```cpp virtual bool onFrame(IVideoFrame* video_frame) = 0; ``` 视频帧回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | video_frame | IVideoFrame* | 视频帧结构类，参看 [IVideoFrame](#IVideoFrame) | **返回值** 返回值暂未使用 ### getRenderElapse ```cpp virtual int getRenderElapse() = 0; ``` 获取外部渲染耗时。 **注意** 获取外部渲染耗时进行上报。开发者需要自己计算平均渲染耗时。 ### release ```cpp virtual void release() { } ``` 释放渲染器。 **注意** 通知开发者渲染器即将被废弃。收到该返回通知后即可释放资源。 # VideoPixelFormat ```cpp enum bytertc::VideoPixelFormat ``` 视频帧像素格式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoPixelFormatUnknown | 0 | 未知格式 | | kVideoPixelFormatI420 | 1 | YUV I420 格式 | | kVideoPixelFormatNV12 | 2 | YUV NV12 格式 | | kVideoPixelFormatNV21 | 3 | YUV NV21 格式 | | kVideoPixelFormatRGB24 | 4 | RGB 24bit 格式， | | kVideoPixelFormatRGBA | 5 | RGBA 编码格式 | | kVideoPixelFormatARGB | 6 | ARGB 编码格式 | | kVideoPixelFormatBGRA | 7 | BGRA 编码格式 | | kVideoPixelFormatTexture2D | 0x0DE1 | Texture2D 格式 | | kVideoPixelFormatTextureOES | 0x8D65 | TextureOES 格式 | # VideoDecoderConfig ```cpp enum bytertc::VideoDecoderConfig ``` 视频解码方式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoDecoderConfigRaw | 0 | 开启 SDK 内部解码，只回调解码后的数据。回调为 [onFrame](#IVideoSink-onframe)。 | | kVideoDecoderConfigEncode | 1 | 开启自定义解码，只回调解码前数据。回调为 [onRemoteEncodedVideoFrame](70096#IRemoteEncodedVideoFrameObserver-onremoteencodedvideoframe)。 | | kVideoDecoderConfigBoth | 2 | 开启 SDK 内部解码，同时回调解码前和解码后的数据。回调为 [onFrame](#IVideoSink-onframe) 和 [onRemoteEncodedVideoFrame](70096#IRemoteEncodedVideoFrameObserver-onremoteencodedvideoframe)。 | # MediaPlayerCustomSourceSeekWhence ```cpp enum bytertc::MediaPlayerCustomSourceSeekWhence ``` 音频数据的起始读取位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaPlayerCustomSourceSeekWhenceSet | 0 | 从音频数据的头开始读取，读取的实际偏移量为参数 offset 的值。 | | kMediaPlayerCustomSourceSeekWhenceCur | 1 | 从音频数据的某一位置开始读取，读取的实际偏移量为音频数据当前的读取位置位置加上参数 offset 的值。 | | kMediaPlayerCustomSourceSeekWhenceEnd | 2 | 从音频数据的尾开始读取，读取的实际数据偏移量为用户传入的音频数据大小加上参数 offset 的值。 | | kMediaPlayerCustomSourceSeekWhenceSize | 3 | 返回音频数据的大小。 | # ForwardStreamEventInfo ```cpp struct bytertc::ForwardStreamEventInfo ``` 跨房间转发媒体流过程中的不同目标房间发生的事件 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [room_id](#ForwardStreamEventInfo-room_id) | | ForwardStreamEvent | [event](#ForwardStreamEventInfo-event) | ## 变量说明 ### room_id ```cpp const char* bytertc::ForwardStreamEventInfo::room_id ``` 跨房间转发媒体流过程中的发生该事件的目标房间 ID 空字符串代表所有目标房间 ### event ```cpp ForwardStreamEvent bytertc::ForwardStreamEventInfo::event ``` 跨房间转发媒体流过程中该目标房间发生的事件，参看 [ForwardStreamEvent](#ForwardStreamEvent) # SubscribeFallbackOption ```cpp enum bytertc::SubscribeFallbackOption ``` 订阅端音视频流回退选项。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSubscribeFallbackOptionDisable | 0 | 下行网络不佳或设备性能不足时，不对音视频流作回退处理。默认设置。 | | kSubscribeFallbackOptionVideoStreamLow | 1 | 下行网络不佳或设备性能不足时，对视频流做降级处理，具体降级规则参看[音视频流回退](70137)。

该设置仅对发布端调用 [setLocalSimulcastMode](70095#IRTCEngine-setlocalsimulcastmode-2) 开启发送多路流功能的情况生效。 | | kSubscribeFallbackOptionAudioOnly | 2 | 下行网络不佳或设备性能不足时，先对视频流做回退处理。当网络状况不满足接收弱流时，则自动取消接收视频，仅接收音频。

该设置仅对发布端调用 [setLocalSimulcastMode](70095#IRTCEngine-setlocalsimulcastmode-2) 开启发送多路流功能的情况生效。 | # LocalAudioStats ```cpp struct bytertc::LocalAudioStats ``` 本地音频流统计信息，统计周期为 2s 。本地用户发布音频流成功后，SDK 会周期性地通过 `onLocalStreamStats` 通知用户发布的音频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [audio_loss_rate](#LocalAudioStats-audio_loss_rate) | | int | [send_kbitrate](#LocalAudioStats-send_kbitrate) | | int | [record_sample_rate](#LocalAudioStats-record_sample_rate) | | int | [stats_interval](#LocalAudioStats-stats_interval) | | int | [rtt](#LocalAudioStats-rtt) | | int | [num_channels](#LocalAudioStats-num_channels) | | int | [sent_sample_rate](#LocalAudioStats-sent_sample_rate) | | int | [jitter](#LocalAudioStats-jitter) | | int | [audio_device_loop_delay](#LocalAudioStats-audio_device_loop_delay) | | double | [encode_frame_rate](#LocalAudioStats-encode_frame_rate) | ## 变量说明 ### audio_loss_rate ```cpp float bytertc::LocalAudioStats::audio_loss_rate ``` 音频丢包率。此次统计周期内的音频上行丢包率，取值范围为 [0, 1]。 ### send_kbitrate ```cpp int bytertc::LocalAudioStats::send_kbitrate ``` 发送码率。此次统计周期内的音频发送码率，单位为 kbps 。 ### record_sample_rate ```cpp int bytertc::LocalAudioStats::record_sample_rate ``` 采集采样率。此次统计周期内的音频采集采样率信息，单位为 Hz 。 ### stats_interval ```cpp int bytertc::LocalAudioStats::stats_interval ``` 统计间隔。此次统计周期的间隔，单位为 ms 。此字段用于设置回调的统计周期，默认设置为 2s 。 ### rtt ```cpp int bytertc::LocalAudioStats::rtt ``` 往返时延。单位为 ms 。 ### num_channels ```cpp int bytertc::LocalAudioStats::num_channels ``` 音频声道数。 ### sent_sample_rate ```cpp int bytertc::LocalAudioStats::sent_sample_rate ``` 音频发送采样率。此次统计周期内的音频发送采样率信息，单位为 Hz 。 ### jitter ```cpp int bytertc::LocalAudioStats::jitter ``` 音频上行网络抖动，单位为 ms 。 ### audio_device_loop_delay ```cpp int bytertc::LocalAudioStats::audio_device_loop_delay ``` 音频设备采集播放时延，单位为 ms 。 ### encode_frame_rate ```cpp double bytertc::LocalAudioStats::encode_frame_rate ``` 音频编码帧率。 # IAudioFrame ```cpp class bytertc::IAudioFrame ``` 音频帧 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual int64_t | [timestampUs](#IAudioFrame-timestampus) | | virtual AudioSampleRate | [sampleRate](#IAudioFrame-samplerate) | | virtual AudioChannel | [channel](#IAudioFrame-channel) | | virtual uint8_t* | [data](#IAudioFrame-data) | | virtual int | [dataSize](#IAudioFrame-datasize) | | virtual AudioFrameType | [frameType](#IAudioFrame-frametype) | | virtual void | [release](#IAudioFrame-release) | | virtual bool | [isMutedData](#IAudioFrame-ismuteddata) | ## 函数说明 ### timestampUs ```cpp virtual int64_t timestampUs() const = 0; ``` 获取音频帧时间戳。 **返回值** 音频帧时间戳，单位：微秒 ### sampleRate ```cpp virtual AudioSampleRate sampleRate() const = 0; ``` 获取音频采样率。参看 [AudioSampleRate](#AudioSampleRate) **返回值** 音频采样率，单位：Hz ### channel ```cpp virtual AudioChannel channel() const = 0; ``` 获取音频通道数。参看 [AudioChannel](#AudioChannel) **返回值** 音频通道数 **注意** 双声道的情况下，左右声道的音频帧数据以 LRLRLR 形式排布。 ### data ```cpp virtual uint8_t* data() const = 0; ``` 获取音频帧内存块地址 **返回值** 音频帧内存块地址 ### dataSize ```cpp virtual int dataSize() const = 0; ``` 获取音频帧数据大小 **返回值** 音频帧数据大小，单位：字节。 ### frameType ```cpp virtual AudioFrameType frameType() const = 0; ``` 获取音频帧类型 **返回值** 音频帧类型，目前只支持 PCM，详见 [AudioFrameType](#AudioFrameType) ### release ```cpp virtual void release() = 0; ``` 释放音频帧 ### isMutedData ```cpp virtual bool isMutedData() const = 0; protected: ``` 获取音频静音标志 **返回值** 是否静音数据 - true：是 - false：否 # RemoteVideoConfig ```cpp struct bytertc::RemoteVideoConfig ``` 远端视频帧信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [framerate](#RemoteVideoConfig-framerate) | | int | [resolution_width](#RemoteVideoConfig-resolution_width) | | int | [resolution_height](#RemoteVideoConfig-resolution_height) | ## 变量说明 ### framerate ```cpp int bytertc::RemoteVideoConfig::framerate = 0 ``` 期望订阅的最高帧率，单位：fps，默认值为 0 即满帧订阅，设为大于 0 的值时开始生效。如果发布端发布帧率 \> 订阅端订阅的帧率，下行媒体服务器 SVC 丢帧，订阅端收到通过此接口设置的帧率；如果发布端发布帧率 < 订阅端订阅的帧率，则订阅端只能收到发布的帧率。仅码流支持 SVC 分级编码特性时方可生效。 ### resolution_width ```cpp int bytertc::RemoteVideoConfig::resolution_width = 0 ``` 视频宽度，单位：px ### resolution_height ```cpp int bytertc::RemoteVideoConfig::resolution_height = 0 ``` 视频高度，单位：px # AudioRecordingConfig ```cpp struct bytertc::AudioRecordingConfig ``` 录音配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [absolute_file_name](#AudioRecordingConfig-absolute_file_name) | | AudioFrameSource | [frame_source](#AudioRecordingConfig-frame_source) | | AudioSampleRate | [sample_rate](#AudioRecordingConfig-sample_rate) | | AudioChannel | [channel](#AudioRecordingConfig-channel) | | AudioQuality | [quality](#AudioRecordingConfig-quality) | ## 变量说明 ### absolute_file_name ```cpp const char* bytertc::AudioRecordingConfig::absolute_file_name ``` 录制文件路径。一个有读写权限的绝对路径，包含文件名和文件后缀。录制文件的格式仅支持 .aac 和 .wav。 ### frame_source ```cpp AudioFrameSource bytertc::AudioRecordingConfig::frame_source ``` 录音内容来源，参看 [AudioFrameSource](#AudioFrameSource)。默认为 kAudioFrameSourceMixed = 2。 ### sample_rate ```cpp AudioSampleRate bytertc::AudioRecordingConfig::sample_rate ``` 录音采样率。参看 [AudioSampleRate](#AudioSampleRate)。 ### channel ```cpp AudioChannel bytertc::AudioRecordingConfig::channel ``` 录音音频声道。参看 [AudioChannel](#AudioChannel)。如果录制时设置的的音频声道数与采集时的音频声道数不同： - 如果采集的声道数为 1，录制的声道数为 2，那么，录制的音频为经过单声道数据拷贝后的双声道数据，而不是立体声。 - 如果采集的声道数为 2，录制的声道数为 1，那么，录制的音频为经过双声道数据混合后的单声道数据。 ### quality ```cpp AudioQuality bytertc::AudioRecordingConfig::quality ``` 录音音质。仅在录制文件格式为 .aac 时可以设置。参看 [AudioQuality](#AudioQuality)。采样率为 32kHz 时，不同音质录制文件（时长为 10min）的大小分别是： - 低音质：1.2MB； - 【默认】中音质：2MB； - 高音质：3.75MB； - 超高音质：7.5MB。 # HWDeviceContextKey ```cpp enum bytertc::HWDeviceContextKey ``` 硬编码设备 context ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kHWDeviceContextKeyCudaContext | 0 | cuda context | | kHWDeviceContextKeyD3D11Device | 1 | derict3D11 设备 | | kHWDeviceContextKeyD3D11DeviceContext | 2 | derict3D11 设备 context | | kHWDeviceContextKeyEglContext | 3 | egl 设备 context | | kHWDeviceContextKeyVADisplay | 4 | vadisplay 设备 context | # CloudProxyInfo ```cpp struct bytertc::CloudProxyInfo ``` 云代理信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [cloud_proxy_ip](#CloudProxyInfo-cloud_proxy_ip) | | int | [cloud_proxy_port](#CloudProxyInfo-cloud_proxy_port) | ## 变量说明 ### cloud_proxy_ip ```cpp const char* bytertc::CloudProxyInfo::cloud_proxy_ip ``` 云代理服务器 IP ### cloud_proxy_port ```cpp int bytertc::CloudProxyInfo::cloud_proxy_port ``` 云代理服务器端口 # LocalProxyConfiguration ```cpp struct bytertc::LocalProxyConfiguration ``` 本地代理配置详细信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | LocalProxyType | [local_proxy_type](#LocalProxyConfiguration-local_proxy_type) | | const char* | [local_proxy_ip](#LocalProxyConfiguration-local_proxy_ip) | | int | [local_proxy_port](#LocalProxyConfiguration-local_proxy_port) | | const char* | [local_proxy_username](#LocalProxyConfiguration-local_proxy_username) | | const char* | [local_proxy_password](#LocalProxyConfiguration-local_proxy_password) | ## 变量说明 ### local_proxy_type ```cpp LocalProxyType bytertc::LocalProxyConfiguration::local_proxy_type ``` 本地代理类型，参看 [LocalProxyType](#LocalProxyType)。 ### local_proxy_ip ```cpp const char* bytertc::LocalProxyConfiguration::local_proxy_ip ``` 本地代理服务器 IP。 ### local_proxy_port ```cpp int bytertc::LocalProxyConfiguration::local_proxy_port ``` 本地代理服务器端口。 ### local_proxy_username ```cpp const char* bytertc::LocalProxyConfiguration::local_proxy_username ``` 本地代理用户名。 ### local_proxy_password ```cpp const char* bytertc::LocalProxyConfiguration::local_proxy_password ``` 本地代理密码。 # RemoteVideoStateChangeReason ```cpp enum bytertc::RemoteVideoStateChangeReason ``` 远端视频流状态改变的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteVideoStateChangeReasonInternal | 0 | 内部原因 | | kRemoteVideoStateChangeReasonNetworkCongestion | 1 | 网络阻塞 | | kRemoteVideoStateChangeReasonNetworkRecovery | 2 | 网络恢复正常 | | kRemoteVideoStateChangeReasonLocalMuted | 3 | 本地用户停止接收远端视频流或本地用户禁用视频模块 | | kRemoteVideoStateChangeReasonLocalUnmuted | 4 | 本地用户恢复接收远端视频流或本地用户启用视频模块 | | kRemoteVideoStateChangeReasonRemoteMuted | 5 | 远端用户停止发送视频流或远端用户禁用视频模块 | | kRemoteVideoStateChangeReasonRemoteUnmuted | 6 | 远端用户恢复发送视频流或远端用户启用视频模块 | | kRemoteVideoStateChangeReasonRemoteOffline | 7 | 远端用户离开房间。 | # ScreenCaptureSourceInfo ```cpp struct bytertc::ScreenCaptureSourceInfo ``` 屏幕共享对象的详细信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | ScreenCaptureSourceType | [type](#ScreenCaptureSourceInfo-type) | | view_t | [source_id](#ScreenCaptureSourceInfo-source_id) | | const char* | [source_name](#ScreenCaptureSourceInfo-source_name) | | const char* | [application](#ScreenCaptureSourceInfo-application) | | int | [pid](#ScreenCaptureSourceInfo-pid) | | bool | [primary_monitor](#ScreenCaptureSourceInfo-primary_monitor) | | Rectangle | [region_rect](#ScreenCaptureSourceInfo-region_rect) | ## 变量说明 ### type ```cpp ScreenCaptureSourceType bytertc::ScreenCaptureSourceInfo::type = kScreenCaptureSourceTypeUnknown ``` 屏幕共享对象的类型，参看 [ScreenCaptureSourceType](#ScreenCaptureSourceType) ### source_id ```cpp view_t bytertc::ScreenCaptureSourceInfo::source_id = nullptr ``` 屏幕共享对象的 ID ### source_name ```cpp const char* bytertc::ScreenCaptureSourceInfo::source_name = nullptr ``` 屏幕共享对象的名称调用 [release](70095#IScreenCaptureSourceList-release) 时将被释放，请及时转为 string 对象保存 ### application ```cpp const char* bytertc::ScreenCaptureSourceInfo::application = nullptr ``` 共享的应用窗体所属应用的名称当共享对象为应用窗体时有效调用 [release](70095#IScreenCaptureSourceList-release) 时将被释放，请及时转为 string 对象保存 ### pid ```cpp int bytertc::ScreenCaptureSourceInfo::pid = 0 ``` 共享的应用窗体所属应用进程的 pid 当共享对象为应用窗体时有效 ### primary_monitor ```cpp bool bytertc::ScreenCaptureSourceInfo::primary_monitor = false ``` 共享的屏幕是否为主屏。当共享对象为屏幕时有效 ### region_rect ```cpp Rectangle bytertc::ScreenCaptureSourceInfo::region_rect ``` 屏幕共享对象的坐标。详见 [Rectangle](#Rectangle)。仅在采集源为显示器屏幕时有效。 - 对于多屏幕的场景，不同平台的坐标系原点不同： - 对于 Windows 平台，屏幕坐标以主屏左上角为原点 (0, 0)，向右向下扩展。 — 对于 Linux 平台，屏幕坐标以 **恰好包住所有显示器的矩形区域的左上角** 为原点 (0, 0)，向右向下扩展。 - 对于不同平台，窗口区域不同： - 对于 Windows 和 macOS 平台，窗口区域包含系统标题栏。 - 对于 Linux 平台，窗口区域不包含系统标题栏。 # RecordingState ```cpp enum bytertc::RecordingState ``` 本地录制的状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRecordingStateError | 0 | 录制异常 | | kRecordingStateProcessing | 1 | 录制进行中 | | kRecordingStateSuccess | 2 | 录制文件保存成功。正常调用 stopFileRecording 后触发。此外，若录制中途编码分辨率发生变更，SDK 会自动结束当前文件保存并触发此状态码，随后开启新一轮录制，直到调用停止录制。 | # AudioSampleRate ```cpp enum bytertc::AudioSampleRate ``` 音频采样率，单位为 Hz。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioSampleRateAuto | -1 | 默认设置。48000Hz。 | | kAudioSampleRate8000 | 8000 | 8000Hz | | kAudioSampleRate11025 | 11025 | 11025Hz | | kAudioSampleRate16000 | 16000 | 16000Hz | | kAudioSampleRate22050 | 22050 | 22050Hz | | kAudioSampleRate24000 | 24000 | 24000Hz | | kAudioSampleRate32000 | 32000 | 32000Hz | | kAudioSampleRate44100 | 44100 | 44100Hz | | kAudioSampleRate48000 | 48000 | 48000Hz | # SourceCrop ```cpp struct bytertc::SourceCrop ``` WTN 流视频裁剪配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [location_x](#SourceCrop-location_x) | | float | [location_y](#SourceCrop-location_y) | | float | [width_proportion](#SourceCrop-width_proportion) | | float | [height_proportion](#SourceCrop-height_proportion) | ## 变量说明 ### location_x ```cpp float bytertc::SourceCrop::location_x = 0.0 ``` 裁剪后得到的视频帧左上角横坐标相对于裁剪前整体画面的归一化比例，取值范围[0.0, 1.0)。默认值为 0.0 ### location_y ```cpp float bytertc::SourceCrop::location_y = 0.0 ``` 裁剪后得到的视频帧左上角纵坐标相对于裁剪前整体画面的归一化比例，取值范围[0.0, 1.0) 默认值为 0.0 ### width_proportion ```cpp float bytertc::SourceCrop::width_proportion = 1.0 ``` 裁剪后得到的视频帧宽度相对于裁剪前整体画面的归一化比例，取值范围(0.0, 1.0] 默认值为 1.0 ### height_proportion ```cpp float bytertc::SourceCrop::height_proportion = 1.0 ``` 裁剪后得到的视频帧高度相对于裁剪前整体画面的归一化比例，取值范围(0.0, 1.0] 默认值为 1.0 # EchoTestConfig ```cpp struct bytertc::EchoTestConfig ``` 音视频回路测试参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | void* | [view](#EchoTestConfig-view) | | bool | [enable_audio](#EchoTestConfig-enable_audio) | | bool | [enable_video](#EchoTestConfig-enable_video) | | int | [audio_properties_report_interval](#EchoTestConfig-audio_properties_report_interval) | | const char* | [uid](#EchoTestConfig-uid) | | const char* | [room_id](#EchoTestConfig-room_id) | | const char* | [token](#EchoTestConfig-token) | ## 变量说明 ### view ```cpp void* bytertc::EchoTestConfig::view ``` 用于渲染接收到的视频的视图 ### enable_audio ```cpp bool bytertc::EchoTestConfig::enable_audio ``` 是否检测音频。检测设备为系统默认音频设备。 - true：是 - 若使用 SDK 内部采集，此时设备麦克风会自动开启，并在 audioPropertiesReportInterval 值大于 0 时触发 `onLocalAudioPropertiesReport` 回调，你可以根据该回调判断麦克风的工作状态 - 若使用自定义采集，此时你需调用 [pushExternalAudioFrame](70095#IRTCEngine-pushexternalaudioframe) 将采集到的音频推送给 SDK - false：否 ### enable_video ```cpp bool bytertc::EchoTestConfig::enable_video ``` 是否检测视频。PC 端默认检测列表中第一个视频设备。 - true：是 - 若使用 SDK 内部采集，此时设备摄像头会自动开启 - 若使用自定义采集，此时你需调用 [pushExternalVideoFrame](70095#IRTCEngine-pushexternalvideoframe) 将采集到的视频推送给 SDK - false：否 **注意** 视频的发布参数固定为：分辨率 640px × 360px，帧率 15fps。 ### audio_properties_report_interval ```cpp int bytertc::EchoTestConfig::audio_properties_report_interval ``` 音量信息提示间隔，单位：ms，默认为 100ms - `<= 0`：关闭信息提示 - `(0,100]`：开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms - `> 100`：开启信息提示，并将信息提示间隔设置为此值 ### uid ```cpp const char* bytertc::EchoTestConfig::uid ``` 进行音视频通话回路测试的用户 ID ### room_id ```cpp const char* bytertc::EchoTestConfig::room_id ``` 测试用户加入的房间 ID。 ### token ```cpp const char* bytertc::EchoTestConfig::token ``` 对用户进房时进行鉴权验证的动态密钥，用于保证音视频通话回路测试的安全性。 # NetworkDetectionLinkType ```cpp enum bytertc::NetworkDetectionLinkType ``` 通话前探测链接的类型。 `onNetworkDetectionResult` 回调的参数类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kNetworkDetectionLinkTypeUp | 0 | 上行网络探测 | | kNetworkDetectionLinkTypeDown | 1 | 下行网络探测 | # MediaStreamType ```cpp enum bytertc::MediaStreamType ``` 媒体流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaStreamTypeAudio | 1 << 0 | 只控制音频 | | kMediaStreamTypeVideo | 1 << 1 | 只控制视频 | | kMediaStreamTypeBoth | kMediaStreamTypeAudio \| kMediaStreamTypeVideo | 同时控制音频和视频 | # LocalProxyError ```cpp enum bytertc::LocalProxyError ``` 本地代理错误。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLocalProxyErrorOK | 0 | 本地代理服务器无错误。 | | kLocalProxyErrorSocks5VersionError | 1 | 代理服务器回复的版本号不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。 | | kLocalProxyErrorSocks5FormatError | 2 | 代理服务器回复的格式错误不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。 | | kLocalProxyErrorSocks5InvalidValue | 3 | 代理服务器回复的字段值不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。 | | kLocalProxyErrorSocks5UserPassNotGiven | 4 | 未提供代理服务器的用户名及密码，导致 Socks5 代理连接失败。请重新调用 `setLocalProxy`，在设置本地代理时填入用户名和密码。 | | kLocalProxyErrorSocks5TcpClosed | 5 | TCP 关闭，导致 Socks5 代理连接失败。请检查网络或者代理服务器是否存在异常。 | | kLocalProxyErrorHttpTunnelFailed | 6 | Http 隧道代理错误。请检查 Http 隧道代理服务器或者网络是否存在异常。 | # AudioFrameType ```cpp enum bytertc::AudioFrameType ``` 音频帧类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioFrameTypePCM16 | 0 | PCM 16bit | # ForwardStreamEvent ```cpp enum bytertc::ForwardStreamEvent ``` 媒体流跨房间转发事件 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kForwardStreamEventDisconnected | 0 | 本端与服务器网络连接断开，暂停转发。 | | kForwardStreamEventConnected | 1 | 本端与服务器网络连接恢复，转发服务连接成功。 | | kForwardStreamEventInterrupt | 2 | 转发中断。转发过程中，如果相同 user_id 的用户进入目标房间，转发中断。 | | kForwardStreamEventDstRoomUpdated | 3 | 目标房间已更新，由 `updateForwardStreamToRooms` 触发。 | | kForwardStreamEventUnExpectAPICall | 4 | API 调用时序错误。例如，在调用 `startForwardStreamToRooms` 之前调用 `updateForwardStreamToRooms` 。 | # AudioAbilityType ```cpp enum bytertc::AudioAbilityType ``` 音频音量是否可设置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioAbilityTypeUnknown | -1 | 未知 | | kAudioAbilityTypeAble | 0 | 音量可设置 | | kAudioAbilityTypeUnable | 1 | 音量不可设置 | # MixedStreamAudioConfig ```cpp struct bytertc::MixedStreamAudioConfig ``` 音频合流参数。值不合法或未设置时，自动使用默认值。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int32_t | [sample_rate](#MixedStreamAudioConfig-sample_rate) | | int32_t | [channels](#MixedStreamAudioConfig-channels) | | int32_t | [bitrate](#MixedStreamAudioConfig-bitrate) | | MixedStreamAudioProfile | [audio_profile](#MixedStreamAudioConfig-audio_profile) | | MixedStreamAudioCodecType | [audio_codec](#MixedStreamAudioConfig-audio_codec) | ## 变量说明 ### sample_rate ```cpp int32_t bytertc::MixedStreamAudioConfig::sample_rate = 48000 ``` 音频采样率，单位 Hz。可取 32000 Hz、44100 Hz、48000 Hz，默认值为 48000 Hz。建议设置。 ### channels ```cpp int32_t bytertc::MixedStreamAudioConfig::channels = 2 ``` 音频声道数。可取 1（单声道）、2（双声道），默认值为 2。建议设置。 ### bitrate ```cpp int32_t bytertc::MixedStreamAudioConfig::bitrate = 64 ``` 音频码率，单位 Kbps。可取范围 [32, 192]，默认值为 64 Kbps。建议设置。 ### audio_profile ```cpp MixedStreamAudioProfile bytertc::MixedStreamAudioConfig::audio_profile = MixedStreamAudioProfile::kMixedStreamAudioProfileLC ``` AAC 编码规格，参看 [MixedStreamAudioProfile](#MixedStreamAudioProfile)。默认值为 `0` 代表 AAC-LC。 ### audio_codec ```cpp MixedStreamAudioCodecType bytertc::MixedStreamAudioConfig::audio_codec = MixedStreamAudioCodecType::kMixedStreamAudioCodecTypeAAC ``` 音频编码格式，参看 [MixedStreamAudioCodecType](#MixedStreamAudioCodecType)。当前只有一个值为 `0`，代表 AAC。 WTN 流任务不支持设置本参数。 # SetRoomExtraInfoResult ```cpp enum bytertc::SetRoomExtraInfoResult ``` 设置房间附加消息结果。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSetRoomExtraInfoResultSuccess | 0 | 设置房间附加信息成功 | | kSetRoomExtraInfoResultErrorNotJoinRoom | -1 | 设置失败，尚未加入房间 | | kSetRoomExtraInfoResultErrorKeyIsNull | -2 | 设置失败，key 指针为空 | | kSetRoomExtraInfoResultErrorValueIsNull | -3 | 设置失败，value 指针为空 | | kSetRoomExtraInfoResultResultUnknow | -99 | 设置失败，未知错误 | | kSetRoomExtraInfoResultErrorKeyIsEmpty | -400 | 设置失败，key 长度为 0 | | kSetRoomExtraInfoResultErrorTooOften | -406 | 调用 `setRoomExtraInfo` 过于频繁，建议不超过 10 次/秒。 | | kSetRoomExtraInfoResultErrorSilentUser | -412 | 设置失败，用户已调用 `setUserVisibility` 将自身设为隐身状态。 | | kSetRoomExtraInfoResultErrorKeyTooLong | -413 | 设置失败，Key 长度超过 10 字节 | | kSetRoomExtraInfoResultErrorValueTooLong | -414 | 设置失败，value 长度超过 128 字节 | | kSetRoomExtraInfoResultErrorServer | -500 | 设置失败，服务器错误 | # VideoCanvas ```cpp struct bytertc::VideoCanvas ``` 视频帧渲染设置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | void* | [view](#VideoCanvas-view) | | int | [render_mode](#VideoCanvas-render_mode) | | uint32_t | [background_color](#VideoCanvas-background_color) | | RenderTargetType | [render_target_type](#VideoCanvas-render_target_type) | | VideoRotation | [render_rotation](#VideoCanvas-render_rotation) | ## 变量说明 ### view ```cpp void* bytertc::VideoCanvas::view = NULL ``` 本地视图句柄 ### render_mode ```cpp int bytertc::VideoCanvas::render_mode = kRenderModeHidden ``` 视频渲染模式，参看 [RenderMode](#RenderMode) ### background_color ```cpp uint32_t bytertc::VideoCanvas::background_color = 0 ``` 用于填充画布空白部分的背景颜色。取值范围是 `[0x00000000, 0xFFFFFFFF]`。默认值是 `0x00000000`。其中，透明度设置无效。 ### render_target_type ```cpp RenderTargetType bytertc::VideoCanvas::render_target_type = kRenderTargetTypeView ``` 渲染目标的类型。参看 [RenderTargetType](#RenderTargetType)。 ### render_rotation ```cpp VideoRotation bytertc::VideoCanvas::render_rotation = kVideoRotation0 ``` 视频帧旋转角度。参看 [VideoRotation](#VideoRotation)。默认为 0 度，即不做旋转处理。该设置仅对远端视频有效，对本地视频设置不生效。 # LogConfig ```cpp struct bytertc::LogConfig ``` 本地日志参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [log_path](#LogConfig-log_path) | | LocalLogLevel | [log_level](#LogConfig-log_level) | | uint32_t | [log_file_size](#LogConfig-log_file_size) | | const char* | [log_filename_prefix](#LogConfig-log_filename_prefix) | ## 变量说明 ### log_path ```cpp const char* bytertc::LogConfig::log_path = nullptr ``` 日志存储路径，必填。 ### log_level ```cpp LocalLogLevel bytertc::LogConfig::log_level = LocalLogLevel::kWarning ``` 日志等级，参看 [LocalLogLevel](#LocalLogLevel)，默认为警告级别，选填。 ### log_file_size ```cpp uint32_t bytertc::LogConfig::log_file_size = 10 ``` 日志文件最大占用的总空间，单位为 MB，选填。取值范围为 1～100 MB，默认值为 10 MB。若 `log_file_size` < 1，取 1 MB。若 `log_file_size` \> 100，取 100 MB。其中，单个日志文件最大为 2 MB： \\\

若 1 ≤ log_file_size ≤ 2，则会生成一个日志文件。\

\

若 log_file_size \> 2，假设 log_file_size/2 的整数部分为 N，则前 N 个文件，每个文件会写满 2 MB，第 N+1 个文件大小不超过 log_file_size mod 2，否则会删除最老的文件，以此类推。\

### log_filename_prefix ```cpp const char* bytertc::LogConfig::log_filename_prefix = nullptr ``` 日志文件名前缀，选填。该字符串必须符合正则表达式：[a-zA-Z0-9_\@\\-\\.]{1,128}。最终的日志文件名为`前缀 + "_" + 文件创建时间 + "_rtclog".log`，如 `logPrefix_2023-05-25_172324_rtclog.log`。 # RemoteMirrorType ```cpp enum bytertc::RemoteMirrorType ``` 远端流的镜像类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteMirrorTypeNone | 0 | （默认值）远端视频渲染无镜像效果。 | | kRemoteMirrorTypeRender | 1 | 远端视频渲染有镜像效果。 | # SEIStreamEventType ```cpp enum bytertc::SEIStreamEventType ``` 黑帧视频流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSEIStreamEventTypeStreamAdd | 0 | 远端用户发布黑帧视频流。

纯语音通话场景下，远端用户调用 [sendSEIMessage](70095#IRTCEngine-sendseimessage) 发送 SEI 数据时，SDK 会自动发布一路黑帧视频流，并触发该回调。 | | kSEIStreamEventTypeStreamRemove | 1 | 远端黑帧视频流移除。该回调的触发时机包括：

远端用户开启摄像头采集，由语音通话切换至视频通话，黑帧视频流停止发布；
远端用户调用 [sendSEIMessage](70095#IRTCEngine-sendseimessage) 后 1min 内未有 SEI 数据发送，黑帧视频流停止发布；
远端用户调用 [setVideoSourceType](70095#IRTCEngine-setvideosourcetype) 切换至自定义视频采集时，黑帧视频流停止发布。

| # VideoApplyRotation ```cpp enum bytertc::VideoApplyRotation ``` 是否将视频帧自动转正。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoApplyRotationDefault | -1 | （默认值）不旋转。 | | kVideoApplyRotation0 | 0 | 自动转正视频，即根据视频帧的旋转角信息将视频帧旋转到 0 度。 | # VideoPreprocessorConfig ```cpp struct bytertc::VideoPreprocessorConfig ``` 视频前处理配置参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | VideoPixelFormat | [required_pixel_format](#VideoPreprocessorConfig-required_pixel_format) | ## 变量说明 ### required_pixel_format ```cpp VideoPixelFormat bytertc::VideoPreprocessorConfig::required_pixel_format = kVideoPixelFormatUnknown ``` 视频帧像素格式，参看 [VideoPixelFormat](#VideoPixelFormat) 当前仅支持 `kVideoPixelFormatI420` 和 `kVideoPixelFormatUnknown` 格式。 # SubtitleConfig ```cpp struct bytertc::SubtitleConfig ``` 字幕配置信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | SubtitleMode | [mode](#SubtitleConfig-mode) | | const char* | [target_language](#SubtitleConfig-target_language) | ## 变量说明 ### mode ```cpp SubtitleMode bytertc::SubtitleConfig::mode = kSubtitleModeRecognition ``` 字幕模式。可以根据需要选择识别和翻译两种模式。开启识别模式，会将识别后的用户语音转化成文字；开启翻译模式，会在语音识别后进行翻译。参看 [SubtitleMode](#SubtitleMode)。 ### target_language ```cpp const char* bytertc::SubtitleConfig::target_language = "" ``` 目标翻译语言。可点击 [语言支持](https://www.volcengine.com/docs/4640/35107) 查看翻译服务最新支持的语种信息。 # PlayerEvent ```cpp enum bytertc::PlayerEvent ``` 播放事件 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kPlayerEventSelectAudioTrackBegin | 0 | 开始切换音轨

开始调用 [`selectAudioTrack`](70095#IMediaPlayer-selectaudiotrack) 时，返回此状态。 | | kPlayerEventSelectAudioTrackCompleted | 1 | 切换音轨成功

调用 [`selectAudioTrack`](70095#IMediaPlayer-selectaudiotrack) 成功后，播放器切换到指定音轨播放，返回此状态。 | | kPlayerEventSelectAudioTrackFailed | 2 | 切换音轨失败

调用 [`selectAudioTrack`](70095#IMediaPlayer-selectaudiotrack) 失败后，播放器无法切换到指定音轨，继续之前的音轨播放过程，返回此状态。 | | kPlayerEventSeekBegin | 3 | 试图移动播放位置

开始调用 [`setPosition`](70095#IMediaPlayer-setposition) 时，返回此状态。 | | kPlayerEventSeekCompleted | 4 | 移动播放位置成功

调用 [`setPosition`](70095#IMediaPlayer-setposition) 成功后，返回此状态。 | | kPlayerEventSeekFailed | 5 | 移动播放位置失败

调用 [`setPosition`](70095#IMediaPlayer-setposition) 失败时，返回此状态。 | # RTCVideoDeviceType ```cpp enum bytertc::RTCVideoDeviceType ``` 当前视频设备类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRTCVideoDeviceTypeUnknown | -1 | 未知设备类型 | | kRTCVideoDeviceTypeRenderDevice | 0 | 视频渲染设备类型 | | kRTCVideoDeviceTypeCaptureDevice | 1 | 视频采集设备类型 | | kRTCVideoDeviceTypeScreenCaptureDevice | 2 | 屏幕流视频设备 | # NetworkQualityStats ```cpp struct bytertc::NetworkQualityStats ``` 上行/下行网络质量 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [uid](#NetworkQualityStats-uid) | | double | [fraction_lost](#NetworkQualityStats-fraction_lost) | | int | [rtt](#NetworkQualityStats-rtt) | | int | [total_bandwidth](#NetworkQualityStats-total_bandwidth) | | NetworkQuality | [tx_quality](#NetworkQualityStats-tx_quality) | | NetworkQuality | [rx_quality](#NetworkQualityStats-rx_quality) | ## 变量说明 ### uid ```cpp const char* bytertc::NetworkQualityStats::uid ``` 用户 ID ### fraction_lost ```cpp double bytertc::NetworkQualityStats::fraction_lost ``` 本端的上行/下行的丢包率，范围 [0.0,1.0] 当 `uid` 为本地用户时，代表发布流的上行丢包率。当 `uid` 为远端用户时，代表接收所有订阅流的下行丢包率。 ### rtt ```cpp int bytertc::NetworkQualityStats::rtt ``` 当 `uid` 为本地用户时有效，客户端到服务端的往返延时（RTT），单位：ms ### total_bandwidth ```cpp int bytertc::NetworkQualityStats::total_bandwidth ``` 本端的音视频 RTP 包 2 秒内的平均传输速率，单位：bps 当 `uid` 为本地用户时，代表发送速率。当 `uid` 为远端用户时，代表所有订阅流的接收速率。 ### tx_quality ```cpp NetworkQuality bytertc::NetworkQualityStats::tx_quality ``` 上行网络质量评分，详见 [NetworkQuality](#NetworkQuality)。 ### rx_quality ```cpp NetworkQuality bytertc::NetworkQualityStats::rx_quality ``` 下行网络质量评分，详见 [NetworkQuality](#NetworkQuality)。 # RemoteVideoRenderConfig ```cpp struct bytertc::RemoteVideoRenderConfig ``` 远端视频帧渲染设置 ## 成员变量 | 类型 | 名称 | | --- | --- | | RenderMode | [render_mode](#RemoteVideoRenderConfig-render_mode) | | uint32_t | [background_color](#RemoteVideoRenderConfig-background_color) | | VideoRotation | [render_rotation](#RemoteVideoRenderConfig-render_rotation) | ## 变量说明 ### render_mode ```cpp RenderMode bytertc::RemoteVideoRenderConfig::render_mode = kRenderModeHidden ``` 渲染模式： - 1（`RENDER_MODE_HIDDEN`）视窗填满优先，默认值。视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长。 - 2（`RENDER_MODE_FIT`）视频帧内容全部显示优先。视频帧等比缩放，直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同，视窗上未被视频帧填满区域将填充 `backgroundColor`。缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长。 - 3（`RENDER_MODE_FILL`）视频帧自适应画布。视频帧非等比缩放，直至画布被填满。在此过程中，视频帧的长宽比例可能会发生变化。 ### background_color ```cpp uint32_t bytertc::RemoteVideoRenderConfig::background_color = 0 ``` 用于填充画布空白部分的背景颜色。取值范围是 `[0x00000000, 0xFFFFFFFF]`。默认值是 `0x00000000`。其中，透明度设置无效。 ### render_rotation ```cpp VideoRotation bytertc::RemoteVideoRenderConfig::render_rotation = kVideoRotation0 ``` 用户自定义画面旋转。可选值 0, 90, 180, 270，默认值是 0。其中 0 代表保持原始画面，90, 180, 270 代表顺时针旋转原始 canvas 相应角度。 # MixedStreamLayoutRegionConfig ```cpp struct bytertc::MixedStreamLayoutRegionConfig ``` 单个图片或视频流在合流中的布局信息。开启合流功能后，在多路图片或视频流合流时，你可以设置其中一路流在合流中的预设布局信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [user_id](#MixedStreamLayoutRegionConfig-user_id) | | const char* | [room_id](#MixedStreamLayoutRegionConfig-room_id) | | int | [location_x](#MixedStreamLayoutRegionConfig-location_x) | | int | [location_y](#MixedStreamLayoutRegionConfig-location_y) | | int | [width](#MixedStreamLayoutRegionConfig-width) | | int | [height](#MixedStreamLayoutRegionConfig-height) | | float | [alpha](#MixedStreamLayoutRegionConfig-alpha) | | float | [corner_radius](#MixedStreamLayoutRegionConfig-corner_radius) | | int32_t | [z_order](#MixedStreamLayoutRegionConfig-z_order) | | bool | [is_local_user](#MixedStreamLayoutRegionConfig-is_local_user) | | MixedStreamVideoType | [stream_type](#MixedStreamLayoutRegionConfig-stream_type) | | MixedStreamMediaType | [media_type](#MixedStreamLayoutRegionConfig-media_type) | | MixedStreamRenderMode | [render_mode](#MixedStreamLayoutRegionConfig-render_mode) | | MixedStreamLayoutRegionType | [region_content_type](#MixedStreamLayoutRegionConfig-region_content_type) | | uint8_t* | [image_water_mark](#MixedStreamLayoutRegionConfig-image_water_mark) | | MixedStreamLayoutRegionImageWaterMarkConfig | [image_water_mark_param](#MixedStreamLayoutRegionConfig-image_water_mark_param) | | MixedStreamAlternateImageFillMode | [alternate_image_fill_mode](#MixedStreamLayoutRegionConfig-alternate_image_fill_mode) | | const char* | [alternate_image_url](#MixedStreamLayoutRegionConfig-alternate_image_url) | | Position | [spatial_position](#MixedStreamLayoutRegionConfig-spatial_position) | | bool | [apply_spatial_audio](#MixedStreamLayoutRegionConfig-apply_spatial_audio) | | SourceCrop | [source_crop](#MixedStreamLayoutRegionConfig-source_crop) | ## 变量说明 ### user_id ```cpp const char* bytertc::MixedStreamLayoutRegionConfig::user_id = nullptr ``` 合流用户的 ID。建议设置。 ### room_id ```cpp const char* bytertc::MixedStreamLayoutRegionConfig::room_id = nullptr ``` 图片或视频流所在房间的房间 ID。建议设置。如果此图片或视频流是通过 [startForwardStreamToRooms](70095#IRTCRoom-startforwardstreamtorooms) 转发到用户所在房间的媒体流时，你应将房间 ID 设置为用户所在的房间 ID。 ### location_x ```cpp int bytertc::MixedStreamLayoutRegionConfig::location_x = 0 ``` 单个用户画面左上角在整个画布坐标系中的 X 坐标（pixel），即以画布左上角为原点，用户画面左上角相对于原点的横向位移。取值范围为 [0, 整体画布宽度)。默认值为 0。 ### location_y ```cpp int bytertc::MixedStreamLayoutRegionConfig::location_y = 0 ``` 单个用户画面左上角在整个画布坐标系中的 Y 坐标（pixel），即以画布左上角为原点，用户画面左上角相对于原点的纵向位移。取值范围为 [0, 整体画布高度)。默认值为 0。 ### width ```cpp int bytertc::MixedStreamLayoutRegionConfig::width = MIXED_STREAM_VIDEO_DEFAULT_WIDTH ``` 单个用户画面的宽度。取值范围为 [0, 整体画布宽度]，默认值为 360。 ### height ```cpp int bytertc::MixedStreamLayoutRegionConfig::height = MIXED_STREAM_DEFAULT_VIDEO_HEIGHT ``` 单个用户画面的高度。取值范围为 [0, 整体画布高度]，默认值为 640。 ### alpha ```cpp float bytertc::MixedStreamLayoutRegionConfig::alpha = 1.0f ``` 透明度，可选范围为 (0.0, 1.0]，0.0 为全透明。默认值为 1.0。 ### corner_radius ```cpp float bytertc::MixedStreamLayoutRegionConfig::corner_radius = 0 ``` 圆角半径相对画布宽度的比例。默认值为 `0.0`。做范围判定时，首先根据画布的宽高，将 `width`，`height`，和 `corner_radius` 分别转换为像素值：`width_px`，`height_px`，和 `corner_radius_px`。然后判定是否满足 `corner_radius_px < min(width_px/2, height_px/2)`：若满足，则设置成功；若不满足，则将 `corner_radius_px` 设定为 `min(width_px/2, height_px/2)`，然后将 `corner_radius` 设定为 `corner_radius_px` 相对画布宽度的比例值。 WTN 流任务不支持设置本参数。 ### z_order ```cpp int32_t bytertc::MixedStreamLayoutRegionConfig::z_order = 0 ``` 用户视频布局在画布中的层级。取值范围为 [0 - 100]，0 为底层，值越大越上层。默认值为 0。 ### is_local_user ```cpp bool bytertc::MixedStreamLayoutRegionConfig::is_local_user = false ``` 是否为本地用户： - true：是 - false:（默认值）否 WTN 流任务不支持设置本参数。 ### stream_type ```cpp MixedStreamVideoType bytertc::MixedStreamLayoutRegionConfig::stream_type = MixedStreamVideoType::kMixedStreamVideoTypeMain ``` 预留字段。 ### media_type ```cpp MixedStreamMediaType bytertc::MixedStreamLayoutRegionConfig::media_type = MixedStreamMediaType::kMixedStreamMediaTypeAudioAndVideo ``` 合流内容控制。默认值为 `kMediaTypeAudioAndVideo`，参看 [MixedStreamMediaType](#MixedStreamMediaType)。 ### render_mode ```cpp MixedStreamRenderMode bytertc::MixedStreamLayoutRegionConfig::render_mode = MixedStreamRenderMode::kMixedStreamRenderModeHidden ``` 图片或视频流的缩放模式，参看 [MixedStreamRenderMode](#MixedStreamRenderMode)。默认值为 `1`，视窗填满优先。建议设置。 ### region_content_type ```cpp MixedStreamLayoutRegionType bytertc::MixedStreamLayoutRegionConfig::region_content_type = MixedStreamLayoutRegionType::kMixedStreamLayoutRegionTypeVideoStream ``` 合流布局区域类型，视频区或水印图片区。参看 [MixedStreamLayoutRegionType](#MixedStreamLayoutRegionType)。默认值为 `0`，视频。 WTN 流任务不支持设置本参数。 ### image_water_mark ```cpp uint8_t* bytertc::MixedStreamLayoutRegionConfig::image_water_mark = nullptr ``` 水印图 RGBA 数据。当 `region_content_type` 为图片类型时需要设置。 - `kMixedStreamLayoutRegionTypeImage = 1` 时，传入图片 RGBA 数据。 - `kMixedStreamLayoutRegionTypeVideoStream = 0` 时传入空。 WTN 流任务不支持设置本参数。 ### image_water_mark_param ```cpp MixedStreamLayoutRegionImageWaterMarkConfig bytertc::MixedStreamLayoutRegionConfig::image_water_mark_param ``` 水印图参数。当 `region_content_type` 为图片类型时需要设置。 - `kMixedStreamLayoutRegionTypeImage = 1` 时，传入图片参数，参看 [MixedStreamLayoutRegionImageWaterMarkConfig](#MixedStreamLayoutRegionImageWaterMarkConfig)。 - `kMixedStreamLayoutRegionTypeVideoStream = 0` 时传入空。 WTN 流任务不支持设置本参数。 ### alternate_image_fill_mode ```cpp MixedStreamAlternateImageFillMode bytertc::MixedStreamLayoutRegionConfig::alternate_image_fill_mode = kMixedStreamAlternateImageFillModeFit ``` > Available since 3.57 设置占位图的填充模式。该参数用来控制当用户停止发布视频流，画面恢复为占位图后，此时占位图的填充模式。默认值为 `kMixedStreamAlternateImageFillModeFit`，占位图跟随用户原始视频帧相同的比例缩放。参看 [MixedStreamAlternateImageFillMode](#MixedStreamAlternateImageFillMode)。 WTN 流任务不支持设置本参数。 ### alternate_image_url ```cpp const char* bytertc::MixedStreamLayoutRegionConfig::alternate_image_url = nullptr ``` > Available since 3.57 设置占位图的 URL，长度小于 1024 字符. ### spatial_position ```cpp Position bytertc::MixedStreamLayoutRegionConfig::spatial_position ``` 空间位置。参看 [Position](#Position)。 WTN 流任务不支持设置本参数。 ### apply_spatial_audio ```cpp bool bytertc::MixedStreamLayoutRegionConfig::apply_spatial_audio = true ``` 是否开启空间音频效果。默认值为 true。 WTN 流任务不支持设置本参数。 ### source_crop ```cpp SourceCrop bytertc::MixedStreamLayoutRegionConfig::source_crop ``` 支持对每一路参与WTN 流的视频进行裁剪，参看 [SourceCrop](#SourceCrop) 合流转推任务不支持。 # FrameUpdateInfo ```cpp struct bytertc::FrameUpdateInfo ``` RTC 智能决策后得到的帧率和分辨率积（宽*高）。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [pixel](#FrameUpdateInfo-pixel) | | int | [framerate](#FrameUpdateInfo-framerate) | ## 变量说明 ### pixel ```cpp int bytertc::FrameUpdateInfo::pixel ``` 分辨率积（宽*高）。 ### framerate ```cpp int bytertc::FrameUpdateInfo::framerate ``` 帧率。 # StreamSubscribeState ```cpp enum bytertc::StreamSubscribeState ``` 订阅媒体流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kStreamSubscribeStateSuccess | 0 | 订阅/取消订阅流成功 | | kStreamSubscribeStateFailedNotInRoom | 1 | 订阅/取消订阅流失败，本地用户未在房间中 | | kStreamSubscribeStateFailedStreamNotFound | 2 | 订阅/取消订阅流失败，房间内未找到指定的音视频流 | | kStreamSubscribeStateFailedOverLimit | 3 | 超过订阅流数上限 | # RenderMode ```cpp enum bytertc::RenderMode ``` 渲染模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRenderModeHidden | 1 | 视窗填满优先，默认值。

视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。

缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长。 | | kRenderModeFit | 2 | 视频帧内容全部显示优先。

视频帧等比缩放，直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同，视窗上未被视频帧填满区域将被涂黑。

缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长。 | | kRenderModeFill | 3 | - | # AudioRecordingState ```cpp enum bytertc::AudioRecordingState ``` 录音配置 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioRecordingStateError | 0 | 录制异常 | | kAudioRecordingStateProcessing | 1 | 录制进行中 | | kAudioRecordingStateSuccess | 2 | 已结束录制，并且录制文件保存成功。 | # UserOnlineStatus ```cpp enum bytertc::UserOnlineStatus ``` 用户在线状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kUserOnlineStatusOffline | 0 | 对端用户离线

对端用户已调用 `logout`，或者没有调用 `login` 进行登录。 | | kUserOnlineStatusOnline | 1 | 对端用户在线

对端用户调用 `login` 登录，并且连接状态正常。 | | kUserOnlineStatusUnreachable | 2 | 无法获取对端用户在线状态

发生级联错误、对端用户在线状态异常时返回。 | # MixedStreamMediaType ```cpp enum bytertc::MixedStreamMediaType ``` 合流输出媒体类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamMediaTypeAudioAndVideo | 0 | 包含音频和视频 | | kMixedStreamMediaTypeAudioOnly | 1 | 只包含音频 | # NetworkTimeInfo ```cpp struct bytertc::NetworkTimeInfo ``` 网络时间信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int64_t | [timestamp](#NetworkTimeInfo-timestamp) | ## 变量说明 ### timestamp ```cpp int64_t bytertc::NetworkTimeInfo::timestamp ``` 网络时间，单位：ms # MediaDeviceType ```cpp enum bytertc::MediaDeviceType ``` 媒体设备类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaDeviceTypeAudioUnknown | -1 | 未知设备 | | kMediaDeviceTypeAudioRenderDevice | 0 | 音频渲染设备 | | kMediaDeviceTypeAudioCaptureDevice | 1 | 音频采集设备 | | kMediaDeviceTypeVideoCaptureDevice | 3 | 视频采集设备 | | kMediaDeviceTypeScreenVideoCaptureDevice | 4 | 屏幕流视频设备 | | kMediaDeviceTypeScreenAudioCaptureDevice | 5 | 屏幕流音频设备 | # StreamIndex ```cpp enum bytertc::StreamIndex ``` 预留字段。 # PublishStateChangeReason ```cpp enum bytertc::PublishStateChangeReason ``` 发布状态变化原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kPublishStateChangeReasonPublish | 0 | 用户调用发布 | | kPublishStateChangeReasonUnpublish | 1 | 用户取消发布 | | kPublishStateChangeReasonNoPublishPermission | 2 | 发布 token 没有权限 | | kPublishStateChangeReasonOverStreamPublishLimit | 3 | 发布流总数超过上限 | | kPublishStateChangeReasonMultiRoomUnpublishFailed | 4 | 将一路流发布到多个房间时，其中一个房间取消发布失败。 | | kPublishStateChangeReasonPublishStreamFailed | 5 | 服务器错误导致发布失败 | | kPublishStateChangeReasonPublishStreamForbidden | 6 | 观众尝试发布操作 | | kPublishStateChangeReasonUserInPublish | 7 | 用户已经在其他房间发布过流，或者用户正在发布。 | | kPublishStateChangeReasonStreamPublishByOther | 8 | 其他用户发布了相同 streamid 的流，导致本端发布的流被踢掉。 | | kPublishStateChangeReasonStreamIdInvalid | 9 | 流 ID 校验失败。 | # RemoteVideoSinkConfig ```cpp struct bytertc::RemoteVideoSinkConfig ``` 远端视频帧回调配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | RemoteVideoSinkPosition | [position](#RemoteVideoSinkConfig-position) | | VideoPixelFormat | [pixel_format](#RemoteVideoSinkConfig-pixel_format) | | VideoApplyRotation | [apply_rotation](#RemoteVideoSinkConfig-apply_rotation) | | VideoSinkMirrorType | [mirror_type](#RemoteVideoSinkConfig-mirror_type) | ## 变量说明 ### position ```cpp RemoteVideoSinkPosition bytertc::RemoteVideoSinkConfig::position = kRemoteVideoSinkPositionAfterPostProcess ``` 远端视频帧回调位置，参看 [RemoteVideoSinkPosition](#RemoteVideoSinkPosition)，默认回调后处理后的视频帧。 ### pixel_format ```cpp VideoPixelFormat bytertc::RemoteVideoSinkConfig::pixel_format = kVideoPixelFormatUnknown ``` 远端视频帧回调格式，参看 [VideoPixelFormat](#VideoPixelFormat)，默认值为 0。 ### apply_rotation ```cpp VideoApplyRotation bytertc::RemoteVideoSinkConfig::apply_rotation = kVideoApplyRotationDefault ``` 是否将视频帧自动转正，参看 [VideoApplyRotation](#VideoApplyRotation)，默认为不旋转。 ### mirror_type ```cpp VideoSinkMirrorType bytertc::RemoteVideoSinkConfig::mirror_type = kVideoSinkMirrorTypeOFF ``` 是否将视频帧镜像。参看 [VideoSinkMirrorType](#VideoSinkMirrorType)，默认为不镜像。本设置与 [setRemoteVideoMirrorType](70095#IRTCEngine-setremotevideomirrortype) （适用于内部渲染）相互独立。 # MediaDeviceWarning ```cpp enum bytertc::MediaDeviceWarning ``` 媒体设备警告 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaDeviceWarningOK | 0 | 无警告 | | kMediaDeviceWarningOperationDenied | 1 | 非法设备操作。在使用外部设备时，调用了 SDK 内部设备 API。 | | kMediaDeviceWarningCaptureSilence | 2 | 采集静音。 | | kMediaDeviceWarningDetectLeakEcho | 11 | 通话中出现回声现象。

当 [RoomProfileType](#RoomProfileType) 为 `kRoomProfileTypeMeeting` 和

`kRoomProfileTypeMeetingRoom`，且 AEC 关闭时，SDK 自动启动回声检测，如果检测到回声问题，将通过

`onAudioDeviceWarning` 返回本枚举值。 | | kMediaDeviceWarningCaptureDetectHowling | 16 | 啸叫。

触发该回调的情况如下：

不支持啸叫抑制的房间模式下，检测到啸叫；
支持啸叫抑制的房间模式下，检测到未被抑制的啸叫。仅 kRoomProfileTypeCommunication、kRoomProfileTypeMeeting、kRoomProfileTypeMeetingRoom 三种房间模式支持啸叫抑制。建议提醒用户检查客户端的距离或将麦克风和扬声器调至静音。

| | kMediaDeviceWarningPlayoutUseSilentDevice | 28 | 使用无声的播放设备 | | kMediaDeviceWarningRecordingAllProcess | 29 | 不支持排除本进程采集,当前采集全部进程音频 | | kMediaDeviceWarningRecordingAllProcessFailed | 30 | 全部进程采集开启失败 | # MixedStreamPushMode ```cpp enum bytertc::MixedStreamPushMode ``` 服务端合流转推发起模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamPushModeOnStream | 0 | 无用户发布媒体流时，发起合流任务无效。默认设置。

当有用户发布媒体流时，才能发起合流任务。 | | kMixedStreamPushModeOnStartRequest | 1 | 无用户发布媒体流时，可以使用占位图发起合流任务。

占位图设置参看 [alternate_image_url](#MixedStreamLayoutRegionConfig-alternate_image_url) 和 [alternate_image_fill_mode](#MixedStreamLayoutRegionConfig-alternate_image_fill_mode) | # VideoCodecType ```cpp enum bytertc::VideoCodecType ``` 视频的编码类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoCodecTypeUnknown | 0 | 未知类型 | | kVideoCodecTypeH264 | 1 | 标准 H264 编码格式 | | kVideoCodecTypeByteVC1 | 2 | ByteVC1 编码格式 | # RTCWatermarkConfig ```cpp struct bytertc::RTCWatermarkConfig ``` 水印参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | bool | [visible_in_preview](#RTCWatermarkConfig-visible_in_preview) | | ByteWatermark | [position_in_landscape_mode](#RTCWatermarkConfig-position_in_landscape_mode) | | ByteWatermark | [position_in_portrait_mode](#RTCWatermarkConfig-position_in_portrait_mode) | ## 变量说明 ### visible_in_preview ```cpp bool bytertc::RTCWatermarkConfig::visible_in_preview = true ``` 水印是否在视频预览中可见，默认可见。 ### position_in_landscape_mode ```cpp ByteWatermark bytertc::RTCWatermarkConfig::position_in_landscape_mode ``` 横屏时的水印位置和大小，参看 [ByteWatermark](#ByteWatermark)。 ### position_in_portrait_mode ```cpp ByteWatermark bytertc::RTCWatermarkConfig::position_in_portrait_mode ``` 视频编码的方向模式为竖屏时的水印位置和大小，参看 [ByteWatermark](#ByteWatermark)。 # EffectBeautyMode ```cpp enum bytertc::EffectBeautyMode ``` 基础美颜模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kEffectBeautyModeWhite | 0 | 美白。 | | kEffectBeautyModeSmooth | 1 | 磨皮。 | | kEffectBeautyModeSharpen | 2 | 锐化。 | | kEffectBeautyModeClear | 3 | 清晰，需集成 v4.4.2+ 版本的特效 SDK。 | # PixelFormat ```cpp enum bytertc::IVideoSink::PixelFormat ``` 视频帧编码格式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kI420 | VideoPixelFormat::kVideoPixelFormatI420 | YUV I420 格式 | | kRGBA | VideoPixelFormat::kVideoPixelFormatRGBA | RGBA 格式, 字节序为 R8 G8 B8 A8 | | kOriginal | VideoPixelFormat::kVideoPixelFormatUnknown | 原始视频帧格式 | # HumanOrientation ```cpp struct bytertc::HumanOrientation ``` 三维朝向信息，三个向量需要两两垂直。参看 [Orientation](#Orientation)。 ## 成员变量 | 类型 | 名称 | | --- | --- | | Orientation | [forward](#HumanOrientation-forward) | | Orientation | [right](#HumanOrientation-right) | | Orientation | [up](#HumanOrientation-up) | ## 变量说明 ### forward ```cpp Orientation bytertc::HumanOrientation::forward = { 1, 0, 0 } ``` 正前方朝向，默认值为 {1,0,0}，即正前方朝向 x 轴正方向 ### right ```cpp Orientation bytertc::HumanOrientation::right = { 0, 1, 0 } ``` 正右方朝向，默认值为 {0,1,0}，即右手朝向 y 轴正方向 ### up ```cpp Orientation bytertc::HumanOrientation::up = { 0, 0, 1 } ``` 正上方朝向，默认值为 {0,0,1}，即头顶朝向 z 轴正方向 # VideoEnhancementMode ```cpp enum bytertc::VideoEnhancementMode ``` 弱光适应类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoEnhancementModeDisabled | 0 | 关闭弱光适应 | | kVideoEnhancementModeAuto | 1 | 开启弱光适应 | # AnsMode ```cpp enum bytertc::AnsMode ``` 降噪模式。降噪算法受调用 [joinRoom](70095#IRTCRoom-joinroom) 时设置的房间模式影响。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAnsModeDisable | 0 | 禁用音频降噪。 | | kAnsModeLow | 1 | 适用于微弱降噪。 | | kAnsModeMedium | 2 | 适用于抑制中度平稳噪音，如空调声、风扇声。 | | kAnsModeHigh | 3 | 适用于抑制嘈杂非平稳噪音，如键盘声、敲击声、碰撞声、动物叫声。 | | kAnsModeAutomatic | 4 | 启用音频降噪能力。具体的降噪算法由 RTC 决定。 | # MixedStreamAlternateImageFillMode ```cpp enum bytertc::MixedStreamAlternateImageFillMode ``` 服务端合流占位图填充模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamAlternateImageFillModeFit | 0 | 占位图跟随用户原始视频帧相同的比例缩放。默认设置。 | | kMixedStreamAlternateImageFillModeFill | 1 | 占位图不跟随用户原始视频帧相同的比例缩放，保持图片原有比例。 | # LocalVideoSinkPosition ```cpp enum bytertc::LocalVideoSinkPosition ``` 本地视频帧回调位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLocalVideoSinkPositionAfterCapture | 0 | 采集后。 | | kLocalVideoSinkPositionAfterPreProcess | 1 | （默认值）前处理后。 | # AudioRenderType ```cpp enum bytertc::AudioRenderType ``` 音频输出类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioRenderTypeExternal | 0 | 自定义渲染 | | kAudioRenderTypeInternal | 1 | RTC SDK 内部渲染 | # AudioVolumeInfo ```cpp struct bytertc::AudioVolumeInfo ``` 音频流来源的用户 ID 及对应的音量。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [linear_volume](#AudioVolumeInfo-linear_volume) | | int | [nonlinear_volume](#AudioVolumeInfo-nonlinear_volume) | | const char* | [uid](#AudioVolumeInfo-uid) | ## 变量说明 ### linear_volume ```cpp int bytertc::AudioVolumeInfo::linear_volume ``` 线性音量，取值范围是：[0, 255]，与原始音量呈线性关系，数值越大，音量越大。无声为 25 以下（绝对无声为 0，25 以下可视为无声），低音量为 25～76，中音量为 76～204，高音量为 204 以上。 ### nonlinear_volume ```cpp int bytertc::AudioVolumeInfo::nonlinear_volume ``` 非线性音量，取值范围是：[–127, 0]，单位 dB。此音量范围是将原始音量进行对数转化，在中低音量时分辨更为灵敏，适用于 Active Speaker（房间内最活跃用户）的识别。高音量为 0～–20 dB，中音量为 –20～–40dB，低音量为 –40～–60dB，若低于 –60 dB，则为无声。 ### uid ```cpp const char* bytertc::AudioVolumeInfo::uid ``` 音频流来源的用户 ID # LocalVideoSinkConfig ```cpp struct bytertc::LocalVideoSinkConfig ``` 本地视频帧回调配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | LocalVideoSinkPosition | [position](#LocalVideoSinkConfig-position) | | VideoPixelFormat | [pixel_format](#LocalVideoSinkConfig-pixel_format) | ## 变量说明 ### position ```cpp LocalVideoSinkPosition bytertc::LocalVideoSinkConfig::position = kLocalVideoSinkPositionAfterPreProcess ``` 本地视频帧回调位置，参看 [LocalVideoSinkPosition](#LocalVideoSinkPosition)，默认回调前处理后的视频帧。 ### pixel_format ```cpp VideoPixelFormat bytertc::LocalVideoSinkConfig::pixel_format = kVideoPixelFormatUnknown ``` 本地视频帧回调格式，参看 [VideoPixelFormat](#VideoPixelFormat)，默认值为 0。 # CloudProxyConfiguration ```cpp struct bytertc::CloudProxyConfiguration ``` 云代理相关信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | CloudProxyInfo* | [cloud_proxies](#CloudProxyConfiguration-cloud_proxies) | | int | [cloud_proxy_count](#CloudProxyConfiguration-cloud_proxy_count) | ## 变量说明 ### cloud_proxies ```cpp CloudProxyInfo* bytertc::CloudProxyConfiguration::cloud_proxies = nullptr ``` 云代理信息。 ### cloud_proxy_count ```cpp int bytertc::CloudProxyConfiguration::cloud_proxy_count = 0 ``` 云代理数量。 # Position ```cpp struct bytertc::Position ``` 本地用户在房间内的位置坐标，需自行建立空间直角坐标系 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [x](#Position-x) | | float | [y](#Position-y) | | float | [z](#Position-z) | ## 变量说明 ### x ```cpp float bytertc::Position::x ``` x 坐标 ### y ```cpp float bytertc::Position::y ``` y 坐标 ### z ```cpp float bytertc::Position::z ``` z 坐标 # VideoEncodePreference ```cpp enum bytertc::VideoEncodePreference ``` 编码策略偏好。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoEncodePreferenceDisabled | 0 | 无偏好。不降低帧率和分辨率。 | | kVideoEncodePreferenceFramerate | 1 | 优先保障帧率。适用于动态画面。 | | kVideoEncodePreferenceQuality | 2 | 清晰模式，优先保障分辨率。适用于静态画面。 | | kVideoEncodePreferenceAuto | 3 | 平衡帧率与分辨率。
对于屏幕流来说是开启自动模式智能模式，将根据屏幕内容智能决策选择流畅模式或清晰模式。 | # LocalProxyType ```cpp enum bytertc::LocalProxyType ``` 本地代理的类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLocalProxyTypeSocks5 | 1 | Socks5 代理。选用此代理服务器，需满足 Socks5 协议标准文档的要求。 | | kLocalProxyTypeHttpTunnel | 2 | Http 隧道代理。 | # AudioMixingType ```cpp enum bytertc::AudioMixingType ``` 混音播放类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioMixingTypePlayout | 0 | 仅本地播放 | | kAudioMixingTypePublish | 1 | 仅远端播放 | | kAudioMixingTypePlayoutAndPublish | 2 | 本地和远端同时播放 | # AudioFrameBuilder ```cpp struct bytertc::AudioFrameBuilder ``` 音频帧构建类 ## 成员变量 | 类型 | 名称 | | --- | --- | | AudioSampleRate | [sample_rate](#AudioFrameBuilder-sample_rate) | | AudioChannel | [channel](#AudioFrameBuilder-channel) | | int64_t | [timestamp_us](#AudioFrameBuilder-timestamp_us) | | uint8_t* | [data](#AudioFrameBuilder-data) | | int64_t | [data_size](#AudioFrameBuilder-data_size) | | bool | [deep_copy](#AudioFrameBuilder-deep_copy) | ## 变量说明 ### sample_rate ```cpp AudioSampleRate bytertc::AudioFrameBuilder::sample_rate ``` 音频采样率 ### channel ```cpp AudioChannel bytertc::AudioFrameBuilder::channel ``` 音频通道数 ### timestamp_us ```cpp int64_t bytertc::AudioFrameBuilder::timestamp_us = 0 ``` 音频帧时间戳，单位：微秒 **注意** 此时间戳不是 Linux 时间戳，只是 SDK 内部时间戳，仅保证帧之间时间戳的相对关系。 ### data ```cpp uint8_t* bytertc::AudioFrameBuilder::data ``` 音频帧数据 ### data_size ```cpp int64_t bytertc::AudioFrameBuilder::data_size = 0 ``` 音频帧数据大小 ### deep_copy ```cpp bool bytertc::AudioFrameBuilder::deep_copy = true ``` 是否深拷贝 # ForwardStreamConfiguration ```cpp struct bytertc::ForwardStreamConfiguration ``` 媒体流跨房间转发的目标房间的相关信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | ForwardStreamInfo* | [forward_stream_dests](#ForwardStreamConfiguration-forward_stream_dests) | | int | [dest_count](#ForwardStreamConfiguration-dest_count) | ## 变量说明 ### forward_stream_dests ```cpp ForwardStreamInfo* bytertc::ForwardStreamConfiguration::forward_stream_dests = nullptr ``` 目标房间信息，数组中的每个元素包含一个房间的信息。 ### dest_count ```cpp int bytertc::ForwardStreamConfiguration::dest_count = 0 ``` 目标房间数量。媒体流同时转发的目标房间数量建议小于等于 4 个。 # SubtitleMode ```cpp enum bytertc::SubtitleMode ``` 字幕模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSubtitleModeRecognition | 0 | 识别模式。在此模式下，房间内用户语音会被转为文字。 | | kSubtitleModeTranslation | 1 | 翻译模式。在此模式下，房间内用户语音会先被转为文字，再被翻译为目标语言。 | # RoomStateChangeReason ```cpp enum bytertc::RoomStateChangeReason ``` 房间状态变化原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRoomStateChangeReasonJoinRoom | 0 | 首次进房成功。 | | kRoomStateChangeReasonReconnect | 1 | 重新进房，比如断网重连。 | | kRoomStateChangeReasonLeaveRoom | 2 | 离开房间。 | | kRoomStateChangeReasonJoinRoomFailed | -2001 | 进房失败。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。

当你调用初次加入房间或者由于网络状况不佳断网重连时，由于服务器错误导致进房失败。SDK 会自动重试进房。 | | kRoomStateChangeReasonInvalidToken | -1000 | Token 无效。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。

调用 [joinRoom](70095#IRTCRoom-joinroom) 进房时使用的 Token 参数有误或过期失效。需要重新获取 Token，并调用 [updateToken](70095#IRTSRoom-updatetoken) 方法更新 Token。 | | kRoomStateChangeReasonTokenExpired | -1009 | Token 过期。加入房间后 Token 过期时，返回此错误码。需使用新的 Token 重新加入房间。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。 | | kRoomStateChangeReasonUpdateTokenWithInvalidToken | -1010 | 调用 `updateToken` 传入的 Token 无效。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。 | | kRoomStateChangeReasonRoomForbidden | -1025 | 房间被封禁。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。 | | kRoomStateChangeReasonUserForbidden | -1026 | 用户被封禁。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。 | | kRoomStateChangeReasonKickedOut | -1006 | 服务端调用 OpenAPI 将当前用户踢出房间。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。 | | kRoomStateChangeReasonRoomDismiss | -1011 | 服务端调用 OpenAPI 解散房间，所有用户被移出房间。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。 | | kRoomStateChangeReasonDuplicateLogin | -1004 | 相同用户 ID 的用户加入本房间，当前用户被踢出房间。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。 | | kRoomStateChangeReasonStateAbnormalServerStatus | -1084 | 服务端异常状态导致退出房间。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。

SDK 与信令服务器断开，并不再自动重连，可联系技术支持。 | | kRoomStateChangeReasonUnknown | -1001 | 加入房间错误。通过 [onRoomStateChanged](70096#IRTSRoomEventHandler-onroomstatechanged) 回调。

进房时发生未知错误导致加入房间失败。需要用户重新加入房间。 | # DivideMode ```cpp enum bytertc::DivideMode ``` 分割模型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kDivideModeNone | 0 | 自研 | | kDivideModeEffect | 1 | effect | # MediaStreamInfo ```cpp struct bytertc::MediaStreamInfo ``` 流属性。 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [user_id](#MediaStreamInfo-user_id) | | bool | [is_screen](#MediaStreamInfo-is_screen) | | bool | [has_video](#MediaStreamInfo-has_video) | | bool | [has_audio](#MediaStreamInfo-has_audio) | | VideoSolutionDescription* | [profiles](#MediaStreamInfo-profiles) | | int | [profile_count](#MediaStreamInfo-profile_count) | | VideoSolutionDescription | [max_profile](#MediaStreamInfo-max_profile) | ## 变量说明 ### user_id ```cpp const char* bytertc::MediaStreamInfo::user_id ``` 发布此流的用户 ID 。 ### is_screen ```cpp bool bytertc::MediaStreamInfo::is_screen ``` 预留字段。 ### has_video ```cpp bool bytertc::MediaStreamInfo::has_video ``` 此流是否包括视频流。 ### has_audio ```cpp bool bytertc::MediaStreamInfo::has_audio ``` 流是否包括音频流。 ### profiles ```cpp VideoSolutionDescription* bytertc::MediaStreamInfo::profiles ``` 视频流的属性。当远端用户调用 [setVideoEncoderConfig](70095#IRTCEngine-setvideoencoderconfig) 方法发布多个配置的视频流时，此处会包含该用户发布的所有视频流的属性信息。 ### profile_count ```cpp int bytertc::MediaStreamInfo::profile_count ``` 不同配置流的个数。当远端用户调用 [setVideoEncoderConfig](70095#IRTCEngine-setvideoencoderconfig) 方法发布多个配置的视频流时，此处会包含该用户发布的视频流的数目。 ### max_profile ```cpp VideoSolutionDescription bytertc::MediaStreamInfo::max_profile ``` 最大视频流的属性。当远端用户开启带通道划分的大小流时，回调最大视频流属性信息。用户可以使用新的订阅方式，订阅任意不超过该分辨率的流。最终接收到的流，会受房间内其他用户的订阅行为的影响，综合确定一个最接近用户请求的分辨率的流。 # SimulcastStreamType ```cpp enum bytertc::SimulcastStreamType ``` 订阅大小流偏好 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSimulcastStreamTypeWeak | 0 | 弱流，最小分辨率的流。 | | kSimulcastStreamTypeLow | 1 | 小流 | | kSimulcastStreamTypeMid | 2 | 中流 | | kSimulcastStreamTypeHigh | 3 | 大流 | # StreamRemoveReason ```cpp enum bytertc::StreamRemoveReason ``` 房间内远端流被移除的原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kStreamRemoveReasonUnpublish | 0 | 远端用户停止发布流。 | | kStreamRemoveReasonPublishFailed | 1 | 远端用户发布流失败。 | | kStreamRemoveReasonKeepLiveFailed | 2 | 媒体服务器 10s 没收到客户端的媒体数据。 | | kStreamRemoveReasonClientDisconnected | 3 | 远端用户断网。 | | kStreamRemoveReasonRepublish | 4 | 远端用户重新发布流。 | | kStreamRemoveReasonOther | 5 | 其他原因。 | | kStreamRemoveReasonPrivilegeTokenExpired | 6 | 远端用户 Token 发布权限过期。 | | kStreamRemoveReasonStreamKickedByOther | 7 | 远端用户流被踢。 | # RemoteAudioStats ```cpp struct bytertc::RemoteAudioStats ``` 远端音频流统计信息，统计周期为 2s。本地用户订阅远端音频流成功后，SDK 会周期性地通过 `onRemoteStreamStats` 通知本地用户订阅的音频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [audio_loss_rate](#RemoteAudioStats-audio_loss_rate) | | int | [received_kbitrate](#RemoteAudioStats-received_kbitrate) | | int | [stall_count](#RemoteAudioStats-stall_count) | | int | [stall_duration](#RemoteAudioStats-stall_duration) | | long | [e2e_delay](#RemoteAudioStats-e2e_delay) | | int | [playout_sample_rate](#RemoteAudioStats-playout_sample_rate) | | int | [stats_interval](#RemoteAudioStats-stats_interval) | | int | [rtt](#RemoteAudioStats-rtt) | | int | [total_rtt](#RemoteAudioStats-total_rtt) | | int | [quality](#RemoteAudioStats-quality) | | int | [jitter_buffer_delay](#RemoteAudioStats-jitter_buffer_delay) | | int | [num_channels](#RemoteAudioStats-num_channels) | | int | [received_sample_rate](#RemoteAudioStats-received_sample_rate) | | int | [frozen_rate](#RemoteAudioStats-frozen_rate) | | int | [concealed_samples](#RemoteAudioStats-concealed_samples) | | int | [concealment_event](#RemoteAudioStats-concealment_event) | | int | [dec_sample_rate](#RemoteAudioStats-dec_sample_rate) | | int | [dec_duration](#RemoteAudioStats-dec_duration) | | int | [jitter](#RemoteAudioStats-jitter) | | double | [decode_frame_rate](#RemoteAudioStats-decode_frame_rate) | ## 变量说明 ### audio_loss_rate ```cpp float bytertc::RemoteAudioStats::audio_loss_rate ``` 音频丢包率。统计周期内的音频下行丢包率，取值范围为 [0, 1] 。 ### received_kbitrate ```cpp int bytertc::RemoteAudioStats::received_kbitrate ``` 接收码率。统计周期内的音频接收码率，单位为 kbps 。 ### stall_count ```cpp int bytertc::RemoteAudioStats::stall_count ``` 音频卡顿次数。统计周期内的卡顿次数。 ### stall_duration ```cpp int bytertc::RemoteAudioStats::stall_duration ``` 音频卡顿时长。统计周期内的卡顿时长，单位为 ms 。 ### e2e_delay ```cpp long bytertc::RemoteAudioStats::e2e_delay ``` 用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为 ms 。 ### playout_sample_rate ```cpp int bytertc::RemoteAudioStats::playout_sample_rate ``` 播放采样率。统计周期内的音频播放采样率信息，单位为 Hz 。 ### stats_interval ```cpp int bytertc::RemoteAudioStats::stats_interval ``` 统计间隔。此次统计周期的间隔，单位为 ms 。 ### rtt ```cpp int bytertc::RemoteAudioStats::rtt ``` 客户端到服务端数据传输的往返时延，单位为 ms。 ### total_rtt ```cpp int bytertc::RemoteAudioStats::total_rtt ``` 发送端——服务端——接收端全链路数据传输往返时延。单位为 ms 。 ### quality ```cpp int bytertc::RemoteAudioStats::quality ``` 远端用户发送的音频流质量。远端用户发送的音频流质量。值含义参考 [NetworkQuality](#NetworkQuality)。 ### jitter_buffer_delay ```cpp int bytertc::RemoteAudioStats::jitter_buffer_delay ``` 因引入 jitter buffer 机制导致的延时。单位为 ms 。 ### num_channels ```cpp int bytertc::RemoteAudioStats::num_channels ``` 音频声道数。 ### received_sample_rate ```cpp int bytertc::RemoteAudioStats::received_sample_rate ``` 音频接收采样率。统计周期内接收到的远端音频采样率信息，单位为 Hz 。 ### frozen_rate ```cpp int bytertc::RemoteAudioStats::frozen_rate ``` 远端用户在加入房间后发生音频卡顿的累计时长占音频总有效时长的百分比。音频有效时长是指远端用户进房发布音频流后，除停止发送音频流和禁用音频模块之外的音频时长。 ### concealed_samples ```cpp int bytertc::RemoteAudioStats::concealed_samples ``` 音频丢包补偿(PLC) 样点总个数。 ### concealment_event ```cpp int bytertc::RemoteAudioStats::concealment_event ``` 音频丢包补偿(PLC) 累计次数。 ### dec_sample_rate ```cpp int bytertc::RemoteAudioStats::dec_sample_rate ``` 音频解码采样率。统计周期内的音频解码采样率信息，单位为 Hz 。 ### dec_duration ```cpp int bytertc::RemoteAudioStats::dec_duration ``` 此次订阅中，对远端音频流进行解码的累计耗时。单位为 s。 ### jitter ```cpp int bytertc::RemoteAudioStats::jitter ``` 音频下行网络抖动，单位为 ms 。 ### decode_frame_rate ```cpp double bytertc::RemoteAudioStats::decode_frame_rate ``` 音频解码帧率。 # TorchState ```cpp enum bytertc::TorchState ``` 相机补光灯状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kTorchStateOff | 0 | 相机补光灯关闭 | | kTorchStateOn | 1 | 相机补光灯打开 | # IMixedStreamConfig ```cpp class bytertc::IMixedStreamConfig ``` 合流转推配置参数。如无特别说明，参数可适用于WTN 流和合流转推任务。如无特别说明，参数可用于启动和更新任务。 ## 静态函数 | 返回 | 名称 | | --- | --- | | BYTERTC_STATIC_API IMixedStreamConfig* | [createMixedStreamConfig](#IMixedStreamConfig-createmixedstreamconfig) | ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual const char* | [getRoomID](#IMixedStreamConfig-getroomid) | | virtual void | [setRoomID](#IMixedStreamConfig-setroomid) | | virtual const char* | [getUserID](#IMixedStreamConfig-getuserid) | | virtual void | [setUserID](#IMixedStreamConfig-setuserid) | | virtual MixedStreamAudioConfig | [getAudioConfig](#IMixedStreamConfig-getaudioconfig) | | virtual void | [setAudioConfig](#IMixedStreamConfig-setaudioconfig) | | virtual MixedStreamVideoConfig | [getVideoConfig](#IMixedStreamConfig-getvideoconfig) | | virtual void | [setVideoConfig](#IMixedStreamConfig-setvideoconfig) | | virtual MixedStreamControlConfig | [getControlConfig](#IMixedStreamConfig-getcontrolconfig) | | virtual void | [setControlConfig](#IMixedStreamConfig-setcontrolconfig) | | virtual const char* | [getUserConfigExtraInfo](#IMixedStreamConfig-getuserconfigextrainfo) | | virtual void | [setUserConfigExtraInfo](#IMixedStreamConfig-setuserconfigextrainfo) | | virtual StreamLayoutMode | [getStreamLayoutMode](#IMixedStreamConfig-getstreamlayoutmode) | | virtual void | [setStreamLayoutMode](#IMixedStreamConfig-setstreamlayoutmode) | | virtual InterpolationMode | [getInterpolationMode](#IMixedStreamConfig-getinterpolationmode) | | virtual void | [setInterpolationMode](#IMixedStreamConfig-setinterpolationmode) | | virtual const char* | [getPushWTNStreamID](#IMixedStreamConfig-getpushwtnstreamid) | | virtual void | [setPushWTNStreamID](#IMixedStreamConfig-setpushwtnstreamid) | | virtual MixedStreamPushTargetType | [getPushTargetType](#IMixedStreamConfig-getpushtargettype) | | virtual void | [setPushTargetType](#IMixedStreamConfig-setpushtargettype) | | virtual const char* | [getBackgroundColor](#IMixedStreamConfig-getbackgroundcolor) | | virtual void | [setBackgroundColor](#IMixedStreamConfig-setbackgroundcolor) | | virtual const char* | [getBackgroundImageURL](#IMixedStreamConfig-getbackgroundimageurl) | | virtual void | [setBackgroundImageURL](#IMixedStreamConfig-setbackgroundimageurl) | | virtual MixedStreamLayoutRegionConfig | [getLayoutByIndex](#IMixedStreamConfig-getlayoutbyindex) | | virtual int32_t | [getLayoutRegionsSize](#IMixedStreamConfig-getlayoutregionssize) | | virtual void | [setLayoutConfig](#IMixedStreamConfig-setlayoutconfig) | | virtual | [~IMixedStreamConfig](#IMixedStreamConfig-~imixedstreamconfig) | ## 函数说明 ### createMixedStreamConfig ```cpp static BYTERTC_STATIC_API IMixedStreamConfig* createMixedStreamConfig(); ``` 构建合流任务参数 **返回值** 合流任务参数 ### getRoomID ```cpp virtual const char* getRoomID() = 0; ``` 获取发起合流任务用户所在的房间 ID。 **返回值** 合流房间 ID ### setRoomID ```cpp virtual void setRoomID(const char* room_id) = 0; ``` 设置合流房间 ID **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char* | 发起合流的用户所在的房间 ID | **注意** 本参数不支持过程中更新。 ### getUserID ```cpp virtual const char* getUserID() = 0; ``` 获取发起合流任务的用户 ID。 **返回值** 用户 ID。 ### setUserID ```cpp virtual void setUserID(const char* user_id) = 0; ``` 设置发起合流任务的用户 ID。`room_id` 和 `user_id` 长度相加不得超过 126 字节。建议设置。本参数不支持过程中更新。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | user_id | const char* | 推流用户 ID。 | ### getAudioConfig ```cpp virtual MixedStreamAudioConfig getAudioConfig() = 0; ``` 获取合流音频参数。 **返回值** 合流音频参数内容，参看 [MixedStreamAudioConfig](#MixedStreamAudioConfig)。 ### setAudioConfig ```cpp virtual void setAudioConfig(const MixedStreamAudioConfig&) = 0; ``` 设置音频参数。建议设置。 **注意** - 本参数不支持过程中更新。 - WTN 流任务不支持设置本参数。 ### getVideoConfig ```cpp virtual MixedStreamVideoConfig getVideoConfig() = 0; ``` 获取视频转码参数。 **返回值** 视频转码参数内容，参看 [MixedStreamVideoConfig](#MixedStreamVideoConfig)。 ### setVideoConfig ```cpp virtual void setVideoConfig(const MixedStreamVideoConfig&) = 0; ``` 设置视频参数。建议设置。 ### getControlConfig ```cpp virtual MixedStreamControlConfig getControlConfig() = 0; ``` 获取服务端合流控制参数。参看 [MixedStreamControlConfig](#MixedStreamControlConfig)。 ### setControlConfig ```cpp virtual void setControlConfig(MixedStreamControlConfig& config) = 0; ``` 设置服务端合流控制参数。参看 [MixedStreamControlConfig](#MixedStreamControlConfig)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | config | MixedStreamControlConfig& | 参看 [MixedStreamControlConfig](#MixedStreamControlConfig). | ### getUserConfigExtraInfo ```cpp virtual const char* getUserConfigExtraInfo() = 0; ``` 获取用户配置的额外信息。 **返回值** 用户配置的额外信息。 ### setUserConfigExtraInfo ```cpp virtual void setUserConfigExtraInfo(const char* user_ext_info) = 0; ``` 设置用户配置的额外信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | user_ext_info | const char* | 用户配置的额外信息。 | **注意** WTN 流任务不支持设置本参数。 ### getStreamLayoutMode ```cpp virtual StreamLayoutMode getStreamLayoutMode() = 0; ``` 获取 WTN 流的布局模式。 **返回值** [StreamLayoutMode](#StreamLayoutMode) 信息。 ### setStreamLayoutMode ```cpp virtual void setStreamLayoutMode(StreamLayoutMode mode) = 0; ``` 设置 WTN 流的布局模式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mode | StreamLayoutMode | 布局模式。参看 [StreamLayoutMode](#StreamLayoutMode)。 | ### getInterpolationMode ```cpp virtual InterpolationMode getInterpolationMode() = 0; ``` 获取 WTN 流的补帧模式。 **返回值** [InterpolationMode](#InterpolationMode) 信息。 ### setInterpolationMode ```cpp virtual void setInterpolationMode(InterpolationMode mode) = 0; ``` 设置 WTN 流的补帧模式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mode | InterpolationMode | 补帧模式。参看 [InterpolationMode](#InterpolationMode)。 | ### getPushWTNStreamID ```cpp virtual const char* getPushWTNStreamID() = 0; ``` 获取 WTN 流 ID。 **返回值** WTN 流 ID。 ### setPushWTNStreamID ```cpp virtual void setPushWTNStreamID(const char* stream_id) = 0; ``` 设置 WTN 流 ID。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_id | const char* | WTN 流 ID。 | ### getPushTargetType ```cpp virtual MixedStreamPushTargetType getPushTargetType() = 0; ``` 获取任务类型。 **返回值** [MixedStreamPushTargetType](#MixedStreamPushTargetType) ### setPushTargetType ```cpp virtual void setPushTargetType(MixedStreamPushTargetType type) = 0; ``` 设置推流目标。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | MixedStreamPushTargetType | 参看 [MixedStreamPushTargetType](#MixedStreamPushTargetType)。 | ### getBackgroundColor ```cpp virtual const char* getBackgroundColor() = 0; ``` 获取背景颜色。 **返回值** 背景颜色，用十六进制颜色码（HEX）表示。例如，#FFFFFF 表示纯白，#000000 表示纯黑。默认值为 #000000。建议设置。 ### setBackgroundColor ```cpp virtual void setBackgroundColor(const char* background_color) = 0; ``` 设置背景颜色。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | background_color | const char* | 背景颜色，用十六进制颜色码（HEX）表示。例如，#FFFFFF 表示纯白，#000000 表示纯黑。默认值为 #000000。建议设置。 | ### getBackgroundImageURL ```cpp virtual const char* getBackgroundImageURL() = 0; ``` 获取背景图片的地址。 **返回值** 背景图片的地址。 ### setBackgroundImageURL ```cpp virtual void setBackgroundImageURL(const char* background_image_url) = 0; ``` 设置合流后整体画布的背景图片。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | background_image_url | const char* | 图片的 URL，长度最大为 1023 bytes。
必须是 http 开头，支持的图片格式包括：JPG, JPEG, PNG。如果背景图片的宽高和整体屏幕的宽高不一致，背景图片会缩放到铺满屏幕。 | ### getLayoutByIndex ```cpp virtual MixedStreamLayoutRegionConfig getLayoutByIndex(int32_t index) = 0; ``` 获取合流视窗布局信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | int32_t | 视窗对应下标。 | **返回值** 合流视窗布局信息，参看 [MixedStreamLayoutRegionConfig](#MixedStreamLayoutRegionConfig)。 ### getLayoutRegionsSize ```cpp virtual int32_t getLayoutRegionsSize() = 0; ``` 获取合流参数中视窗的数量 **返回值** 合流参数中视窗的数量 ### setLayoutConfig ```cpp virtual void setLayoutConfig( MixedStreamLayoutRegionConfig regions[], int32_t regions_size ) = 0; ``` 设置视频流合流整体布局信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | regions | MixedStreamLayoutRegionConfig[] | 用户布局信息列表。为 [MixedStreamLayoutRegionConfig](#MixedStreamLayoutRegionConfig) 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。
值不合法或未设置时，自动使用默认值。建议设置。 | | regions_size | int32_t | 合流视窗数量。建议设置。 | ### ~IMixedStreamConfig ```cpp virtual ~IMixedStreamConfig() = default; ``` # ForwardStreamInfo ```cpp struct bytertc::ForwardStreamInfo ``` 媒体流跨房间转发的目标房间的相关信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [token](#ForwardStreamInfo-token) | | const char* | [room_id](#ForwardStreamInfo-room_id) | ## 变量说明 ### token ```cpp const char* bytertc::ForwardStreamInfo::token ``` 使用转发目标房间 roomID 和 UserID 生成 Token。测试时可使用控制台生成临时 Token，正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。如果 Token 无效，转发失败。 ### room_id ```cpp const char* bytertc::ForwardStreamInfo::room_id ``` 跨间转发媒体流过程中目标房间 ID # RecordingFileType ```cpp enum bytertc::RecordingFileType ``` 本地录制文件的存储格式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRecordingFileTypeAAC | 0 | aac 格式文件 | | kRecordingFileTypeMP4 | 1 | mp4 格式文件 | # ForwardStreamError ```cpp enum bytertc::ForwardStreamError ``` 媒体流跨房间转发过程中抛出的错误码 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kForwardStreamErrorOK | 0 | 正常 | | kForwardStreamErrorInvalidArgument | 1201 | 参数异常 | | kForwardStreamErrorInvalidToken | 1202 | token 错误 | | kForwardStreamErrorResponse | 1203 | 服务端异常 | | kForwardStreamErrorRemoteKicked | 1204 | 目标房间有相同 user id 的用户加入，转发中断 | | kForwardStreamErrorNotSupport | 1205 | 服务端不支持转发功能 | # MixedStreamRenderMode ```cpp enum bytertc::MixedStreamRenderMode ``` 图片或视频流的缩放模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMixedStreamRenderModeHidden | 1 | 视窗填满优先，默认值。

视频尺寸等比缩放，直至视窗被填满。当视频尺寸与显示窗口尺寸不一致时，多出的视频将被截掉。 | | kMixedStreamRenderModeFit | 2 | 视频帧内容全部显示优先。

视频尺寸等比缩放，优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时，会把窗口未被填满的区域填充成背景颜色。 | | kMixedStreamRenderModeAdaptive | 3 | 视频帧自适应画布。

视频尺寸非等比例缩放，把窗口充满。在此过程中，视频帧的长宽比例可能会发生变化。 | # AudioQuality ```cpp enum bytertc::AudioQuality ``` 音频质量。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioQualityLow | 0 | 低音质 | | kAudioQualityMedium | 1 | 中音质 | | kAudioQualityHigh | 2 | 高音质 | | kAudioQualityUltraHigh | 3 | 超高音质 | # DeviceTransportType ```cpp enum bytertc::DeviceTransportType ``` 设备的传输方式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kDeviceTransportTypeUnknown | 0 | 未知类型 | | kDeviceTransportTypeBuiltIn | 1 | 系统内置 | | kDeviceTransportTypeBlueToothUnknownMode | 2 | 未知模式蓝牙 | | kDeviceTransportTypeBlueToothHandsFreeMode | 3 | 免提模式蓝牙 | | kDeviceTransportTypeBlueToothStereoMode | 4 | 立体声模式蓝牙 | | kDeviceTransportTypeDisplayAudio | 5 | 显示器/电视机音频设备 | | kDeviceTransportTypeVirtual | 6 | 虚拟设备 | | kDeviceTransportTypeUSB | 7 | USB 设备 | | kDeviceTransportTypePCI | 8 | PCI 设备 | | kDeviceTransportTypeAirPlay | 9 | AirPlay 设备 | | kDeviceTransportTypeContinuityCamera | 100 | 连续互通相机 | # RecordingType ```cpp enum bytertc::RecordingType ``` 本地录制的媒体类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRecordingTypeAudioOnly | 0 | 只录制音频 | | kRecordingTypeVideoOnly | 1 | 只录制视频 | | kRecordingTypeVideoAndAudio | 2 | 同时录制音频和视频 | # RemoteUserPriority ```cpp enum bytertc::RemoteUserPriority ``` 远端用户优先级，在性能不足需要回退时，会优先回退优先级低的用户的音视频流 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteUserPriorityLow | 0 | 用户优先级为低（默认值） | | kRemoteUserPriorityMedium | 100 | 用户优先级为正常 | | kRemoteUserPriorityHigh | 200 | 用户优先级为高 | # AudioFormat ```cpp struct bytertc::AudioFormat ``` 音频格式 ## 成员变量 | 类型 | 名称 | | --- | --- | | AudioSampleRate | [sample_rate](#AudioFormat-sample_rate) | | AudioChannel | [channel](#AudioFormat-channel) | | int | [samples_per_call](#AudioFormat-samples_per_call) | ## 变量说明 ### sample_rate ```cpp AudioSampleRate bytertc::AudioFormat::sample_rate = kAudioSampleRateAuto ``` 音频采样率，详见 [AudioSampleRate](#AudioSampleRate) ### channel ```cpp AudioChannel bytertc::AudioFormat::channel = kAudioChannelAuto ``` 音频声道，详见 [AudioChannel](#AudioChannel) ### samples_per_call ```cpp int bytertc::AudioFormat::samples_per_call = 0 ``` 单次回调的音频帧中包含的采样点数。默认值为 `0`，此时，采样点数取最小值。最小值为回调间隔是 0.01s 时的值，即 `sampleRate * channel * 0.01s`。最大值是 `2048`。超出取值范围时，采样点数取默认值。该参数仅在设置读写回调时生效，调用 [enableAudioFrameCallback](70095#IRTCEngine-enableaudioframecallback) 开启只读模式回调时设置该参数不生效。 # RoomState ```cpp enum bytertc::RoomState ``` 房间状态码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRoomStateJoinSuccess | 0 | 加入房间成功 | | kRoomStateJoinFailed | 1 | 加入房间失败 | | kRoomStateLeft | 2 | 离开房间 | # InterpolationMode ```cpp enum bytertc::InterpolationMode ``` WTN 流的补帧模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kInterpolationModeLastFrameFill | 0 | 补最后一帧 | | kInterpolationModeBackgroundImageFill | 1 | 补背景图片 | # ScreenMediaType ```cpp enum bytertc::ScreenMediaType ``` 屏幕采集的媒体类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kScreenMediaTypeVideoOnly | 0 | 仅采集视频 | | kScreenMediaTypeAudioOnly | 1 | 仅采集音频 | | kScreenMediaTypeVideoAndAudio | 2 | 同时采集音频和视频 | # FrameRateRatio ```cpp enum bytertc::FrameRateRatio ``` 占发布端原始帧率的比例 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kFrameRateRatioOriginal | 0 | 100\% | | kFrameRateRatioHalf | 1 | 50\% | | kFrameRateRatioQuarter | 2 | 25\% | # StreamInfo ```cpp struct bytertc::StreamInfo ``` 流属性。 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [stream_id](#StreamInfo-stream_id) | | const char* | [room_id](#StreamInfo-room_id) | | const char* | [user_id](#StreamInfo-user_id) | | bool | [is_screen](#StreamInfo-is_screen) | ## 变量说明 ### stream_id ```cpp const char* bytertc::StreamInfo::stream_id ``` 流 ID 。 ### room_id ```cpp const char* bytertc::StreamInfo::room_id ``` 房间 ID。 ### user_id ```cpp const char* bytertc::StreamInfo::user_id ``` 发布此流的用户 ID 。 ### is_screen ```cpp bool bytertc::StreamInfo::is_screen ``` 预留字段。 # CapturePreference ```cpp enum bytertc::VideoCaptureConfig::CapturePreference ``` 视频采集模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAuto | 0 | （默认）自动设置采集参数。

SDK 在开启采集时根据服务端下发的采集配置结合编码参数设置最佳采集参数。 | | kManual | 1 | 手动设置采集参数，包括采集分辨率、帧率。 | | kAutoPerformance | 2 | 采集参数与编码参数一致，即在 [setVideoEncoderConfig](70095#IRTCEngine-setvideoencoderconfig) 中设置的参数。 | # RtcUser ```cpp struct bytertc::RtcUser ``` 用户信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [user_id](#RtcUser-user_id) | | const char* | [meta_data](#RtcUser-meta_data) | ## 变量说明 ### user_id ```cpp const char* bytertc::RtcUser::user_id ``` 用户 id ### meta_data ```cpp const char* bytertc::RtcUser::meta_data ``` 元数据 # LocalAudioPropertiesInfo ```cpp struct bytertc::LocalAudioPropertiesInfo ``` 本地音频属性信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | IAudioSource* | [audio_source](#LocalAudioPropertiesInfo-audio_source) | | AudioPropertiesInfo | [audio_properties_info](#LocalAudioPropertiesInfo-audio_properties_info) | ## 变量说明 ### audio_source ```cpp IAudioSource* bytertc::LocalAudioPropertiesInfo::audio_source ``` 音频源 ### audio_properties_info ```cpp AudioPropertiesInfo bytertc::LocalAudioPropertiesInfo::audio_properties_info ``` 音频属性信息，详见 [AudioPropertiesInfo](#AudioPropertiesInfo) # AVSyncEvent ```cpp enum bytertc::AVSyncEvent ``` AVSync 事件类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAVSyncEventInvalidUidRepeated | 0 | 音视频同步失败。

当前音频源已与其他视频源关联同步关系。

单个音频源不支持与多个视频源同时同步。 | # ScreenCaptureSourceType ```cpp enum bytertc::ScreenCaptureSourceType ``` 屏幕采集对象的类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kScreenCaptureSourceTypeUnknown | 0 | 类型未知 | | kScreenCaptureSourceTypeWindow | 1 | 应用程序的窗口 | | kScreenCaptureSourceTypeScreen | 2 | 桌面 | # AudioProfileType ```cpp enum bytertc::AudioProfileType ``` 音质档位 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioProfileTypeDefault | 0 | 默认音质

服务器下发或客户端已设置的 [RoomProfileType](#RoomProfileType) 的音质配置 | | kAudioProfileTypeFluent | 1 | 流畅

单声道，采样率为 16 kHz，编码码率为 32 Kbps。

流畅优先、低功耗、低流量消耗，适用于大部分游戏场景，如小队语音、组队语音、国战语音等。 | | kAudioProfileTypeStandard | 2 | 单声道标准音质。

采样率为 24 kHz，编码码率为 48 Kbps。

适用于对音质有一定要求的场景，同时延时、功耗和流量消耗相对适中，适合教育场景和狼人杀等游戏。 | | kAudioProfileTypeHD | 3 | 双声道音乐音质

采样率为 48 kHz，编码码率为 128 kbps。

超高音质，同时延时、功耗和流量消耗相对较大，适用于连麦 PK 等音乐场景。

游戏场景不建议使用。 | | kAudioProfileTypeStandardStereo | 4 | 双声道标准音质。采样率为 48 KHz，编码码率最大值为 80 Kbps | | kAudioProfileTypeHDMono | 5 | 单声道音乐音质。采样率为 48 kHz，编码码率最大值为 64 Kbps | # UserInfo ```cpp struct bytertc::UserInfo ``` 用户信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [uid](#UserInfo-uid) | | const char* | [extra_info](#UserInfo-extra_info) | ## 变量说明 ### uid ```cpp const char* bytertc::UserInfo::uid = nullptr ``` 用户 ID。该字符串符合正则表达式：`[a-zA-Z0-9_\@\\-\\.]{1,128}`。 ### extra_info ```cpp const char* bytertc::UserInfo::extra_info = nullptr ``` 用户的额外信息，最大长度为 200 字节。会在 `onUserJoined` 中回调给远端用户。 # EncryptType ```cpp enum bytertc::EncryptType ``` 自定义加密类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kEncryptTypeNone | 0 | 不使用加密。默认值。 | | kEncryptTypeAES128CBC | 1 | AES-128-CBC 加密算法 | | kEncryptTypeAES256CBC | 2 | AES-256-CBC 加密算法 | | kEncryptTypeAES128ECB | 3 | AES-128-ECB 加密算法 | | kEncryptTypeAES256ECB | 4 | AES-256-ECB 加密算法 | # VideoDeviceInfo ```cpp struct bytertc::VideoDeviceInfo ``` 视频设备信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | char[MAX_DEVICE_ID_LENGTH] | [device_id](#VideoDeviceInfo-device_id) | | char[MAX_DEVICE_ID_LENGTH] | [device_name](#VideoDeviceInfo-device_name) | | int64_t | [device_vid](#VideoDeviceInfo-device_vid) | | int64_t | [device_pid](#VideoDeviceInfo-device_pid) | | DeviceTransportType | [transport_type](#VideoDeviceInfo-transport_type) | | VideoDeviceFacing | [device_facing](#VideoDeviceInfo-device_facing) | ## 变量说明 ### device_id ```cpp char bytertc::VideoDeviceInfo::device_id[MAX_DEVICE_ID_LENGTH] ``` 设备 ID ### device_name ```cpp char bytertc::VideoDeviceInfo::device_name[MAX_DEVICE_ID_LENGTH] ``` 设备名称 ### device_vid ```cpp int64_t bytertc::VideoDeviceInfo::device_vid ``` 设备的厂商 ID ### device_pid ```cpp int64_t bytertc::VideoDeviceInfo::device_pid ``` 设备的产品编码 ### transport_type ```cpp DeviceTransportType bytertc::VideoDeviceInfo::transport_type ``` 设备的传输方式 ### device_facing ```cpp VideoDeviceFacing bytertc::VideoDeviceInfo::device_facing ``` 视频设备朝向类型 # RemoteAudioPropertiesInfo ```cpp struct bytertc::RemoteAudioPropertiesInfo ``` 远端音频属性信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [stream_id](#RemoteAudioPropertiesInfo-stream_id) | | StreamInfo | [stream_info](#RemoteAudioPropertiesInfo-stream_info) | | AudioPropertiesInfo | [audio_properties_info](#RemoteAudioPropertiesInfo-audio_properties_info) | ## 变量说明 ### stream_id ```cpp const char* bytertc::RemoteAudioPropertiesInfo::stream_id ``` 流 ID ### stream_info ```cpp StreamInfo bytertc::RemoteAudioPropertiesInfo::stream_info ``` 流信息。参看 [StreamInfo](#StreamInfo) ### audio_properties_info ```cpp AudioPropertiesInfo bytertc::RemoteAudioPropertiesInfo::audio_properties_info ``` 音频属性信息，详见 [AudioPropertiesInfo](#AudioPropertiesInfo) # RecordingErrorCode ```cpp enum bytertc::RecordingErrorCode ``` 本地录制的错误码 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRecordingErrorCodeOk | 0 | 录制正常 | | kRecordingErrorCodeNoPermission | -1 | 没有文件写权限 | | kRecordingErrorCodeNotSupport | -2 | 当前版本 SDK 不支持本地录制功能，请联系技术支持人员 | | kRecordingErrorCodeOther | -3 | 其他异常 | # AudioMixingDualMonoMode ```cpp enum bytertc::AudioMixingDualMonoMode ``` 混音播放声道类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioMixingDualMonoModeAuto | 0 | 和音频文件一致 | | kAudioMixingDualMonoModeL | 1 | 只能听到音频文件中左声道的音频 | | kAudioMixingDualMonoModeR | 2 | 只能听到音频文件中右声道的音频 | | kAudioMixingDualMonoModeMix | 3 | 能同时听到音频文件中左右声道的音频 | # VideoStreamScaleMode ```cpp enum bytertc::VideoStreamScaleMode ``` 视频帧缩放模式，默认值为 FitWithCropping。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoStreamScaleModeAuto | 0 | 自动模式 | | kVideoStreamScaleModeStretch | 1 | 对视频帧进行缩放，直至充满和视窗分辨率一致为止。这一过程不保证等比缩放。 | | kVideoStreamScaleModeFitWithCropping | 2 | 视窗填满优先。

视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。

缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长。 | | kVideoStreamScaleModeFitWithFilling | 3 | 视频帧内容全部显示优先。

视频帧等比缩放，直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同，视窗上未被视频帧填满区域将被涂黑。

缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长。 | # AudioPropertiesMode ```cpp enum bytertc::AudioPropertiesMode ``` [onLocalAudioPropertiesReport](70096#IRTCEngineEventHandler-onlocalaudiopropertiesreport) 中包含的音频信息的范围。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioPropertiesModeMicrophone | 0 | 仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据。 | | kAudioPropertiesModeAudioMixing | 1 | 包含以下信息：

本地麦克风采集的音频数据和本地屏幕音频采集数据；
本地混音的音频数据。

| # VideoPictureType ```cpp enum bytertc::VideoPictureType ``` 编码帧类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoPictureTypeUnknown | 0 | 未知类型 | | kVideoPictureTypeI | 1 | I 帧，关键帧，编解码不需要参考其他视频帧 | | kVideoPictureTypeP | 2 | P 帧，向前参考帧，编解码需要参考前一帧视频帧 | | kVideoPictureTypeB | 3 | B 帧，前后参考帧，编解码需要参考前后两帧视频帧 | # AudioMixingError ```cpp enum bytertc::AudioMixingError ``` 混音错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioMixingErrorOk | 0 | 正常 | | kAudioMixingErrorPreloadFailed | 1 | 预加载失败。找不到混音文件或者文件长度超出 20s | | kAudioMixingErrorStartFailed | 2 | 混音开启失败。找不到混音文件或者混音文件打开失败 | | kAudioMixingErrorIdNotFound | 3 | 混音 ID 异常 | | kAudioMixingErrorSetPositionFailed | 4 | 设置混音文件的播放位置出错 | | kAudioMixingErrorInValidVolume | 5 | 音量参数不合法，仅支持设置的音量值为[0, 400] | | kAudioMixingErrorLoadConflict | 6 | 播放的文件与预加载的文件不一致。请先使用 unloadAudioMixing 卸载此前的文件。 | | kAudioMixingErrorIdTypeNotMatch | 7 | 不支持此混音类型。 | | kAudioMixingErrorInValidPitch | 8 | 设置混音文件的音调不合法 | | kAudioMixingErrorInValidAudioTrack | 9 | 设置混音文件的音轨不合法 | | kAudioMixingErrorIsStarting | 10 | 混音文件正在启动中 | | kAudioMixingErrorInValidPlaybackSpeed | 11 | 设置混音文件的播放速度不合法 | | [deprecated] kAudioMixingErrorCanNotOpen | 701 | `Deprecated since 3.25 and will be deleted in 3.51`
混音错误码，失败，已废弃 | # ZoomDirectionType ```cpp enum bytertc::ZoomDirectionType ``` 数码变焦操作类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kZoomDirectionTypeMoveLeft | 0 | 相机向左移动 | | kZoomDirectionTypeMoveRight | 1 | 相机向右移动 | | kZoomDirectionTypeMoveUp | 2 | 相机向上移动 | | kZoomDirectionTypeMoveDown | 3 | 相机向下移动 | | kZoomDirectionTypeZoomOut | 4 | 相机缩小焦距 | | kZoomDirectionTypeZoomIn | 5 | 相机放大焦距 | | kZoomDirectionTypeReset | 6 | 恢复到原始画面 | # WTNSubscribeStateChangeReason ```cpp enum bytertc::WTNSubscribeStateChangeReason ``` WTN 媒体流订阅状态改变的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kWTNSubscribeStateChangeReasonSubscribe | 0 | 订阅 WTN 媒体流成功 | | kWTNSubscribeStateChangeReasonUnsubscribe | 1300 | 其他原因订阅失败 | | kWTNSubscribeStateChangeReasonRemoteUnpublish | 1301 | 订阅失败，拉流时远端未发布 | | kWTNSubscribeStateChangeReasonOverClientSubscribeStreamLimit | 1310 | 订阅失败，超出单端订阅上限。一个引擎实例最多拉 5 路流。 | | kWTNSubscribeStateChangeReasonOverStreamSubscribeUserLimit | 1311 | 订阅失败。超出单流订阅人数上限。该限制由 RTC 服务端决定。 | | kWTNSubscribeStateChangeReasonOverStreamSubscribeRequestLimit | 1312 | 订阅失败。超出单流订阅请求 QPS 上限。该限制由 RTC 服务端决定。 | # SingleStreamPushType ```cpp enum bytertc::SingleStreamPushType ``` 单流转推类型，指定将媒体流转推到 CDN 还是 RTC 房间。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kPushToCDN | 1 | 转推到 CDN | | kPushToRTC | 2 | 转推到 RTC 房间 | # MediaPlayerCustomSourceMode ```cpp enum bytertc::MediaPlayerCustomSourceMode ``` 自定义音频源模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaPlayerCustomSourceModePush | 0 | 当播放来自本地的 PCM 数据时，使用此选项。 | | kMediaPlayerCustomSourceModePull | 1 | 当播放来自内存的音频数据时，使用此选项。 | # GameRoomConfig ```cpp struct bytertc::GameRoomConfig ``` 房间参数配置。房间是 RTC 通话的抽象概念。在同一个房间中的用户可以进行音视频通话。 ## 成员变量 | 类型 | 名称 | | --- | --- | | GameRoomType | [game_room_type](#GameRoomConfig-game_room_type) | | GameSceneType | [game_scene_type](#GameRoomConfig-game_scene_type) | ## 变量说明 ### game_room_type ```cpp GameRoomType bytertc::GameRoomConfig::game_room_type = GameRoomType::kGameRoomTypeTeam ``` 游戏房间类型。参看 [GameRoomType](#GameRoomType)，默认为 `kGameRoomTypeTeam`（小队房间），进房后不可更改。 ### game_scene_type ```cpp GameSceneType bytertc::GameRoomConfig::game_scene_type = GameSceneType::kGameSceneTypeNormal ``` 游戏场景类型。参看 [GameSceneType](#GameSceneType)，默认为 `kGameSceneTypeNormal`（普通场景），进房后不可更改。 # VideoSourceType ```cpp enum bytertc::VideoSourceType ``` 视频输入源类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoSourceTypeExternal | 0 | 自定义采集视频源 | | kVideoSourceTypeInternal | 1 | 内部采集视频源 | | kVideoSourceTypeEncodedWithAutoSimulcast | 2 | 自定义编码视频源。

你仅需推送分辨率最大的一路编码后视频流，SDK 将自动转码生成多路小流 | | kVideoSourceTypeEncodedWithoutAutoSimulcast | 3 | 自定义编码视频源。

SDK 不会自动生成多路流，你需要自行生成并推送多路流 | # StreamIndex ```cpp enum bytertc::streamingrtc::StreamIndex ``` 流的序号，用于区分同一用户发出的多路流。例如 3D 视频流中的左/右眼。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kStreamIndexIndex0 | 0 | 流序号 0 | | kStreamIndexIndex1 | 1 | 流序号 1 | # AudioProcessorMethod ```cpp enum bytertc::AudioProcessorMethod ``` 返回给音频处理器的音频类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioProcessorMethodRecord | 0 | 本地采集的音频。 | | kAudioProcessorMethodPlayback | 1 | 远端音频流的混音音频。 | | kAudioProcessorMethodRemoteUser | 2 | 各个远端音频流。 | | kAudioProcessorMethodScreen | 4 | 屏幕共享音频。 | # VideoSimulcastMode ```cpp enum bytertc::VideoSimulcastMode ``` 发布大小流模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoSimulcastModeOnlyOne | 0 | 单流模式。始终只有 1 路分辨率的流。 | | kVideoSimulcastModeOnDemand | 1 | 按需订阅模式。发送端会根据订阅端的状态，按需发布。无订阅偏好设置默认发送 2 路。 | | kVideoSimulcastModeAlwaysSimulcast | 2 | 订阅弱流。发送端始终按照设置的参数发布所有大小流。默认发送 2 路。 | # AudioChannel ```cpp enum bytertc::AudioChannel ``` 音频声道。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioChannelAuto | -1 | 默认设置。 | | kAudioChannelMono | 1 | 单声道 | | kAudioChannelStereo | 2 | 双声道 | # AudioFormatType ```cpp enum class bytertc::AudioFormatType ``` 音频输入格式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRawPCMs16 | 0 | PCM_S16 | | kRawPCMs32 | 1 | PCM_S32 | # MirrorType ```cpp enum bytertc::MirrorType ``` 镜像类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMirrorTypeNone | 0 | 本地预览和编码传输时均无镜像效果 | | kMirrorTypeRender | 1 | 本地预览时有镜像效果，编码传输时无镜像效果 | | kMirrorTypeEncoder | 2 | 本地预览时无镜像效果，仅编码传输时有镜像效果 | | kMirrorTypeRenderAndEncoder | 3 | 本地预览和编码传输时均有镜像效果 | # StreamLayoutMode ```cpp enum bytertc::StreamLayoutMode ``` WTN 流的布局模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kStreamLayoutModeAuto | 0 | 自动布局 | | kStreamLayoutModeCustom | 2 | 自定义 | # VideoCaptureConfig ```cpp struct bytertc::VideoCaptureConfig ``` 视频采集配置参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | CapturePreference | [capture_preference](#VideoCaptureConfig-capture_preference) | | int | [width](#VideoCaptureConfig-width) | | int | [height](#VideoCaptureConfig-height) | | int | [frame_rate](#VideoCaptureConfig-frame_rate) | ## 变量说明 ### capture_preference ```cpp CapturePreference bytertc::VideoCaptureConfig::capture_preference = CapturePreference::kAuto ``` 视频采集模式，参看 [CapturePreference](#CapturePreference). ### width ```cpp int bytertc::VideoCaptureConfig::width = 0 ``` 视频采集分辨率的宽度，单位：px。 ### height ```cpp int bytertc::VideoCaptureConfig::height = 0 ``` 视频采集分辨率的高度，单位：px。 ### frame_rate ```cpp int bytertc::VideoCaptureConfig::frame_rate = 0 ``` 视频采集帧率，单位：fps。 # LogoutReason ```cpp enum bytertc::LogoutReason ``` 用户登出的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLogoutReasonLogout | 0 | 用户主动退出

用户调用 `logout` 接口登出，或者销毁引擎登出。 | | kLogoutReasonDuplicateLogin | 1 | 用户被动退出

另一个用户以相同 UserId 进行了 `login`，导致本端用户被踢出。 | # SubtitleState ```cpp enum bytertc::SubtitleState ``` 字幕任务状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSubtitleStateStarted | 0 | 开启字幕。 | | kSubtitleStateStoped | 1 | 关闭字幕。 | | kSubtitleStateError | 2 | 字幕任务出现错误。 | # UserOfflineReason ```cpp enum bytertc::UserOfflineReason ``` 用户离开房间的原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kUserOfflineReasonQuit | 0 | 远端用户调用 `leaveRoom` 方法退出房间。 | | kUserOfflineReasonDropped | 1 | 远端用户因网络等原因掉线。 | | kUserOfflineReasonSwitchToInvisible | 2 | 远端用户切换至隐身状态。 | | kUserOfflineReasonKickedByAdmin | 3 | 远端用户被踢出出房间。

因调用踢出用户的 OpenAPI，远端用户被踢出房间。 | # SubscribeVideoConfig ```cpp struct bytertc::SubscribeVideoConfig ``` 视频订阅配置信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [video_index](#SubscribeVideoConfig-video_index) | | int | [priority](#SubscribeVideoConfig-priority) | ## 变量说明 ### video_index ```cpp int bytertc::SubscribeVideoConfig::video_index = 0 ``` 订阅的视频流分辨率下标。当远端用户通过调用 [setVideoEncoderConfig](70095#IRTCEngine-setvideoencoderconfig) 方法启动发布多路不同分辨率的视频流时，本地用户需通过此参数指定希望订阅的流。默认值为 0，即订阅第一路流。如果不想更改之前的设置，可以输入 -1。 ### priority ```cpp int bytertc::SubscribeVideoConfig::priority = 0 ``` 远端用户优先级，参看 [RemoteUserPriority](#RemoteUserPriority)，默认值为 0。 # PublishFallbackOption ```cpp enum bytertc::PublishFallbackOption ``` 发布端音视频流回退选项 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kPublishFallbackOptionDisabled | 0 | 上行网络不佳或设备性能不足时，不对音视频流作回退处理。默认设置。 | | kPublishFallbackOptionSimulcast | 1 | 上行网络不佳或设备性能不足时，发布的视频流会从大流到小流依次降级，直到与当前网络性能匹配，具体降级规则参看[性能回退](https://www.volcengine.com/docs/6348/70137)文档。 | # MixedStreamSpatialAudioConfig ```cpp struct bytertc::MixedStreamSpatialAudioConfig ``` 推流 CDN 的空间音频参数。 ## 成员变量 | 类型 | 名称 | | --- | --- | | bool | [enable_spatial_render](#MixedStreamSpatialAudioConfig-enable_spatial_render) | | Position | [audience_spatial_position](#MixedStreamSpatialAudioConfig-audience_spatial_position) | | HumanOrientation | [audience_spatial_orientation](#MixedStreamSpatialAudioConfig-audience_spatial_orientation) | ## 变量说明 ### enable_spatial_render ```cpp bool bytertc::MixedStreamSpatialAudioConfig::enable_spatial_render ``` 是否开启推流 CDN 时的空间音频效果。 **注意** 当你启用此效果时，你需要设定推流中各个 [MixedStreamLayoutRegionConfig](#MixedStreamLayoutRegionConfig) 的 `spatial_position` 值，实现空间音频效果。 ### audience_spatial_position ```cpp Position bytertc::MixedStreamSpatialAudioConfig::audience_spatial_position ``` 听众的空间位置。参看 [Position](#Position)。听众指收听来自 CDN 的音频流的用户。 WTN 流任务不支持设置本参数。 ### audience_spatial_orientation ```cpp HumanOrientation bytertc::MixedStreamSpatialAudioConfig::audience_spatial_orientation ``` 听众的空间朝向。参看 [HumanOrientation](#HumanOrientation)。听众指收听来自 CDN 的音频流的用户。 # LocalStreamStats ```cpp struct bytertc::LocalStreamStats ``` 本地音/视频流统计信息以及网络状况，统计周期为 2s 。本地用户发布音/视频流成功后，SDK 会周期性地通过 `onLocalStreamStats` 通知本地用户发布的音/视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | LocalAudioStats | [audio_stats](#LocalStreamStats-audio_stats) | | LocalVideoStats | [video_stats](#LocalStreamStats-video_stats) | | bool | [is_screen](#LocalStreamStats-is_screen) | | NetworkQuality | [deprecated] [local_tx_quality](#LocalStreamStats-local_tx_quality) | | NetworkQuality | [deprecated] [local_rx_quality](#LocalStreamStats-local_rx_quality) | ## 变量说明 ### audio_stats ```cpp LocalAudioStats bytertc::LocalStreamStats::audio_stats ``` 本地设备发送音频流的统计信息，详见 [LocalAudioStats](#LocalAudioStats) ### video_stats ```cpp LocalVideoStats bytertc::LocalStreamStats::video_stats ``` 本地设备发送视频流的统计信息，详见 [LocalVideoStats](#LocalVideoStats) ### is_screen ```cpp bool bytertc::LocalStreamStats::is_screen ``` 预留字段。 ### local_tx_quality ```cpp NetworkQuality bytertc::LocalStreamStats::local_tx_quality ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onNetworkQuality](70096#IRTCRoomEventHandler-onnetworkquality) instead. 所属用户的媒体流上行网络质量，详见 [NetworkQuality](#NetworkQuality) ### local_rx_quality ```cpp NetworkQuality bytertc::LocalStreamStats::local_rx_quality ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onNetworkQuality](70096#IRTCRoomEventHandler-onnetworkquality) instead. 所属用户的媒体流下行网络质量，详见 [NetworkQuality](#NetworkQuality) # EngineConfig ```cpp struct bytertc::streamingrtc::EngineConfig ``` 串流引擎配置客户端和服务端的端口范围含义说明如下：服务端：引擎启动后开始监听端口 `server_port_min` 至 `server_port_max` 中的首个可用端口，等待客户端连接客户端：引擎启动后开始不断尝试连接服务端，IP 地址为 `server_ip` ,端口号为 `server_port_min` 至 `server_port_max` ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [app_id](#EngineConfig-app_id) | | P2PRole | [role](#EngineConfig-role) | | const char* | [server_ip](#EngineConfig-server_ip) | | int | [server_port_min](#EngineConfig-server_port_min) | | int | [server_port_max](#EngineConfig-server_port_max) | ## 变量说明 ### app_id ```cpp const char* bytertc::streamingrtc::EngineConfig::app_id = nullptr ``` 每个应用的唯一标识符。不同的 AppId 生成的实例进行音视频通话完全独立，无法互通。 ### role ```cpp P2PRole bytertc::streamingrtc::EngineConfig::role = kP2PRoleClient ``` 串流引擎角色, 参看 [P2PRole](#P2PRole) ### server_ip ```cpp const char* bytertc::streamingrtc::EngineConfig::server_ip = nullptr ``` 服务端所在的 IP 地址，`role = kP2PRoleClient` 时需要设置 ### server_port_min ```cpp int bytertc::streamingrtc::EngineConfig::server_port_min = 50000 ``` 最小端口号 ### server_port_max ```cpp int bytertc::streamingrtc::EngineConfig::server_port_max = 50004 ``` 最大端口号 # MixedStreamLayoutRegionImageWaterMarkConfig ```cpp struct bytertc::MixedStreamLayoutRegionImageWaterMarkConfig ``` 图片合流水印图片分辨率。 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [image_width](#MixedStreamLayoutRegionImageWaterMarkConfig-image_width) | | int | [image_height](#MixedStreamLayoutRegionImageWaterMarkConfig-image_height) | ## 变量说明 ### image_width ```cpp int bytertc::MixedStreamLayoutRegionImageWaterMarkConfig::image_width = 0 ``` 原始图片的宽度，单位为 px。 ### image_height ```cpp int bytertc::MixedStreamLayoutRegionImageWaterMarkConfig::image_height = 0 ``` 原始图片的高度，单位为 px。 # VoiceReverbConfig ```cpp struct bytertc::VoiceReverbConfig ``` 音频混响效果。 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [room_size](#VoiceReverbConfig-room_size) | | float | [decay_time](#VoiceReverbConfig-decay_time) | | float | [damping](#VoiceReverbConfig-damping) | | float | [wet_gain](#VoiceReverbConfig-wet_gain) | | float | [dry_gain](#VoiceReverbConfig-dry_gain) | | float | [pre_delay](#VoiceReverbConfig-pre_delay) | ## 变量说明 ### room_size ```cpp float bytertc::VoiceReverbConfig::room_size = 50.0f ``` 混响模拟的房间大小，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。房间越大，混响越强。 ### decay_time ```cpp float bytertc::VoiceReverbConfig::decay_time = 50.0f ``` 混响的拖尾长度，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。 ### damping ```cpp float bytertc::VoiceReverbConfig::damping = 50.0f ``` 混响的衰减阻尼大小，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。 ### wet_gain ```cpp float bytertc::VoiceReverbConfig::wet_gain = 0.0f ``` 早期反射信号强度。取值范围 `[-20.0, 10.0]`，单位为 dB。默认值为 `0.0f`。 ### dry_gain ```cpp float bytertc::VoiceReverbConfig::dry_gain = 0.0f ``` 原始信号强度。取值范围 `[-20.0, 10.0]`，单位为 dB。默认值为 `0.0f`。 ### pre_delay ```cpp float bytertc::VoiceReverbConfig::pre_delay = 0.0f ``` 早期反射信号的延迟。取值范围 `[0.0, 200.0]`，单位为 ms。默认值为 `0.0f`。 # AttenuationType ```cpp enum bytertc::AttenuationType ``` 空间音频音量随距离衰减模式 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAttenuationTypeNone | 0 | 不随距离衰减 | | kAttenuationTypeLinear | 1 | 线性衰减，音量随距离增大而线性减小 | | kAttenuationTypeExponential | 2 | 指数型衰减，音量随距离增大进行指数衰减 | # StreamSyncInfoConfig ```cpp struct bytertc::StreamSyncInfoConfig ``` 媒体流信息同步的相关配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [repeat_count](#StreamSyncInfoConfig-repeat_count) | | SyncInfoStreamType | [stream_type](#StreamSyncInfoConfig-stream_type) | ## 变量说明 ### repeat_count ```cpp int bytertc::StreamSyncInfoConfig::repeat_count ``` 消息发送的重复次数，取值范围是 [0,25]，建议设置为 [3,5]。 ### stream_type ```cpp SyncInfoStreamType bytertc::StreamSyncInfoConfig::stream_type ``` 媒体流信息同步的流类型，见 [SyncInfoStreamType](#SyncInfoStreamType) # MixedStreamVideoType ```cpp enum bytertc::MixedStreamVideoType ``` 预留字段。 # AlphaLayout ```cpp enum bytertc::AlphaLayout ``` Alpha 通道相对于 RGB 通道数据的排列位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAlphaLayoutTop | 0 | Alpha 数据置于 RGB 数据上方。 | # Orientation ```cpp struct bytertc::Orientation ``` 方向朝向信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | float | [x](#Orientation-x) | | float | [y](#Orientation-y) | | float | [z](#Orientation-z) | ## 变量说明 ### x ```cpp float bytertc::Orientation::x ``` x 坐标 ### y ```cpp float bytertc::Orientation::y ``` y 坐标 ### z ```cpp float bytertc::Orientation::z ``` z 坐标 # HighlightConfig ```cpp struct bytertc::HighlightConfig ``` 屏幕共享时的边框高亮设置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | bool | [enable_highlight](#HighlightConfig-enable_highlight) | | uint32_t | [border_color](#HighlightConfig-border_color) | | int | [border_width](#HighlightConfig-border_width) | ## 变量说明 ### enable_highlight ```cpp bool bytertc::HighlightConfig::enable_highlight = true ``` 是否显示高亮边框，默认显示。 ### border_color ```cpp uint32_t bytertc::HighlightConfig::border_color = 0xFF29CCA3 ``` 边框的颜色, 颜色格式为十六进制 ARGB：0xAARRGGB。 ### border_width ```cpp int bytertc::HighlightConfig::border_width = 4 ``` 边框的宽度，单位：像素。 # RoomEventInfo ```cpp struct bytertc::RoomEventInfo ``` 房间事件信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int64_t | [forbidden_time](#RoomEventInfo-forbidden_time) | ## 变量说明 ### forbidden_time ```cpp int64_t bytertc::RoomEventInfo::forbidden_time = 0 ``` 房间/用户被封禁，通过房间事件通知封禁时间。 # LocalLogLevel ```cpp enum class bytertc::LocalLogLevel ``` 本地日志输出等级。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kInfo | 0 | 信息级别。 | | kWarning | 1 | （默认值）警告级别。 | | kError | 2 | 错误级别。 | | kNone | 3 | 关闭日志。 | # FirstFrameSendState ```cpp enum bytertc::FirstFrameSendState ``` 首帧发送状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kFirstFrameSendStateSending | 0 | 发送中 | | kFirstFrameSendStateSent | 1 | 发送成功 | | kFirstFrameSendStateEnd | 2 | 发送失败 | # AudioDumpStatus ```cpp enum bytertc::AudioDumpStatus ``` 音频 dump 状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioDumpStatusStartFailure | 0 | 音频 dump 启动失败 | | kAudioDumpStatusStartSuccess | 1 | 音频 dump 启动成功 | | kAudioDumpStatusStopFailure | 2 | 音频 dump 停止失败 | | kAudioDumpStatusStopSuccess | 3 | 音频 dump 停止成功 | | kAudioDumpStatusRunningFailure | 4 | 音频 dump 运行失败 | | kAudioDumpStatusRunningSuccess | 5 | 音频 dump 运行成功 | # MixedStreamTaskInfo ```cpp struct bytertc::MixedStreamTaskInfo ``` WTN 流任务详情 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [task_id](#MixedStreamTaskInfo-task_id) | | MixedStreamPushTargetType | [push_target_type](#MixedStreamTaskInfo-push_target_type) | ## 变量说明 ### task_id ```cpp const char* bytertc::MixedStreamTaskInfo::task_id ``` 任务 ID 对于 WTN 流任务，该值代表 WTN 流 ID。你可以通过该 ID，指定需要订阅的 WTN 流。 ### push_target_type ```cpp MixedStreamPushTargetType bytertc::MixedStreamTaskInfo::push_target_type ``` 任务类型，合流转推 CDN 还是 WTN 流。 # SubscribeConfig ```cpp struct bytertc::SubscribeConfig ``` 手动订阅流的配置信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | bool | [is_screen](#SubscribeConfig-is_screen) | | bool | [sub_video](#SubscribeConfig-sub_video) | | bool | [sub_audio](#SubscribeConfig-sub_audio) | | int | [video_index](#SubscribeConfig-video_index) | | int | [priority](#SubscribeConfig-priority) | | int | [svc_layer](#SubscribeConfig-svc_layer) | | int | [framerate](#SubscribeConfig-framerate) | | int | [sub_width](#SubscribeConfig-sub_width) | | int | [sub_height](#SubscribeConfig-sub_height) | ## 变量说明 ### is_screen ```cpp bool bytertc::SubscribeConfig::is_screen = false ``` 预留字段。 ### sub_video ```cpp bool bytertc::SubscribeConfig::sub_video ``` 是否订阅视频。 ### sub_audio ```cpp bool bytertc::SubscribeConfig::sub_audio ``` 是否订阅音频。 ### video_index ```cpp int bytertc::SubscribeConfig::video_index ``` 订阅的视频流分辨率下标。用户可以通过调用 [setVideoEncoderConfig](70095#IRTCEngine-setvideoencoderconfig) 方法在一路流中发布多个不同分辨率的视频。因此订阅流时，需要指定订阅的具体分辨率。此参数即用于指定需订阅的分辨率的下标，默认值为 0 。 ### priority ```cpp int bytertc::SubscribeConfig::priority = 0 ``` 远端用户的需求优先级，参看 [RemoteUserPriority](#RemoteUserPriority)，默认值为 0 。当开启了订阅流回退选项功能（详见 [setSubscribeFallbackOption](70095#IRTCEngine-setsubscribefallbackoption) 方法），弱网或性能不足时会优先保证收到的高优先级用户的流的质量。 ### svc_layer ```cpp int bytertc::SubscribeConfig::svc_layer = 0 ``` 远端用户的时域分层，参看 [SVCLayer](#SVCLayer)，默认值为 0 。仅码流支持 SVC 特性时可以生效。 ### framerate ```cpp int bytertc::SubscribeConfig::framerate = 0 ``` 期望订阅的最高帧率，单位：fps，默认值为 0，设为大于 0 的值时开始生效。如果发布端发布帧率 \> 订阅端订阅的帧率，下行媒体服务器 SVC 丢帧，订阅端收到通过此接口设置的帧率；如果发布端发布帧率 < 订阅端订阅的帧率，则订阅端只能收到发布的帧率。仅码流支持 SVC 分级编码特性时方可生效。 ### sub_width ```cpp int bytertc::SubscribeConfig::sub_width = 0 ``` 用户通过指定 UI 对应的最合适的流的宽度，单位：px ### sub_height ```cpp int bytertc::SubscribeConfig::sub_height = 0 ``` 用户通过指定 UI 对应的最合适的流的高度，单位：px # DataMessageSourceType ```cpp enum bytertc::DataMessageSourceType ``` 数据消息来源 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kDataMessageSourceTypeDefault | 0 | 通过客户端或服务端的插入的自定义消息。 | | kDataMessageSourceTypeSystem | 1 | 系统数据，包含音量指示信息。 | # EngineConfig ```cpp struct bytertc::EngineConfig ``` 创建引擎参数 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [app_id](#EngineConfig-app_id) | | const char* | [parameters](#EngineConfig-parameters) | | const char* | [native_load_path](#EngineConfig-native_load_path) | | void* | [j_application_context](#EngineConfig-j_application_context) | | bool | [is_game_scene](#EngineConfig-is_game_scene) | ## 变量说明 ### app_id ```cpp const char* bytertc::EngineConfig::app_id = nullptr ``` 每个应用的唯一标识符。只有使用相同的 app_id 生成的实例，才能够进行音视频通信。 ### parameters ```cpp const char* bytertc::EngineConfig::parameters = nullptr ``` 如需使用请联系技术支持人员。 ### native_load_path ```cpp const char* bytertc::EngineConfig::native_load_path = nullptr ``` 自定义插件动态库加载目录，目前仅 Android 平台支持。 ### j_application_context ```cpp void* bytertc::EngineConfig::j_application_context = nullptr ``` 用于存储 Android 应用程序的上下文（Application Context），仅 Android 平台支持。 ### is_game_scene ```cpp bool bytertc::EngineConfig::is_game_scene = false ``` 是否是游戏场景。 # MouseCursorCaptureState ```cpp enum bytertc::MouseCursorCaptureState ``` 内部采集屏幕视频流时，是否采集鼠标信息。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMouseCursorCaptureStateOn | 0 | 采集鼠标信息。 | | kMouseCursorCaptureStateOff | 1 | 不采集鼠标信息。 | # VirtualBackgroundSourceType ```cpp enum bytertc::VirtualBackgroundSourceType ``` 虚拟背景类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVirtualBackgroundSourceTypeColor | 0 | 使用纯色背景替换视频原有背景。 | | kVirtualBackgroundSourceTypeImage | 1 | 使用自定义图片替换视频原有背景。 | # NetworkType ```cpp enum bytertc::NetworkType ``` SDK 网络连接类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kNetworkTypeUnknown | -1 | 网络连接类型未知。 | | kNetworkTypeDisconnected | 0 | 网络连接已断开。 | | kNetworkTypeLAN | 1 | 网络连接类型为 LAN 。 | | kNetworkTypeWIFI | 2 | 网络连接类型为 Wi-Fi（包含热点）。 | | kNetworkTypeMobile2G | 3 | 网络连接类型为 2G 移动网络。 | | kNetworkTypeMobile3G | 4 | 网络连接类型为 3G 移动网络。 | | kNetworkTypeMobile4G | 5 | 网络连接类型为 4G 移动网络。 | | kNetworkTypeMobile5G | 6 | 网络连接类型为 5G 移动网络。 | # StandardPitchInfo ```cpp struct bytertc::StandardPitchInfo ``` 标准音高数据 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [start_time](#StandardPitchInfo-start_time) | | int | [duration](#StandardPitchInfo-duration) | | int | [pitch](#StandardPitchInfo-pitch) | ## 变量说明 ### start_time ```cpp int bytertc::StandardPitchInfo::start_time ``` 开始时间，单位 ms。 ### duration ```cpp int bytertc::StandardPitchInfo::duration ``` 持续时间，单位 ms。 ### pitch ```cpp int bytertc::StandardPitchInfo::pitch ``` 音高。 # MediaPlayerCustomSourceStreamType ```cpp enum bytertc::MediaPlayerCustomSourceStreamType ``` 自定义音频流类型 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaPlayerCustomSourceStreamTypeRaw | 0 | 当播放来自本地的 PCM 数据时，使用此选项。 | | kMediaPlayerCustomSourceStreamTypeEncoded | 1 | 当播放来自内存的音频数据时，使用此选项。 | # AudioRoomConfig ```cpp struct bytertc::AudioRoomConfig ``` 多房间参数配置 ## 成员变量 | 类型 | 名称 | | --- | --- | | RoomProfileType | [room_profile_type](#AudioRoomConfig-room_profile_type) | | bool | [is_auto_subscribe_audio](#AudioRoomConfig-is_auto_subscribe_audio) | | bool | [is_auto_publish_audio](#AudioRoomConfig-is_auto_publish_audio) | ## 变量说明 ### room_profile_type ```cpp RoomProfileType bytertc::AudioRoomConfig::room_profile_type = kRoomProfileTypeCommunication ``` 房间模式，参看 [RoomProfileType](#RoomProfileType)，默认为 `kRoomProfileTypeCommunication`，进房后不可更改。 ### is_auto_subscribe_audio ```cpp bool bytertc::AudioRoomConfig::is_auto_subscribe_audio = true ``` 是否自动订阅音频流，默认为自动订阅。 ### is_auto_publish_audio ```cpp bool bytertc::AudioRoomConfig::is_auto_publish_audio = true ``` 是否自动发布音频流，默认为自动发布。 + 若调用 `setUserVisibility` 将自身可见性设为 false，无论是默认的自动发布流还是手动设置的自动发布流都不会进行发布，你需要将自身可见性设为 true 后方可发布。 + 多房间场景下，若已在其中一个房间成功设置了自动发布，其他房间的自动发布设置均不会生效。若每个房间均不做设置，则默认在第一个加入的房间内自动发布流。 # RTCRoomConfig ```cpp struct bytertc::RTCRoomConfig ``` 房间参数配置。房间是 RTC 通话的抽象概念。在同一个房间中的用户可以进行音视频通话。 ## 成员变量 | 类型 | 名称 | | --- | --- | | RoomProfileType | [room_profile_type](#RTCRoomConfig-room_profile_type) | | const char* | [stream_id](#RTCRoomConfig-stream_id) | | bool | [is_auto_publish_audio](#RTCRoomConfig-is_auto_publish_audio) | | bool | [is_auto_publish_video](#RTCRoomConfig-is_auto_publish_video) | | bool | [is_auto_subscribe_audio](#RTCRoomConfig-is_auto_subscribe_audio) | | bool | [is_auto_subscribe_video](#RTCRoomConfig-is_auto_subscribe_video) | ## 变量说明 ### room_profile_type ```cpp RoomProfileType bytertc::RTCRoomConfig::room_profile_type = kRoomProfileTypeCommunication ``` 房间模式，参看 [RoomProfileType](#RoomProfileType)，默认为 `kRoomProfileTypeCommunication`，进房后不可更改。 ### stream_id ```cpp const char* bytertc::RTCRoomConfig::stream_id = nullptr ``` 流 ID。为进房发布的流设置流 ID，可设置为空字符串。若为空，SDK 自动生成 stream_id。 ### is_auto_publish_audio ```cpp bool bytertc::RTCRoomConfig::is_auto_publish_audio = true ``` 是否自动发布音频流，默认为自动发布。 + 若调用 `setUserVisibility` 将自身可见性设为 false，无论是默认的自动发布流还是手动设置的自动发布流都不会进行发布，你需要将自身可见性设为 true 后方可发布。 + 多房间场景下，若已在其中一个房间成功设置了自动发布，其他房间的自动发布设置均不会生效。若每个房间均不做设置，则默认在第一个加入的房间内自动发布流。 ### is_auto_publish_video ```cpp bool bytertc::RTCRoomConfig::is_auto_publish_video = true ``` 是否自动发布视频流，默认为自动发布。 + 若调用 `setUserVisibility` 将自身可见性设为 false，无论是默认的自动发布流还是手动设置的自动发布流都不会进行发布，你需要将自身可见性设为 true 后方可发布。 + 多房间场景下，若已在其中一个房间成功设置了自动发布，其他房间的自动发布设置均不会生效。若每个房间均不做设置，则默认在第一个加入的房间内自动发布流。 ### is_auto_subscribe_audio ```cpp bool bytertc::RTCRoomConfig::is_auto_subscribe_audio = true ``` 是否自动订阅音频流，默认为自动订阅。 ### is_auto_subscribe_video ```cpp bool bytertc::RTCRoomConfig::is_auto_subscribe_video = true ``` 是否自动订阅视频流，默认为自动订阅。 # VideoFrameInfo ```cpp struct bytertc::VideoFrameInfo ``` 视频帧信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [width](#VideoFrameInfo-width) | | int | [height](#VideoFrameInfo-height) | | VideoRotation | [rotation](#VideoFrameInfo-rotation) | ## 变量说明 ### width ```cpp int bytertc::VideoFrameInfo::width = 0 ``` 宽（像素） ### height ```cpp int bytertc::VideoFrameInfo::height = 0 ``` 高（像素） ### rotation ```cpp VideoRotation bytertc::VideoFrameInfo::rotation = VideoRotation::kVideoRotation0 ``` 视频帧顺时针旋转角度。参看 [VideoRotation](#VideoRotation)。 # Socks5ProxyState ```cpp enum bytertc::Socks5ProxyState ``` SOCKS5 代理连接状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSocks5Init | 0 | SOCKS5 连接初始化 | | kSocks5Connected | 1 | SOCKS5 连接成功 | | kSocks5Error | 2 | SOCKS5 连接错误 | | kSocks5TcpConnectFail | 3 | TCP 连接失败 | | kSocks5TcpClose | 4 | TCP 连接关闭 | | kSocks5ProtocolTcpFail | 5 | SOCKS 协议 TCP 协商阶段失败 | | kSocks5ProtocolUdpFail | 6 | UDP 连接失败 | | kSocks5AuthFail | 7 | 授权失败 | | kSocks5Unknown | 8 | 未知状态 | # LocalVideoStreamState ```cpp enum bytertc::LocalVideoStreamState ``` 本地视频流状态 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLocalVideoStreamStateStopped | 0 | 本地视频采集停止状态 | | kLocalVideoStreamStateRecording | 1 | 本地视频采集设备启动成功 | | kLocalVideoStreamStateEncoding | 2 | 本地视频采集后，首帧编码成功 | | kLocalVideoStreamStateFailed | 3 | 本地视频采集设备启动失败 | # AudioPropertiesInfo ```cpp struct bytertc::AudioPropertiesInfo ``` 音频属性信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | int | [linear_volume](#AudioPropertiesInfo-linear_volume) | | int | [nonlinear_volume](#AudioPropertiesInfo-nonlinear_volume) | | float[SPECTRUM_SIZE] | [spectrum](#AudioPropertiesInfo-spectrum) | | int | [vad](#AudioPropertiesInfo-vad) | | double | [voice_pitch](#AudioPropertiesInfo-voice_pitch) | ## 变量说明 ### linear_volume ```cpp int bytertc::AudioPropertiesInfo::linear_volume = 0 ``` 线性音量，与原始音量呈线性关系，数值越大，音量越大。取值范围是：[0,255]。 - [0, 25]：无声 - [26, 75]：低音量 - [76, 204]：中音量 - [205, 255]：高音量 ### nonlinear_volume ```cpp int bytertc::AudioPropertiesInfo::nonlinear_volume = 0 ``` 非线性音量。由原始音量的对数值转化而来，因此在中低音量时更灵敏，可以用作 Active Speaker（房间内最活跃用户）的识别。取值范围是：[-127，0]，单位 dB。 - [-127, -60]：无声 - [-59, -40]：低音量 - [-39, -20]：中音量 - [-19, 0]：高音量 ### spectrum ```cpp float bytertc::AudioPropertiesInfo::spectrum[SPECTRUM_SIZE] = {0} ``` 频谱数组。默认长度为 257。 ### vad ```cpp int bytertc::AudioPropertiesInfo::vad = -1 ``` 人声检测（VAD）结果 - 1：检测到人声。 - 0：未检测到人声。 - -1：未开启 VAD。 ### voice_pitch ```cpp double bytertc::AudioPropertiesInfo::voice_pitch = 0 ``` 本地用户的人声基频，单位为赫兹。同时满足以下两个条件时，返回的值为本地用户的人声基频： - 调用 [enableAudioPropertiesReport](70095#IRTCEngine-enableaudiopropertiesreport)，并设置参数 enable_voice_pitch 的值为 `true`。 - 本地采集的音频中包含本地用户的人声。其他情况下返回 `0`。 # RemoteAudioStateChangeReason ```cpp enum bytertc::RemoteAudioStateChangeReason ``` 接收远端音频流状态改变的原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteAudioStateChangeReasonInternal | 0 | 内部原因 | | kRemoteAudioStateChangeReasonNetworkCongestion | 1 | 网络阻塞 | | kRemoteAudioStateChangeReasonNetworkRecovery | 2 | 网络恢复正常 | | kRemoteAudioStateChangeReasonLocalMuted | 3 | 本地用户停止接收远端音频流 | | kRemoteAudioStateChangeReasonLocalUnmuted | 4 | 本地用户恢复接收远端音频流 | | kRemoteAudioStateChangeReasonRemoteMuted | 5 | 远端用户停止发送音频流 | | kRemoteAudioStateChangeReasonRemoteUnmuted | 6 | 远端用户恢复发送音频流 | | kRemoteAudioStateChangeReasonRemoteOffline | 7 | 远端用户离开房间 | # ProblemFeedbackInfo ```cpp struct bytertc::ProblemFeedbackInfo ``` 音视频质量反馈的信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [problem_desc](#ProblemFeedbackInfo-problem_desc) | | ProblemFeedbackRoomInfo* | [room_info](#ProblemFeedbackInfo-room_info) | | int | [room_info_count](#ProblemFeedbackInfo-room_info_count) | ## 变量说明 ### problem_desc ```cpp const char* bytertc::ProblemFeedbackInfo::problem_desc = nullptr ``` 预设问题以外的其他问题的具体描述。 ### room_info ```cpp ProblemFeedbackRoomInfo* bytertc::ProblemFeedbackInfo::room_info = nullptr ``` 音视频质量反馈的房间信息。查看 [ProblemFeedbackRoomInfo](#ProblemFeedbackRoomInfo)。 ### room_info_count ```cpp int bytertc::ProblemFeedbackInfo::room_info_count = 0 ``` `FeedbackRoomInfo` 的数组长度。 # IHWDeviceContext ```cpp class bytertc::IHWDeviceContext ``` 硬件加速设备 context ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual | [~IHWDeviceContext](#IHWDeviceContext-~ihwdevicecontext) | | virtual HWDeviceType | [deviceType](#IHWDeviceContext-devicetype) | | virtual void | [setProperty](#IHWDeviceContext-setproperty) | | virtual void* | [getProperty](#IHWDeviceContext-getproperty) | | virtual bool | [ownContext](#IHWDeviceContext-owncontext) | | virtual void | [setOwnContext](#IHWDeviceContext-setowncontext) | | virtual IHWDeviceContext* | [moveContext](#IHWDeviceContext-movecontext) | | virtual void | [release](#IHWDeviceContext-release) | ## 函数说明 ### ~IHWDeviceContext ```cpp virtual ~IHWDeviceContext() = default; ``` ### deviceType ```cpp virtual HWDeviceType deviceType() const = 0; ``` 获取硬件加速设备 context 类型 **返回值** 硬件加速设备类型，详见 [HWDeviceType](#HWDeviceType) ### setProperty ```cpp virtual void setProperty( HWDeviceContextKey key, void* value ) = 0; ``` 设置属性 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | HWDeviceContextKey | 硬件加速设备 context 类型，详见 [HWDeviceContextKey](#HWDeviceContextKey) | | value | void* | 指向硬件加速设备 context 地址的指针 | ### getProperty ```cpp virtual void* getProperty(HWDeviceContextKey key) = 0; ``` 获取属性 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | HWDeviceContextKey | 硬件加速设备 context 类型，详见 [HWDeviceContextKey](#HWDeviceContextKey) | **返回值** 返回硬件加速设备 context 地址的指针 ### ownContext ```cpp virtual bool ownContext() const = 0; ``` 内部 context 是否由该实例拥有 **返回值** - true：硬件设备 context 被实例对象拥有 - false：硬件设备上 context 文不被实例对象拥有 ### setOwnContext ```cpp virtual void setOwnContext(bool own_context) = 0; ``` 设置 context 是否被实例对象拥有 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | own_context | bool |

true：context 被实例对象拥有
false：context 不被实例对象拥有

| ### moveContext ```cpp virtual IHWDeviceContext* moveContext() = 0; ``` 转移硬件设备 context， **返回值** 指向硬件设备 context 的指针 ### release ```cpp virtual void release() = 0; ``` 释放实例对象 # PerformanceAlarmReason ```cpp enum bytertc::PerformanceAlarmReason ``` 性能相关告警的原因 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kPerformanceAlarmReasonBandwidthFallbacked | 0 | 网络原因差，造成了发送性能回退。仅在开启发送性能回退时，会收到此原因。 | | kPerformanceAlarmReasonBandwidthResumed | 1 | 网络性能恢复，发送性能回退恢复。仅在开启发送性能回退时，会收到此原因。 | | kPerformanceAlarmReasonPerformanceFallbacked | 2 | 如果未开启发送性能回退，收到此告警时，意味着性能不足；

如果开启了发送性能回退，收到此告警时，意味着性能不足，且已发生发送性能回退。 | | kPerformanceAlarmReasonPerformanceResumed | 3 | 如果未开启发送性能回退，收到此告警时，意味着性能不足已恢复；

如果开启了发送性能回退，收到此告警时，意味着性能不足已恢复，且已发生发送性能回退恢复。 | # JoinRoomType ```cpp enum bytertc::JoinRoomType ``` 用户加入房间的类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kJoinRoomTypeFirst | 0 | 首次加入房间。用户手动调用 `joinRoom` 加入房间。 | | kJoinRoomTypeReconnected | 1 | 重新加入房间。用户网络较差，失去与服务器的连接，进行重连时收到加入成功。 | # ForwardStreamStateInfo ```cpp struct bytertc::ForwardStreamStateInfo ``` 跨房间转发媒体流过程中的不同目标房间的状态和错误信息 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [room_id](#ForwardStreamStateInfo-room_id) | | ForwardStreamState | [state](#ForwardStreamStateInfo-state) | | ForwardStreamError | [error](#ForwardStreamStateInfo-error) | ## 变量说明 ### room_id ```cpp const char* bytertc::ForwardStreamStateInfo::room_id ``` 跨间转发媒体流过程中目标房间 ID ### state ```cpp ForwardStreamState bytertc::ForwardStreamStateInfo::state ``` 跨房间转发媒体流过程中该目标房间的状态，参看 [ForwardStreamState](#ForwardStreamState) ### error ```cpp ForwardStreamError bytertc::ForwardStreamStateInfo::error ``` 跨房间转发媒体流过程中该目标房间抛出的错误码，参看 [ForwardStreamError](#ForwardStreamError) # ScreenFilterConfig ```cpp struct bytertc::ScreenFilterConfig ``` 抓取屏幕时排除指定窗口，默认不排除任何窗体。 ## 成员变量 | 类型 | 名称 | | --- | --- | | view_t* | [excluded_window_list](#ScreenFilterConfig-excluded_window_list) | | int | [excluded_window_num](#ScreenFilterConfig-excluded_window_num) | ## 变量说明 ### excluded_window_list ```cpp view_t* bytertc::ScreenFilterConfig::excluded_window_list = nullptr ``` 抓取屏幕时排除窗口列表。这个参数仅在抓取屏幕时生效。 ### excluded_window_num ```cpp int bytertc::ScreenFilterConfig::excluded_window_num = 0 ``` 排除窗口的数量。 # RemoteStreamStats ```cpp struct bytertc::RemoteStreamStats ``` 用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s 。订阅远端用户发布音/视频流成功后，SDK 会周期性地通过 `onRemoteStreamStats` 通知本地用户订阅的远端音/视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 ## 成员变量 | 类型 | 名称 | | --- | --- | | const char* | [uid](#RemoteStreamStats-uid) | | RemoteAudioStats | [audio_stats](#RemoteStreamStats-audio_stats) | | RemoteVideoStats | [video_stats](#RemoteStreamStats-video_stats) | | bool | [is_screen](#RemoteStreamStats-is_screen) | | NetworkQuality | [deprecated] [remote_tx_quality](#RemoteStreamStats-remote_tx_quality) | | NetworkQuality | [deprecated] [remote_rx_quality](#RemoteStreamStats-remote_rx_quality) | ## 变量说明 ### uid ```cpp const char* bytertc::RemoteStreamStats::uid ``` 用户 ID 。音/视频来源的远端用户 ID 。 ### audio_stats ```cpp RemoteAudioStats bytertc::RemoteStreamStats::audio_stats ``` 远端音频流的统计信息，详见 [RemoteAudioStats](#RemoteAudioStats) ### video_stats ```cpp RemoteVideoStats bytertc::RemoteStreamStats::video_stats ``` 远端视频流的统计信息，详见 [RemoteVideoStats](#RemoteVideoStats) ### is_screen ```cpp bool bytertc::RemoteStreamStats::is_screen ``` 预留字段。 ### remote_tx_quality ```cpp NetworkQuality bytertc::RemoteStreamStats::remote_tx_quality ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onNetworkQuality](70096#IRTCRoomEventHandler-onnetworkquality) instead. 所属用户的媒体流上行网络质量，详见 [NetworkQuality](#NetworkQuality) ### remote_rx_quality ```cpp NetworkQuality bytertc::RemoteStreamStats::remote_rx_quality ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onNetworkQuality](70096#IRTCRoomEventHandler-onnetworkquality) instead. 所属用户的媒体流下行网络质量，详见 [NetworkQuality](#NetworkQuality)

实时音视频