api/bytertc_media_defines library
Copyright (c) 2026 Beijing Volcano Engine Technology Ltd.
Classes
- AudioFormat
- @detail keytype @brief 音频参数格式
- AudioFrame
- @detail keytype @brief PCM 音频帧
- DestInfo
- @detail keytype @brief 转发目标房间信息，用于指定将媒体流转发到哪个房间以及在该房间中的用户身份。
- EchoTestConfig
- ForwardStreamEventInfo
- @detail keytype @brief 跨房间转发媒体流过程中的不同目标房间发生的事件
- ForwardStreamInfo
- @detail keytype @brief 媒体流跨房间转发的目标房间的相关信息
- ForwardStreamStateInfo
- @detail keytype @brief 跨房间转发媒体流过程中的不同目标房间的状态和错误信息
- IAudioFrameObserver
-
@detail callback
@brief 音频数据回调观察者
注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。
本接口类中的回调周期均为 20 ms。 - LocalAudioStats
-
@detail keytype
@brief 本地音频流统计信息，统计周期为 2s 。
本地用户发布音频流成功后，SDK 会周期性地通过onLocalStreamStats通知用户发布的音频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 - LocalStreamStats
-
@detail keytype
@brief 本地音/视频流统计信息，统计周期为 2s 。
本地用户发布音/视频流成功后，SDK 会周期性地通过onLocalStreamStats通知本地用户发布的音/视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 - LocalVideoStats
-
@detail keytype
@brief 本地视频流统计信息，统计周期为 2s 。
本地用户发布视频流成功后，SDK 会周期性地通过onLocalStreamStats
通知用户发布的视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 - NetworkQualityStats
- @detail keytype @brief 上行/下行网络质量
- NetworkTimeInfo
- @detail keytype @brief 网络时间信息
- ProblemFeedbackInfo
- @detail keytype @brief 通话质量反馈信息
- ProblemFeedbackRoomInfo
- @detail keytype @brief 通话质量反馈中的房间信息
- RecordingConfig
- @detail keytype @brief 本地录制参数配置
- RecordingInfo
- @detail keytype @brief 本地录制的详细信息
- RecordingProgress
- @detail keytype @brief 本地录制进度
- RemoteAudioStats
-
@detail keytype
@brief 远端音频流统计信息，统计周期为 2s。
本地用户订阅远端音频流成功后，SDK 会周期性地通过onRemoteStreamStats通知本地用户订阅的音频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 - RemoteStreamKey
- @detail keytype @brief 远端流信息。
- RemoteStreamStats
-
@detail keytype
@brief 用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s 。
订阅远端用户发布音/视频流成功后，SDK 会周期性地通过onRemoteStreamStats通知本地用户订阅的远端音/视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 - RemoteVideoStats
-
@detail keytype
@brief 远端视频流统计信息，统计周期为 2s 。
本地用户订阅远端视频流成功后，SDK 会周期性地通过onRemoteStreamStats
通知本地用户订阅的远端视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 - RTCRoomStats
- @detail keytype @brief 通话相关的统计信息
- SubtitleConfig
- @detail keytype @brief 字幕配置信息。
- SubtitleMessage
- @detail keytype @brief 字幕具体内容。
- UserInfo
- @detail keytype @brief 用户信息
Enums
- AudioFrameCallbackMethod
- {zh} * @detail keytype @brief 音频回调方法
- AudioMixingDualMonoMode
- {zh} * @detail keytype @brief 混音播放声道类型
- AudioSelectionPriority
- {zh} * @detail keytype @brief 音频选路优先级设置
- AVSyncState
- {zh} * @detail keytype @brief 音视频同步状态
- BluetoothMode
- @brief 蓝牙传输协议 @note 仅 iOS 适用。
- DataMessageSourceType
- {zh} * @detail keytype @brief 数据消息来源
- EchoTestResult
- {zh} * @detail keytype @brief 音视频回路测试结果
- EncryptType
- @brief 自定义加密类型
- 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 通话前回声检测结果
- LocalAudioStreamError
- {zh} * @detail keytype @brief 本地音频流状态改变时的错误码。
- LocalAudioStreamState
-
{zh}
* @detail keytype
@brief 本地音频流状态。
SDK 通过 onLocalAudioStateChanged 回调该状态。 - LocalVideoStreamError
- {zh} * @detail keytype @brief 本地视频状态改变时的错误码
- LocalVideoStreamState
- {zh} * @detail keytype @brief 本地视频流状态
- MediaDeviceError
- {zh} * @detail keytype @brief 媒体设备错误类型
- MediaDeviceState
-
{zh}
* @detail keytype
@brief 媒体设备状态
通过onAudioDeviceStateChanged/onVideoDeviceStateChanged回调设备状态。 - MediaDeviceWarning
- {zh} * @detail keytype @brief 媒体设备警告
- NetworkDetectionLinkType
-
{zh}
* @detail keytype
@brief 通话前探测链接的类型。
onNetworkDetectionResult回调的参数类型 - NetworkDetectionStopReason
-
{zh}
* @detail keytype
@brief 通话前探测的停止原因。
onNetworkDetectionStopped回调的参数类型 - PerformanceAlarmMode
- {zh} * @detail keytype @brief 性能回退的模式
- PerformanceAlarmReason
- {zh} * @detail keytype @brief 性能相关告警的原因
- PlayerEvent
- {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 本地录制的状态
- RemoteAudioState
- {zh} * @detail keytype @brief 用户订阅的远端音频流状态。
- RemoteAudioStateChangeReason
- {zh} * @detail keytype @brief 远端音频流状态改变的原因。
- RemoteUserPriority
- {zh} * @detail keytype @brief 远端用户优先级，在性能不足需要回退时，会优先回退优先级低的用户的音视频流。
- RemoteVideoState
- {zh} * @detail keytype @brief 远端视频流状态。
- RemoteVideoStateChangeReason
- {zh} * @detail keytype @brief 远端视频流状态改变的原因
- ReturnStatus
- {zh} * @detail keytype @brief 方法调用结果。
- RoomProfile
-
{zh}
* @detail keytype
@brief 房间模式
根据所需场景，选择合适的房间模式，应用不同的音视频算法、视频参数和网络配置
调用setAudioProfile改变音频参数配置 - 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 单流转推任务错误码
- StreamIndex
- {zh} * @detail keytype @brief 流属性
- StreamRemoveReason
- {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 媒体流信息同步的流类型
- UserVisibilityChangeError
- {zh} * @detail keytype @brief 用户可见性状态改变错误码。
- VideoCodecType
- {zh} * @detail keytype @brief 编码模式(H264, ByteVC1)