api/bytertc_video_defines library

Copyright (c) 2026 Beijing Volcano Engine Technology Ltd.

Classes

AudioPropertiesConfig
@detail keytype @brief 音频属性信息提示的相关配置
AudioPropertiesInfo
@detail keytype @brief 音频属性信息
AudioRecordingConfig
@detail keytype @brief 音频录制配置
FaceDetectionResult
@detail keytype @brief 人脸检测结果
LocalAudioPropertiesInfo
@detail keytype @brief 本地音频属性信息
LocalSnapshot
@brief 本地截图
MediaTypeEnhancementConfig
@detail keytype @brief 蜂窝网络辅助增强应用的媒体模式
MixedStreamLayoutRegionImageWaterMarkConfig
@detail keytype @brief 图片合流相关参数。
PositionInfo
@detail keytype @brief 用户在空间音频坐标系里的位置信息。
ReceiveRange
@detail keytype @brief 本地用户能收听到、且具有衰减效果的音频接收范围
Rectangle
@detail keytype @brief 矩形区域
RemoteAudioPropertiesInfo
@detail keytype @brief 远端音频属性信息
RemoteSnapshot
@brief 远端截图
RemoteStreamSwitch
@detail keytype @author panjian.fishing @brief 流切换信息。本地用户订阅的远端流触发回退策略时的流切换信息。
RemoteVideoConfig
@detail keytype @brief 远端视频帧信息
RTCVideoContext
@brief 引擎初始化参数
SourceCrop
@detail keytype @brief WTN 流布局中的视频裁剪参数。
SourceWantedData
@detail keytype @brief 性能回退相关数据
StreamInfo
@detail keytype @brief 远端流信息。
StreamSyncInfoConfig
@brief 媒体流信息同步的相关配置
SubscribeConfig
@detail keytype @brief 选择订阅配置
VideoCaptureConfig
@detail keytype @brief 视频采集配置
VideoEncoderConfig
@detail keytype @brief 视频流参数描述
VideoFrameInfo
@detail keytype @brief 视频帧信息
VirtualBackgroundSource
@brief 背景贴纸对象。
VoiceEqualizationConfig
@detail keytype @brief 语音均衡效果。
VoiceReverbConfig
@detail keytype @brief 音频混响效果。
Watermark
@brief 水印图片相对视频流的位置和大小。
WatermarkConfig
@brief 水印参数

Enums

