ERTC SDK 类型定义-Windows.md

ERTC 类型定义

枚举定义

ERTCLogLevel

日志级别

类型描述
ERTCLogLevelNone不输出任何 SDK Log
ERTCLogLevelError输出ERROR 级别的 Log
ERTCLogLevelWarn输出WARN 级别的 Log
ERTCLogLevelInfo输出INFO 级别的 Log
ERTCLogLevelDebug输出Debug 级别的 Log
ERTCLogLevelTrace输出TRACE 级别的 Log

ERTCVideoStreamType

视频流类型

类型描述
ERTCVideoStreamTypeBig高清大画面,一般用来传输摄像头的视频数据
ERTCVideoStreamTypeSmall低清小画面:小画面和大画面的内容相互,但是分辨率和码率都比大画面低,因此清晰度也更低
ERTCVideoStreamTypeSub辅流画面:一般用于屏幕分享,同一时间在同一个房间中只允许一个用户发布辅流视频,其他用户必须要等该用户关闭之后才能发布自己的辅流。

ERTCVideoResolution

视频分辨率

类型描述
ERTCVideoResolution_120_120宽高比 1:1;分辨率 120x120;建议码率(VideoCall)80kbps; 建议码率(LIVE)120kbps
ERTCVideoResolution_160_160宽高比 1:1;分辨率 160x160;建议码率(VideoCall)80kbps; 建议码率(LIVE)120kbps
ERTCVideoResolution_270_270宽高比 1:1;分辨率 270x270;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps
ERTCVideoResolution_480_480宽高比 1:1;分辨率 480x480;建议码率(VideoCall)350kbps; 建议码率(LIVE)500kbps
ERTCVideoResolution_160_120宽高比4:3;分辨率 160x120;建议码率(VideoCall)100kbps; 建议码率(LIVE)150kbps
ERTCVideoResolution_240_180宽高比 4:3;分辨率 240x180;建议码率(VideoCall)150kbps; 建议码率(LIVE)250kbps
ERTCVideoResolution_280_210宽高比 4:3;分辨率 280x210;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps
ERTCVideoResolution_320_240宽高比 4:3;分辨率 320x240;建议码率(VideoCall)250kbps; 建议码率(LIVE)375kbps
ERTCVideoResolution_400_300宽高比 4:3;分辨率 400x300;建议码率(VideoCall)300kbps; 建议码率(LIVE)450kbps
ERTCVideoResolution_480_360宽高比 4:3;分辨率 480x360;建议码率(VideoCall)400kbps; 建议码率(LIVE)600kbps
ERTCVideoResolution_640_480宽高比 4:3;分辨率 640x480;建议码率(VideoCall)600kbps; 建议码率(LIVE)900kbps
ERTCVideoResolution_960_720宽高比 4:3;分辨率 960x720;建议码率(VideoCall)1000kbps; 建议码率(LIVE)1500kbps
ERTCVideoResolution_160_90宽高比 16:9;分辨率 160x90;建议码率(VideoCall)150kbps; 建议码率(LIVE)250kbps
ERTCVideoResolution_256_144宽高比 16:9;分辨率 256x144;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps
ERTCVideoResolution_320_180宽高比 16:9;分辨率 320x180;建议码率(VideoCall)250kbps; 建议码率(LIVE)400kbps
ERTCVideoResolution_480_270宽高比 16:9;分辨率 480x270;建议码率(VideoCall)350kbps; 建议码率(LIVE)550kbps
ERTCVideoResolution_640_360宽高比 16:9;分辨率 640x360;建议码率(VideoCall)500kbps; 建议码率(LIVE)900kbps
ERTCVideoResolution_960_540宽高比 16:9;分辨率 960x540;建议码率(VideoCall)850kbps; 建议码率(LIVE)1300kbps
ERTCVideoResolution_1280_720宽高比 16:9;分辨率 1280x720;建议码率(VideoCall)1200kbps; 建议码率(LIVE)1800kbps
ERTCVideoResolution_1920_1080宽高比 16:9;分辨率 1920x1080;建议码率(VideoCall)2000kbps; 建议码率(LIVE)3000kbps

