byteplus_rtc library

Copyright (c) 2026 BytePlus Pte. Ltd.

Classes

AudioEffectPlayer
AudioEffectPlayer
AudioEffectPlayerConfig
AudioFormat
AudioFrame
AudioPropertiesConfig
AudioPropertiesInfo
AudioRecordingConfig
CloudProxyInfo
DestInfo
FaceDetectionResult
ForwardStreamEventInfo
ForwardStreamInfo
ForwardStreamStateInfo
HumanOrientation
IAudioEffectPlayerEventHandler
IAudioFrameObserver
IFaceDetectionObserver
IMediaPlayerEventHandler
IRTCEngineEventHandler
IRTCRoomEventHandler
LocalAudioPropertiesInfo
LocalAudioStats
LocalProxyConfiguration
LocalSnapshot
@brief Local snapshot
LocalStreamStats
LocalVideoStats
LoggerManager
MediaPlayer
@brief Media player
MediaPlayerConfig
MediaTypeEnhancementConfig
MixedStreamAudioConfig
@brief Config for mixed stream (audio).
MixedStreamConfig
@brief Config for mixed stream. The parameters can be used for both WTN stream and mixed stream tasks unless otherwise specified. The parameters can be used to start and update tasks unless otherwise specified.
MixedStreamControlConfig
MixedStreamLayoutRegionConfig
@brief Layout information for a single image or video stream in the mixed stream. After enabling the push-to-CDN function, you can set the preset layout information for one of the video streams in the mixed stream.
MixedStreamLayoutRegionImageWaterMarkConfig
MixedStreamPushTargetConfig
@brief Mixed stream push target config
MixedStreamSpatialAudioConfig
@brief Spatial audio configuration
MixedStreamTaskInfo
MixedStreamVideoConfig
@brief Config for mixed stream (video).
NetworkQualityStats
NetworkTimeInfo
Position
PositionInfo
ProblemFeedbackInfo
ProblemFeedbackRoomInfo
PushSingleStreamParam
@brief Single stream push parameter
ReceiveRange
RecordingConfig
RecordingInfo
RecordingProgress
Rectangle
RemoteAudioPropertiesInfo
RemoteAudioStats
RemoteSnapshot
@brief Remote snapshot
RemoteStreamKey
RemoteStreamStats
RemoteStreamSwitch
RemoteVideoConfig
RemoteVideoStats
RoomConfig
@brief Room configuration
RTCEngine
Engine class
RTCLogConfig
RTCOrientation
RTCRangeAudio
@brief Remote audio management class
RTCRoom
@brief Room class
RTCRoomStats
RTCSpatialAudio
@brief Spatial audio class
RTCSurfaceView
Video rendering settings.
RTCSurfaceViewState
RTCVideoContext
@brief Engine initialization parameters
RTCViewContext
@brief Used for RTCSurfaceView initialization
SourceCrop
SourceWantedData
StreamInfo
StreamSyncInfoConfig
@brief Media stream information synchronization related configuration
SubscribeConfig
SubtitleConfig
SubtitleMessage
SysStats
TakeSnapshotResultObserver
@brief Take snapshot result callback
UserInfo
VideoCaptureConfig
VideoEffect
@brief Video effect class
VideoEncoderConfig
VideoFrameInfo
VirtualBackgroundSource
@brief Background sticker object
VoiceEqualizationConfig
VoiceReverbConfig
Watermark
@brief Watermark image position and size relative to the video stream
WatermarkConfig
@brief Watermark parameters

Enums

AACProfile
@brief AAC encoding type
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 音频选路优先级设置
AVSyncEvent
{zh} * @detail keytype @brief AVSync 事件类型
AVSyncState
{zh} * @detail keytype @brief 音视频同步状态
BluetoothMode
@brief Bluetooth transport protocol @note Only applicable to 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 Custom encryption type
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 回调通知用户。
LogLevel
Log level enumeration Defines different levels of logging with corresponding numeric values Higher values indicate more severe log levels
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 Audio and video quality feedback problem type
PublicStreamErrorCode
{zh} * @deprecated since 3.60, see onMixedStreamEvent{@link #IRTCEngineEventHandler#onMixedStreamEvent}. @detail errorcode @brief WTN 流状态码
PublishFallbackOption
{zh} * @detail keytype @brief 发布端音视频流回退选项
PublishState
{zh} * @detail keytype @brief 发布状态
PublishStateChangeReason
{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 订阅状态
SubscribeStateChangeReason
{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 用户可见性状态改变错误码。
VideoCanvasType
@brief Canvas type
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 数码变焦操作类型

Properties

$audio_effect_instance ↔ dynamic
Global audioEffect instance
getter/setter pair
$engine_instance ↔ dynamic
ignored
getter/setter pair
globalEngine ↔ RTCEngine?
Global engine instance
getter/setter pair
viewMap ↔ Map<String, String>
getter/setter pair

Functions

genEchoTestViewId() → String
@deprecated
genPublicStreamId(String streamId) → String
@brief Generate public stream ID
genViewId(String roomId, String uid) → String
@brief Generate View ID
globalGetViewByViewId(String viewId) → String