AACProfile
@brief AAC 编码类型
AnsMode
{zh} * @detail keytype @brief 降噪模式。降噪算法受调用 joinRoom{@link #RTCRoom#joinRoom} 时设置的房间模式影响。
AttenuationType
{zh} * @detail keytype @brief 空间音频音量随距离衰减模式
AudioAlignmentMode
{zh} * @detail keytype @brief 远端音频流精准对齐模式
AudioChannel
{zh} * @detail keytype @brief 音频声道。
AudioDeviceType
{zh} * @detail keytype @brief 音频设备类型
AudioFrameSource
{zh} * @detail keytype @brief 音频文件录制内容来源。
AudioMixingType
{zh} * @detail keytype @brief 混音播放类型
AudioProfileType
{zh} * @detail keytype @brief 音质档位
AudioPropertiesMode
{zh} * @detail keytype @brief onLocalAudioPropertiesReport{@link #IRTCEngineEventHandler#onLocalAudioPropertiesReport} 中包含的音频信息的范围。
AudioQuality
{zh} * @detail keytype @brief 音频质量。
AudioRecordingErrorCode
{zh} * @detail errorcode @brief 音频文件录制的错误码
AudioRecordingState
{zh} * @detail keytype @brief 录音配置
AudioReportMode
{zh} * @detail keytype @brief 音量回调模式。
AudioRoute
{zh} * @detail keytype @brief 音频播放路由
AudioSampleRate
{zh} * @detail keytype @brief 音频采样率,单位为 Hz。
AudioScenarioType
{zh} * @detail keytype @brief 音频场景类型。
选择音频场景后,SDK 会根据操作系统和开麦、闭麦状态,应用通话音量或媒体音量。参看通话音量与媒体音量了解更多相关信息。
你可以调用 setAudioScenario 设置音频场景。
CameraId
{zh} * @detail keytype @brief 摄像头类型
CapturePreference
{zh} * @detail keytype @brief 视频采集模式
EarMonitorAudioFilter
{zh} * @detail keytype @brief 耳返音频是否经过本地音频处理。
EarMonitorMode
{zh} * @detail keytype @brief 是否开启耳返功能。
EffectBeautyMode
{zh} * @detail keytype @brief 基础美颜模式。
MediaStreamType
{zh} * @detail keytype @brief 媒体流类型
MirrorType
{zh} * @detail keytype @brief 镜像类型
MixedStreamAlternateImageFillMode
{zh} * @detail keytype @brief 服务端合流占位图填充模式。
MixedStreamAudioCodecType
{zh} * @detail keytype @brief 音频编码格式。当前只有一个值为 0,代表 AAC。
MixedStreamAudioProfile
{zh} * @detail keytype @brief AAC 编码规格。
MixedStreamLayoutRegionType
{zh} * @detail keytype @brief 合流布局区域类型
MixedStreamMediaType
{zh} * @detail keytype @brief 合流输出媒体类型。
MixedStreamPushMode
{zh} * @detail keytype @brief 服务端合流转推发起模式。
MixedStreamRenderMode
{zh} * @detail keytype @brief 图片或视频流的缩放模式。
MixedStreamSEIContentMode
{zh} * @detail keytype @brief 服务端合流转推 SEI 内容。
MixedStreamVideoCodecType
{zh} * @detail keytype @brief 视频编码格式。
MixedStreamVideoType
{zh} * @detail keytype @brief Region 中流的类型属性
PauseResumeControlMediaType
{zh} * @detail keytype @brief 暂停/恢复接收远端的媒体流类型。
PlayerError
{zh} * @detail keytype @brief 播放错误码。
PlayerState
{zh} * @detail keytype @brief 播放状态。
RecordingType
{zh} * @detail keytype @brief 本地录制的媒体类型
RemoteMirrorType
{zh} * @detail keytype @brief 远端流的镜像类型。
ScreenMediaType
{zh} * @detail keytype @brief 屏幕采集媒体类型
SubscribeFallbackOptions
{zh} * @detail keytype @brief 订阅端音视频流回退选项。
TorchState
{zh} * @detail keytype @brief 相机闪光灯状态
VideoDenoiseMode
{zh} * @hidden for internal use @detail keytype @brief 视频降噪模式。
VideoDeviceType
{zh} * @detail keytype @brief 当前视频设备类型
VideoEncoderPreference
{zh} * @detail keytype @brief 编码策略偏好。
VideoOrientation
{zh} * @detail keytype @brief 视频帧朝向
VideoRenderMode
VideoRotation
{zh} * @detail keytype @brief 视频帧旋转角度
VideoRotationMode
{zh} * @detail keytype @brief 视频旋转模式
VideoSimulcastMode
{zh} * @detail keytype @brief 发布大小流模式
VideoSuperResolutionMode
{zh} * @detail keytype @hidden for internal use @brief 超分模式。
VideoSuperResolutionModeChangedReason
{zh} * @hidden for internal use only @detail keytype @brief 超分状态改变原因。
VirtualBackgroundSourceType
{zh} * @detail keytype @brief 虚拟背景类型。
VoiceChangerType
{zh} * @detail keytype @brief 变声特效类型。如需更多变声特效类型,联系技术支持。
VoiceEqualizationBandFrequency
{zh} * @detail keytype @brief 音频均衡效果。
VoiceReverbType
{zh} * @detail keytype @brief 混响特效类型。
ZoomConfigType
{zh} * @detail keytype @brief 数码变焦参数类型
ZoomDirectionType
{zh} * @detail keytype @brief 数码变焦操作类型