ERTCVideoFPS

视频帧率

类型描述
ERTCVideoFPS_11 fps
ERTCVideoFPS_55 fps
ERTCVideoFPS_1010 fps
ERTCVideoFPS_1111 fps
ERTCVideoFPS_1212 fps
ERTCVideoFPS_1313 fps
ERTCVideoFPS_1414 fps
ERTCVideoFPS_1515 fps
ERTCVideoFPS_1616 fps
ERTCVideoFPS_1717 fps
ERTCVideoFPS_1818 fps
ERTCVideoFPS_1919 fps
ERTCVideoFPS_2020 fps
ERTCVideoFPS_2525 fps
ERTCVideoFPS_3030 fps
ERTCVideoFPS_6060 fps

ERTCVideoFillMode

视频画面填充模式

类型描述
ERTCVideoFillMode_Fill填充模式:即将画面内容居中等比缩放以充满整个显示区域,超出显示区域的部分将会被裁剪掉,此模式下画面可能不完整
ERTCVideoFillMode_Fit适应模式:即按画面长边进行缩放以适应显示区域,短边部分会被填充为黑色,此模式下图像完整但可能留有黑边

ERTCVideoMirrorType

视频的镜像类型

类型描述
ERTCVideoMirrorType_Auto自动模式
ERTCVideoMirrorType_Enable强制开启镜像
ERTCVideoMirrorType_Disable强制关闭镜像

ERTCQuality

网络质量

类型描述
ERTCQuality_Unknown未定义
ERTCQuality_Excellent当前网络非常好
ERTCQuality_Good当前网络比较好
ERTCQuality_Poor当前网络一般
ERTCQuality_Bad当前网络较差
ERTCQuality_Vbad当前网络很差
ERTCQuality_Down当前网络不满足 TRTC 的最低要求
ERTCQuality_Unsupported暂时无法检测到网络质量
ERTCQuality_Detecting网络质量检测已开始还没有完成

ERTCConfigKey

配置类型

类型描述
ERTCConfigQualityInterval质量数据上抛时间间隔
ERTCConfigInputVideoFilter本地视频采集处理设置,#ERTCVideoFilter
ERTCConfigPlayVideoFilter远端视频播放处理设置
ERTCConfigServerLineId配置服务器线路选择(建议在初始化前设置),#ERTCServerLineID

常用结构

ERTCLogConfig

日志配置信息

字段名类型说明
filePathchar*码流文件存储路径
levelERTCLogLevel日志级别

ERTCEngineContext

初始化配置

字段名类型说明
appIdchar*应用标识
logConfigERTCLogConfig日志配置

ERTCParams

进房参数

字段名类型说明
userIdchar*用户标识
roomIdchar*字符串房间号
tokenchar*用户签名

ERTCVideoEncParam

视频编码参数

字段名类型说明
videoResolutionERTCVideoResolution视频分辨率 如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如: 640 × 360 + Portrait = 360 × 640
videoFpsERTCVideoFPS视频采集帧率 15fps或20fps。5fps以下,卡顿感明显。10fps以下,会有轻微卡顿感。20fps以上,会浪费带宽(电影的帧率为24fps)
videoBitrateunsigned int目标视频码率,单位Kbps,SDK 会按照目标码率进行编码,只有在弱网络环境下才会主动降低视频码率

ERTCVolumeInfo

音量大小

字段名类型说明
userIdstring说话者的 userId
volumeuint32_t说话者的音量大小, 取值范围[0 - 100]

ERTCLocalVideoStats

本地视频质量数据

字段名类型说明
sentBitrateuint32_t视频传输码率(上行)
frameRateuint32_t帧率大小
packetLossRateuint16_t视频丢包率
streamTypeERTCVideoStreamType流类型 0:大码流 1:小码流 2:屏幕共享流
widthuint32_t视频宽
heightuint32_t视频高
totalPacketCountuint32_t发视频总包数
compensateLossRateuint16_t补偿后丢包率

ERTCLocalAudioStats

