api/bytertc_defines library
Copyright (c) 2026 Beijing Volcano Engine Technology Ltd.
Classes
- AudioFormat
- @detail keytype @brief 音频参数格式
- AudioFrame
- @detail keytype @brief PCM 音频帧
- AudioPropertiesConfig
- @detail keytype @brief 音频属性信息提示的相关配置
- AudioPropertiesInfo
- @detail keytype @brief 音频属性信息
- AudioRecordingConfig
- @detail keytype @brief 音频录制配置
- CloudProxyInfo
- @detail keytype @brief 云代理信息
- DestInfo
- @detail keytype @brief 转发目标房间信息，用于指定将媒体流转发到哪个房间以及在该房间中的用户身份。
- EchoTestConfig
- FaceDetectionResult
- @detail keytype @brief 人脸检测结果
- ForwardStreamEventInfo
- @detail keytype @brief 跨房间转发媒体流过程中的不同目标房间发生的事件
- ForwardStreamInfo
- @detail keytype @brief 媒体流跨房间转发的目标房间的相关信息
- ForwardStreamStateInfo
- @detail keytype @brief 跨房间转发媒体流过程中的不同目标房间的状态和错误信息
- HumanOrientation
- @detail keytype @brief 三维朝向信息，三个向量需要两两垂直。参看 Orientation{@link #Orientation}。
- IAudioFrameObserver
-
@detail callback
@brief 音频数据回调观察者
注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。
本接口类中的回调周期均为 20 ms。 - LocalAudioPropertiesInfo
- @detail keytype @brief 本地音频属性信息
- LocalAudioStats
-
@detail keytype
@brief 本地音频流统计信息，统计周期为 2s 。
本地用户发布音频流成功后，SDK 会周期性地通过onLocalStreamStats通知用户发布的音频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 - LocalProxyConfiguration
- @detail keytype @brief 本地代理配置详细信息。
- LocalSnapshot
- @brief 本地截图
- LocalStreamStats
-
@detail keytype
@brief 本地音/视频流统计信息，统计周期为 2s 。
本地用户发布音/视频流成功后，SDK 会周期性地通过onLocalStreamStats通知本地用户发布的音/视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 - LocalVideoStats
-
@detail keytype
@brief 本地视频流统计信息，统计周期为 2s 。
本地用户发布视频流成功后，SDK 会周期性地通过onLocalStreamStats
通知用户发布的视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 - MediaTypeEnhancementConfig
- @detail keytype @brief 蜂窝网络辅助增强应用的媒体模式
- MixedStreamAudioConfig
- @brief 合流音频配置.
- MixedStreamConfig
- @brief 合流转推配置参数。 如无特别说明，参数可适用于 WTN 流和合流转推任务。 如无特别说明，参数可用于启动和更新任务。
- MixedStreamControlConfig
- @detail keytype @brief 服务端合流控制参数。
- MixedStreamLayoutRegionConfig
- @brief 单个图片或视频流在合流中的布局信息。 开启转推直播功能后，在多路视频流合流时，你可以设置其中一路视频流在合流中的预设布局信息。
- MixedStreamLayoutRegionImageWaterMarkConfig
- @detail keytype @brief 图片合流相关参数。
- MixedStreamPushTargetConfig
- @brief 合流任务配置
- MixedStreamSpatialAudioConfig
- @brief 空间音频配置
- MixedStreamTaskInfo
-
@detail keytype
@brief WTN 流任务详情
- MixedStreamVideoConfig
- @brief 合流视频配置.
- NetworkQualityStats
- @detail keytype @brief 上行/下行网络质量
- NetworkTimeInfo
- @detail keytype @brief 网络时间信息
- Position
- @detail keytype @brief 本地用户在房间内的位置坐标，需自行建立空间直角坐标系
- PositionInfo
- @detail keytype @brief 用户在空间音频坐标系里的位置信息。
- ProblemFeedbackInfo
- @detail keytype @brief 通话质量反馈信息
- ProblemFeedbackRoomInfo
- @detail keytype @brief 通话质量反馈中的房间信息
- ReceiveRange
- @detail keytype @brief 本地用户能收听到、且具有衰减效果的音频接收范围
- RecordingConfig
- @detail keytype @brief 本地录制参数配置
- RecordingInfo
- @detail keytype @brief 本地录制的详细信息
- RecordingProgress
- @detail keytype @brief 本地录制进度
- Rectangle
- @detail keytype @brief 矩形区域
- RemoteAudioPropertiesInfo
- @detail keytype @brief 远端音频属性信息
- RemoteAudioStats
-
@detail keytype
@brief 远端音频流统计信息，统计周期为 2s。
本地用户订阅远端音频流成功后，SDK 会周期性地通过onRemoteStreamStats通知本地用户订阅的音频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 - RemoteSnapshot
- @brief 远端截图
- RemoteStreamKey
- @detail keytype @brief 远端流信息。
- RemoteStreamStats
-
@detail keytype
@brief 用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s 。
订阅远端用户发布音/视频流成功后，SDK 会周期性地通过onRemoteStreamStats通知本地用户订阅的远端音/视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 - RemoteStreamSwitch
- @detail keytype @author panjian.fishing @brief 流切换信息。本地用户订阅的远端流触发回退策略时的流切换信息。
- RemoteVideoConfig
- @detail keytype @brief 远端视频帧信息
- RemoteVideoStats
-
@detail keytype
@brief 远端视频流统计信息，统计周期为 2s 。
本地用户订阅远端视频流成功后，SDK 会周期性地通过onRemoteStreamStats
通知本地用户订阅的远端视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 - RTCLogConfig
- @detail keytype @brief 本地日志参数。
- RTCOrientation
- @detail keytype @brief 方向朝向信息
- RTCRoomStats
- @detail keytype @brief 通话相关的统计信息
- RTCVideoContext
- @brief 引擎初始化参数
- SourceCrop
- @detail keytype @brief WTN 流布局中的视频裁剪参数。
- SourceWantedData
- @detail keytype @brief 性能回退相关数据
- StreamInfo
- @detail keytype @brief 远端流信息。
- StreamSyncInfoConfig
- @brief 媒体流信息同步的相关配置
- SubscribeConfig
- @detail keytype @brief 选择订阅配置
- SubtitleConfig
- @detail keytype @brief 字幕配置信息。
- SubtitleMessage
- @detail keytype @brief 字幕具体内容。
- SysStats
- @detail keytype @brief CPU 和内存统计信息
- UserInfo
- @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 音频设备类型
- AudioFrameCallbackMethod
- {zh} * @detail keytype @brief 音频回调方法
- AudioFrameSource
- {zh} * @detail keytype @brief 音频文件录制内容来源。
- AudioMixingDualMonoMode
- {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设置音频场景。 - AudioSelectionPriority
- {zh} * @detail keytype @brief 音频选路优先级设置
- AVSyncState
- {zh} * @detail keytype @brief 音视频同步状态
- BluetoothMode
- @brief 蓝牙传输协议 @note 仅 iOS 适用。
- CameraId
- {zh} * @detail keytype @brief 摄像头类型
- CapturePreference
- {zh} * @detail keytype @brief 视频采集模式
- DataMessageSourceType
- {zh} * @detail keytype @brief 数据消息来源
- EarMonitorAudioFilter
- {zh} * @detail keytype @brief 耳返音频是否经过本地音频处理。
- EarMonitorMode
- {zh} * @detail keytype @brief 是否开启耳返功能。
- EchoTestResult
- {zh} * @detail keytype @brief 音视频回路测试结果
- EffectBeautyMode
- {zh} * @detail keytype @brief 基础美颜模式。
- EncryptType
- @brief 自定义加密类型
- ErrorCode
-
{zh}
* @detail errorcode
@brief 回调错误码。
SDK 内部遇到不可恢复的错误时，会通过onError回调通知用户。 - FallbackOrRecoverReason
- {zh} * @detail keytype @brief 远端订阅流发生回退或恢复的原因
- FirstFramePlayState
- {zh} * @detail keytype @brief 首帧播放状态
- FirstFrameSendState
- {zh} * @detail keytype @brief 首帧发送状态
- ForwardStreamError
- {zh} * @detail keytype @brief 媒体流跨房间转发过程中抛出的错误码
- ForwardStreamEvent
- {zh} * @detail keytype @brief 跨房间转发媒体流过程中该目标房间发生的事件
- ForwardStreamState
- {zh} * @detail keytype @brief 媒体流跨房间转发状态
- HardwareEchoDetectionResult
- {zh} * @detail keytype @brief 通话前回声检测结果
- InterpolationMode
- {zh} * @detail keytype @brief WTN 流的补帧模式
- LocalAudioStreamError
- {zh} * @detail keytype @brief 本地音频流状态改变时的错误码。
- LocalAudioStreamState
-
{zh}
* @detail keytype
@brief 本地音频流状态。
SDK 通过 onLocalAudioStateChanged 回调该状态。 - LocalLogLevel
- {zh} * @detail keytype @brief 本地日志输出等级。
- LocalProxyError
- {zh} * @detail keytype @brief 本地代理错误。
- LocalProxyState
- {zh} * @detail keytype @brief 本地代理连接状态。
- LocalProxyType
- {zh} * @detail keytype @brief 本地代理的类型。
- LocalVideoStreamError
- {zh} * @detail keytype @brief 本地视频状态改变时的错误码
- LocalVideoStreamState
- {zh} * @detail keytype @brief 本地视频流状态
- LoginErrorCode
-
{zh}
* @detail errorcode
@brief 登录结果
调用login登录的结果，会通过onLoginResult回调通知用户。 - LogoutReason
- {zh} * @detail keytype @brief 用户登出的原因
- MediaDeviceError
- {zh} * @detail keytype @brief 媒体设备错误类型
- MediaDeviceState
-
{zh}
* @detail keytype
@brief 媒体设备状态
通过onAudioDeviceStateChanged/onVideoDeviceStateChanged回调设备状态。 - MediaDeviceWarning
- {zh} * @detail keytype @brief 媒体设备警告
- MediaStreamType
- {zh} * @detail keytype @brief 媒体流类型
- MessageConfig
- {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 服务端合流转推发起模式。
- MixedStreamPushTargetType
- {zh} * @detail keytype @brief 任务类型
- MixedStreamRenderMode
- {zh} * @detail keytype @brief 图片或视频流的缩放模式。
- MixedStreamSEIContentMode
- {zh} * @detail keytype @brief 服务端合流转推 SEI 内容。
- MixedStreamTaskErrorCode
- {zh} * @detail errorcode @brief 合流任务错误码
- MixedStreamTaskEvent
- {zh} * @detail keytype @brief 转推直播任务状态
- MixedStreamVideoCodecType
- {zh} * @detail keytype @brief 视频编码格式。
- MixedStreamVideoType
- {zh} * @detail keytype @brief Region 中流的类型属性
- NetworkDetectionLinkType
-
{zh}
* @detail keytype
@brief 通话前探测链接的类型。
onNetworkDetectionResult回调的参数类型 - NetworkDetectionStopReason
-
{zh}
* @detail keytype
@brief 通话前探测的停止原因。
onNetworkDetectionStopped回调的参数类型 - NetworkQuality
- {zh} * @detail keytype @brief 所属用户的媒体流网络质量。
- NetworkType
- PauseResumeControlMediaType
- {zh} * @detail keytype @brief 暂停/恢复接收远端的媒体流类型。
- PerformanceAlarmMode
- {zh} * @detail keytype @brief 性能回退的模式
- PerformanceAlarmReason
- {zh} * @detail keytype @brief 性能相关告警的原因
- PlayerError
- {zh} * @detail keytype @brief 播放错误码。
- PlayerEvent
- {zh} * @detail keytype @brief 播放事件。
- PlayerState
- {zh} * @detail keytype @brief 播放状态。
- ProblemFeedbackOption
- @brief 音视频质量反馈问题类型
- PublicStreamErrorCode
- {zh} * @deprecated since 3.60, see onMixedStreamEvent{@link #IRTCEngineEventHandler#onMixedStreamEvent}. @detail errorcode @brief WTN 流状态码
- PublishFallbackOption
- {zh} * @detail keytype @brief 发布端音视频流回退选项
- RecordingErrorCode
- {zh} * @detail keytype @brief 本地录制的错误码
- RecordingFileType
- {zh} * @detail keytype @brief 本地录制文件的存储格式
- RecordingState
- {zh} * @detail keytype @brief 本地录制的状态
- RecordingType
- {zh} * @detail keytype @brief 本地录制的媒体类型
- RemoteAudioState
- {zh} * @detail keytype @brief 用户订阅的远端音频流状态。
- RemoteAudioStateChangeReason
- {zh} * @detail keytype @brief 远端音频流状态改变的原因。
- RemoteMirrorType
- {zh} * @detail keytype @brief 远端流的镜像类型。
- RemoteUserPriority
- {zh} * @detail keytype @brief 远端用户优先级，在性能不足需要回退时，会优先回退优先级低的用户的音视频流。
- RemoteVideoState
- {zh} * @detail keytype @brief 远端视频流状态。
- RemoteVideoStateChangeReason
- {zh} * @detail keytype @brief 远端视频流状态改变的原因
- ReturnStatus
- {zh} * @detail keytype @brief 方法调用结果。
- RoomMessageSendResult
- {zh} * @detail errorcode @brief 房间内群发消息结果
- RoomProfile
-
{zh}
* @detail keytype
@brief 房间模式
根据所需场景，选择合适的房间模式，应用不同的音视频算法、视频参数和网络配置
调用setAudioProfile改变音频参数配置 - ScreenMediaType
- {zh} * @detail keytype @brief 屏幕采集媒体类型
- SEICountPerFrame
- {zh} * @detail keytype @brief SEI 发送模式。
- SEIStreamUpdateEvent
- {zh} * @detail keytype @brief 黑帧视频流状态
- SetRoomExtraInfoResult
- {zh} * @detail keytype @brief 设置房间附加消息结果。
- SimulcastStreamType
- {zh} * @detail keytype @brief 订阅大小流偏好
- SingleStreamPushType
- {zh} * @detail keytype @brief 单流转推类型，指定将媒体流转推到 CDN 还是 RTC 房间。
- SingleStreamTaskErrorCode
- {zh} * @detail errorcode @brief 单流转推任务错误码
- SingleStreamTaskEvent
- {zh} * @detail errorcode @brief 单流转推直播事件
- StreamIndex
- {zh} * @detail keytype @brief 流属性
- StreamLayoutMode
- {zh} * @detail keytype @brief WTN 流的布局模式
- StreamRemoveReason
- {zh} * @detail keytype @brief 房间内远端流移除原因。
- SubscribeFallbackOptions
- {zh} * @detail keytype @brief 订阅端音视频流回退选项。
- SubscribeState
- {zh} * @detail keytype @brief 订阅状态
- SubtitleErrorCode
- {zh} * @detail errorcode @brief 字幕任务错误码。
- SubtitleMode
- {zh} * @detail keytype @brief 字幕模式。
- SubtitleState
- {zh} * @detail keytype @brief 字幕任务状态。
- SyncInfoStreamType
- {zh} * @detail keytype @brief 媒体流信息同步的流类型
- TorchState
- {zh} * @detail keytype @brief 相机闪光灯状态
- UserMessageSendResult
- {zh} * @detail errorcode @brief 发送消息结果，成功或失败，及失败原因
- UserOnlineStatus
- {zh} * @detail keytype @brief 用户在线状态
- UserVisibilityChangeError
- {zh} * @detail keytype @brief 用户可见性状态改变错误码。
- VideoCodecType
- {zh} * @detail keytype @brief 编码模式(H264, ByteVC1)
- 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 混响特效类型。
- WarningCode
-
{zh}
* @detail errorcode
@brief 回调警告码。
警告码说明 SDK 内部遇到问题正在尝试恢复。警告码仅作通知。 - ZoomConfigType
- {zh} * @detail keytype @brief 数码变焦参数类型
- ZoomDirectionType
- {zh} * @detail keytype @brief 数码变焦操作类型