本地音频质量数据

字段名类型说明
sentBitrateuint32_t音频传输码率
packetLossRateuint16_t音频丢包率
totalPacketCountuint32_t发音频总包数

ERTCRemoteVideoStats

远端视频质量数据

字段名类型说明
userIdstring远端视频用户ID
receivedBitrateuint32_t远端视频传输码率(下行)
frameRateuint32_t远端帧率大小
totalFrozenTimeuint32_t远端视频总的卡顿时长
videoFrozenRateint32_t远端视频卡顿比
packetLossRateuint16_t视频丢包率
streamTypeERTCVideoStreamType流类型 0:大码流 1:小码流 2:屏幕共享流
widthuint32_t视频宽
heightuint32_t视频高
videoPacketCountint32_t接收视频总包数
uncompensateLossuint16_t视频补偿前丢包率(%)

ERTCRemoteAudioStatistics

远端音频实时数据

字段名类型说明
userIdstring远端音频用户ID
receivedBitrateuint32_t远端音频传输码率(下行)
packetLossRateuint32_t远端音频丢包率(下行)
totalFrozenTimeuint32_t远端音频总的卡顿时长
totalFrozenTimeuint32_t远端音频卡顿比
totalPacketCountint32_t接收音频总包数
plcPacketCountuint32_t音频帧补偿数量
uncompensateLossuint32_t音频补偿前丢包率(%)
totalTimeuint32_t播放音频总时间

ERTCSpeedTestParams

测速参数

字段名类型说明
expectedUpBandwidthuint32_t预期的上行带宽(kbps,取值范围: 10 ~ 5000,为 0 时不测试)
expectedDownBandwidthuint32_t预期的下行带宽(kbps,取值范围: 10 ~ 5000,为 0 时不测试)
testIntervaluint32_t测试时间间隔(统计间隔(毫秒),取值范围1000ms~60000ms)

ERTCSpeedTestResult

网络测速结果

字段名类型说明
successBOOL测试是否成功
qualityERTCQuality网络质量
upLostRateuint32_t上行丢包率,取值范围是 [0 - 100],例如 30% 表示每向服务器发送 10 个数据包可能会在中途丢失 3 个
downLostRateuint32_t下行丢包率,取值范围是 [0 - 100],例如 20% 表示每从服务器收取 10 个数据包可能会在中途丢失 2 个
rttint32_t延迟(毫秒),指当前设备到 服务器的一次网络往返时间,该值越小越好,正常数值范围是10ms - 100ms
availableUpBandwidthint上行带宽(kbps,-1:无效值)
availableDownBandwidthint下行带宽(kbps,-1:无效值)

萤石致力于成为全球领先的智能视觉物联网服务商,构建了全球领先的视觉物联网云平台,打造了硬件产品+软件云服务一体化的物联网服务体系。萤石云通过构建多数据中心+就近服务点的方式服务于全球客户。截至2025 年底,萤石物联网云平台在全球拥有超过120 个数据站点,平台上的IoT 设备接入数超过3.6 亿,其中视频类设备超过3 亿。在夯实自身平台能力的基础上,萤石进一步开放技术能力,将物联价值延伸至千行百业。萤石开放平台深度融合AI中台能力,涵盖音视频多媒体、消息通知处理、智能算法调度、视频存储备份、ERTC、大数据、物联接入等,已为智慧连锁、智慧养老、文教娱乐、畜牧养殖等42万余位行业客户提供数智化转型升级支撑;萤石物联专有云支持专有化部署,助力中大型企业和组织的数字化转型升级。

Logo

火山引擎视频云技术社区,是面向 AI 音视频开发者的技术交流平台。这里汇聚源自抖音、豆包等亿级 DAU 产品的 RTC、直播、点播、AI 媒体处理、音视频互动技术,提供接入指南、最佳实践、性能调优、场景案例、Demo 代码、开源项目、白皮书和 API 文档。社区汇聚官方工程师与一线开发者,为 AI 视频通话、数字人、AI 视频处理等应用的开发与落地提供技术支持。

更多推荐