volc_engine_rtc library
Classes
- AudioEffectPlayerConfig
- 混音配置
- AudioMixingConfig
- 混音配置
- AudioPropertiesConfig
- 音频属性信息提示的相关配置
- AudioPropertiesInfo
- 音频属性信息
- AudioRecordingConfig
- 音频录制配置
- CloudProxyInfo
- 云代理信息
- DownloadResult
- 歌曲下载信息
- EchoTestConfig
- 音视频回路测试参数
- FaceDetectionResult
- 人脸检测结果
- ForwardStreamEventInfo
- 跨房间转发媒体流过程中的不同目标房间发生的事件
- ForwardStreamInfo
- 媒体流跨房间转发的目标房间的相关信息
- ForwardStreamStateInfo
- 跨房间转发媒体流过程中的不同目标房间的状态和错误信息
- HotMusicInfo
- 热榜歌曲数据
- HumanOrientation
- 用于确定朝向的正方向基准。
- LiveTranscoding
- 转推直播配置参数。
- LiveTranscodingAudioConfig
- 转推音频配置。
- LiveTranscodingLayout
- 转推流布局设置。
- LiveTranscodingRegion
- 单个视频流在合流中的布局信息。
- LiveTranscodingSpatialConfig
- 推流 CDN 的空间音频参数
- LiveTranscodingVideoConfig
- 转推视频配置。
- LocalAudioPropertiesInfo
- 本地音频属性信息
- LocalAudioStats
- 本地音频流统计信息，统计周期为 2s
- LocalProxyConfiguration
- 本地代理配置详细信息。
- LocalSnapshot
- 本地截图结果
- LocalStreamStats
- 本地音/视频流统计信息以及网络状况，统计周期为 2s
- LocalVideoStats
- 本地视频流统计信息，统计周期为 2s
- MediaPlayerConfig
- 混音配置
- MediaTypeEnhancementConfig
- 蜂窝网络辅助增强应用的媒体模式。
- MixedStreamAudioConfig
-
音频转码配置参数。(新)
值不合法或未设置时，自动使用默认值。
本参数不支持过程中更新。 - MixedStreamConfig
- 转推直播配置参数。(新)
- MixedStreamLayoutConfig
-
视频流合流整体布局信息。(新)
开启转推直播功能后，你可以设置参与合流的每路视频流的预设布局信息和合流背景信息等。 - MixedStreamLayoutRegionConfig
-
单个图片或视频流在合流中的布局信息。(新)
开启转推直播功能后，在多路图片或视频流合流时，你可以设置其中一路流在合流中的预设布局信息。 - MixedStreamLayoutRegionImageWaterMarkConfig
- 图片合流相关参数。(新)
- MixedStreamServerControlConfig
- 服务端合流控制参数
- MixedStreamSpatialConfig
- 推流 CDN 的空间音频参数。(新)
- MixedStreamVideoConfig
- 视频转码配置参数(新)。值不合法或未设置时，自动使用默认值。
- MusicInfo
- 歌曲数据
- NetworkQualityStats
- 上行/下行网络质量相关数据
- NetworkTimeInfo
- 网络时间信息
- Position
- 本地用户在房间内的位置坐标
- PositionInfo
- 用户在空间音频坐标系里的位置信息。
- ProblemFeedbackInfo
- 通话质量反馈信息
- ProblemFeedbackRoomInfo
- 通话质量反馈中的房间信息
- PublicStreaming
- 公共流参数
- PublicStreamingAudioConfig
- 公共流的音频参数
- PublicStreamingLayout
- 公共流布局
- PublicStreamingRegion
- 合成公共流的每条流的布局信息
- PublicStreamingVideoConfig
- 公共流的视频编码参数
- PushSingleStreamParam
- 单流转推直播配置参数
- ReceiveRange
- 本地用户能收听到、且具有衰减效果的音频接收范围
- RecordingConfig
- 本地录制参数配置
- RecordingInfo
- 本地录制的详细信息
- RecordingProgress
- 本地录制进度
- Rectangle
- 矩形区域
- RemoteAudioPropertiesInfo
- 远端音频属性信息
- RemoteAudioStats
- 远端音频流统计信息，统计周期为 2s。
- RemoteSnapshot
- 远端截图
- RemoteStreamKey
- 远端流信息
- RemoteStreamStats
- 用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s
- RemoteStreamSwitch
- 流切换信息
- RemoteVideoConfig
- 远端视频帧信息
- RemoteVideoStats
- 远端视频流统计信息，统计周期为 2s
- RoomConfig
- 房间参数配置
- RTCASRConfig
- 使用自动语音识别服务所需校验信息
- RTCASREngineEventHandler
- 语音识别服务使用状态回调
- RTCAudioEffectPlayer
- 音效播放器。
- RTCAudioEffectPlayerEventHandler
- RTCAudioEffectPlayer 对应的回调句柄。你必须调用 RTCAudioEffectPlayer.setEventHandler 完成设置后，才能收到对应回调。
- RTCAudioMixingManager
- 混音管理类
- RTCFaceDetectionObserver
- 人脸检测结果回调观察者
- RTCKTVManager
- KTV 管理接口类
- RTCKTVManagerEventHandler
- KTV 事件回调类
- RTCKTVPlayer
- KTV 播放器接口类
- RTCKTVPlayerEventHandler
- KTV 播放器回调类
- RTCLiveTranscodingObserver
- 转推直播观察者
- RTCLogConfig
- 本地日志参数。
- RTCMediaPlayer
- 音乐播放器。
- RTCMediaPlayerEventHandler
- RTCMediaPlayer 对应的回调句柄。你必须调用 RTCMediaPlayer.setEventHandler 完成设置后，才能收到对应回调。
- RTCMixedStreamObserver
- 转推直播观察者。
- RTCOrientation
- 朝向信息
- RTCPushSingleStreamToCDNObserver
- 单流转推直播观察者
- RTCRangeAudio
- 范围语音接口实例
- RTCRoom
- 房间接口
- RTCRoomEventHandler
- 房间事件回调
- RTCRoomStats
- 通话相关的统计信息
- RTCSpatialAudio
- 空间音频接口实例
- RTCSurfaceView
- 视频渲染设置。
- RTCVideo
- 引擎接口
- RTCVideoContext
- 用于初始化 RTCVideo 的配置
- RTCVideoEffect
- 高级视频特效。
- RTCVideoEventHandler
- RTCVideo 事件回调接口
- RTCViewContext
- 用于 RTCSurfaceView 初始化
- ScreenVideoEncoderConfig
- 屏幕流编码配置。参考 设置视频发布参数。
- SourceCrop
- 视频裁剪参数
- SourceWantedData
- 性能回退相关数据
- StreamSyncInfoConfig
- 媒体流信息同步的相关配置
- SubscribeConfig
- 订阅配置
- SubtitleConfig
- 字幕配置信息。
- SubtitleMessage
- 字幕具体内容。
- SysStats
- CPU 和内存统计信息
- TranscoderLayoutRegionDataParam
- 图片合流相关参数
- UserInfo
- 用户信息
- VideoCaptureConfig
- 视频采集配置参数
- VideoEncoderConfig
- 视频流参数描述
- VideoFrameInfo
- 视频帧信息
- VirtualBackgroundSource
- 背景贴纸对象
- VoiceEqualizationConfig
- 语音均衡效果
- VoiceReverbConfig
- 音频混响效果
- Watermark
- 水印图片相对视频流的位置和大小
- WatermarkConfig
- 水印参数
Enums
- AACProfile
- AAC 编码类型
- AnsMode
- 降噪模式。
- ASRAuthorizationType
- 语音识别服务鉴权方式
- AttenuationType
- 空间音频音量随距离衰减模式
- AudioAlignmentMode
- 远端音频流精准对齐模式
- AudioChannel
- 音频声道
- AudioDeviceType
- 音频设备类型
- AudioFrameSource
- 音频文件录制内容来源
- AudioMixingDualMonoMode
- 混音播放声道类型
- AudioMixingError
- 音频错误码
- AudioMixingState
- 音频混音文件播放状态
- AudioMixingType
- 混音播放类型
- AudioPlayType
- 音乐播放类型
- AudioProfileType
- 音质档位
- AudioPropertiesMode
- 音频信息提示中是否包含本地混音音频数据
- AudioQuality
- 音频质量
- AudioRecordingErrorCode
- 音频文件录制的错误码
- AudioRecordingState
- 录音配置
- AudioReportMode
- 音量回调模式
- AudioRoute
- 音频播放路由
- AudioSampleRate
- 音频采样率，单位为 Hz
- AudioScenario
- 音频场景类型
- AudioSelectionPriority
- 音频选路优先级设置。
- AudioTrackType
- 原唱伴唱类型
- AVSyncState
- 音视频同步状态
- BluetoothMode
- 蓝牙传输协议
- CameraId
- 移动端摄像头
- DataMessageSourceType
- SEI 信息来源
- DownloadFileType
- 下载文件类型
- DownloadLyricType
- 歌词文件类型
- EarMonitorMode
- 是否开启耳返功能
- EchoTestResult
- 音视频回路测试结果
- EffectBeautyMode
- 基础美颜模式
- EncryptType
- 自定义加密类型
- ErrorCode
- 回调错误码
- FallbackOrRecoverReason
- 远端订阅流发生回退或从回退中恢复的原因
- FirstFramePlayState
- 首帧播放状态
- FirstFrameSendState
- 首帧发送状态
- ForwardStreamError
- 媒体流跨房间转发过程中的错误码
- ForwardStreamEvent
- 跨房间转发媒体流过程中该目标房间发生的事件
- ForwardStreamState
- 媒体流跨房间转发状态
- HardwareEchoDetectionResult
- 通话前回声检测结果
- KTVErrorCode
- KTV 功能相关错误码
- KTVPlayerErrorCode
- KTV 播放器错误码
- LocalAudioStreamError
- 本地音频流状态改变时的错误码
- LocalAudioStreamState
- 本地音频流状态，及在 LocalAudioStreamError 中对应的错误码
- LocalLogLevel
- 本地日志输出等级。
- LocalProxyError
- 本地代理错误。
- LocalProxyState
- 本地代理连接状态。
- LocalProxyType
- 本地代理的类型。
- LocalVideoStreamError
- 本地视频状态改变时的错误码
- LocalVideoStreamState
- 本地视频流状态，及在 LocalVideoStreamError 中对应的错误码
- LoginErrorCode
- 登录结果
- LogoutReason
- 用户登出的原因
- LyricStatus
- 歌词格式类型
- MediaDeviceError
- 媒体设备错误类型
- MediaDeviceState
- 媒体设备状态
- MediaDeviceWarning
- 媒体设备警告
- MediaStreamType
- 媒体流类型
- MessageConfig
- 发送消息的可靠有序性
- MirrorType
- 镜像类型
- MixedStreamAlternateImageFillMode
- 服务端合流占位图填充模式。
- MixedStreamAudioCodecType
- 音频编码类型。(新)
- MixedStreamAudioProfile
- AAC 编码规格。(新)
- MixedStreamLayoutRegionType
- 合流布局区域类型。(新)
- MixedStreamMediaType
- 合流输出内容类型。(新)
- MixedStreamPushMode
- 服务端合流转推发起模式
- MixedStreamRenderMode
- 图片或视频流的缩放模式。(新)
- MixedStreamSEIContentMode
- 服务端合流转推 SEI 内容
- MixedStreamVideoCodecType
- 视频编码格式(新)。
- MixedStreamVideoType
- region 中流的类型属性。
- MusicFilterType
- 歌曲过滤方式
- MusicHotType
- 榜单类别
- NetworkDetectionLinkType
- 通话前探测的网络类型
- NetworkDetectionStopReason
- 通话前网络探测停止的原因
- NetworkQuality
- 所属用户的媒体流网络质量
- NetworkType
- 网络类型
- PauseResumeControlMediaType
- 暂停/恢复接收远端的媒体流类型
- PerformanceAlarmMode
- 是否开启发布性能回退
- PerformanceAlarmReason
- 性能相关的告警原因
- PlayerError
- 播放错误码
- PlayerState
- 播放状态。
- PlayState
- 音乐播放状态
- ProblemFeedbackOption
- 音视频质量反馈问题类型
- PublicStreamErrorCode
- 公共流状态码
- PublishFallbackOption
- 发布端音视频流回退选项
- RecordingErrorCode
- 本地录制的错误码
- RecordingFileType
- 本地录制文件的存储格式
- RecordingState
- 本地录制的状态
- RecordingType
- 本地录制的媒体类型
- RemoteAudioState
- 用户订阅的远端音频流状态，及在 RemoteAudioStateChangeReason 中对应的原因
- RemoteAudioStateChangeReason
- 远端音频流状态改变的原因
- RemoteMirrorType
- 远端镜像类型
- RemoteUserPriority
- 远端用户优先级，在性能不足需要回退时，会先回退优先级低的用户的音视频流
- RemoteVideoState
- 远端视频流状态，及在 RemoteVideoStateChangeReason 中对应的原因
- RemoteVideoStateChangeReason
- 远端视频流状态改变的原因
- ReturnStatus
- 方法调用结果。
- RoomMessageSendResult
- 房间内群发消息结果
- RoomProfile
- 房间模式
- RTCConnectionState
- SDK 与 RTC 服务器连接状态
- ScaleMode
- 视频帧缩放模式，可设置缩放以适应视窗。
- ScreenMediaType
- 屏幕采集媒体类型
- ScreenVideoEncoderPreference
- 屏幕流编码模式。默认采用清晰模式。
- SEICountPerFrame
- SEI 发送模式
- SEIStreamUpdateEvent
- 黑帧视频流状态
- SetRoomExtraInfoResult
- 设置房间附加消息结果。
- StreamIndex
- 流属性
- StreamMixingErrorCode
- 转推直播错误码
- StreamMixingEvent
- 转推直播任务状态
- StreamMixingType
- 合流类型
- StreamRemoveReason
- 房间内远端流移除原因
- StreamSinglePushEvent
- 单流转推直播状态
- SubscribeFallbackOption
- 订阅端音视频流回退选项
- SubscribeState
- 订阅媒体流状态
- SubtitleErrorCode
- 字幕任务错误码。
- SubtitleMode
- 字幕模式。
- SubtitleState
- 字幕任务状态。
- SyncInfoStreamType
- 媒体流信息同步的流类型
- TorchState
- 相机闪光灯状态
- TranscoderContentControlType
- 合流输出内容类型
- TranscoderLayoutRegionType
- 合流布局区域类型
- TranscodingAudioCodec
- 音频编码格式。
- TranscodingVideoCodec
- 视频编码格式。
- UserMessageSendResult
- 消息发送结果
- UserOfflineReason
- 远端用户离开房间的原因
- UserOnlineStatus
- 用户在线状态
- UserVisibilityChangeError
- 用户可见性状态改变错误码。
- VideoCanvasType
- 画布类型
- VideoCapturePreference
- 视频采集模式
- VideoCodecType
- 视频的编码类型
- VideoDenoiseMode
- 视频降噪模式
- VideoDenoiseModeChangedReason
- 视频降噪模式状态改变原因
- VideoDeviceType
- 当前视频设备类型
- VideoEncoderPreference
- 编码策略偏好
- VideoOrientation
- 视频帧朝向
- VideoRenderMode
- 视频渲染的缩放模式
- VideoRotation
- 视频帧旋转角度
- VideoRotationMode
- 视频旋转模式
- VideoSuperResolutionMode
- 超分模式
- VideoSuperResolutionModeChangedReason
- 超分状态改变原因
- VirtualBackgroundSourceType
- 虚拟背景类型
- VoiceChangerType
- 变声特效类型。如需更多变声特效类型，联系技术支持。
- VoiceEqualizationBandFrequency
- 音频均衡效果
- VoiceReverbType
- 混响特效类型
- WarningCode
- 回调警告码
- ZoomConfigType
- 数码变焦参数类型
- ZoomDirectionType
- 数字变焦操作类型
Typedefs
- OnAudioEffectPlayerStateChangedType = void Function(int effectId, PlayerState state, PlayerError error)
-
effectId：RTCAudioEffectPlayer 的 ID。通过 RTCVideo.getAudioEffectPlayer 设置。 - OnClearCacheResultType = void Function(KTVErrorCode errorCode)
-
errorCode：错误码。非 0 为失败。 -
OnHotMusicResultType
= void Function(List<
HotMusicInfo> ? hotMusics, KTVErrorCode errorCode) -
hotMusics：热榜歌曲数据数组 - OnMediaPlayerPlayingProgressType = void Function(int playerId, int progress)
-
playerId：RTCMediaPlayer 的 ID。通过 RTCVideo.getMediaPlayer 设置。 - OnMediaPlayerStateChangedType = void Function(int playerId, PlayerState state, PlayerError error)
-
playerId：RTCMediaPlayer 的 ID。通过 RTCVideo.getMediaPlayer 设置。 - OnMusicDetailResultType = void Function(MusicInfo? musicInfo, KTVErrorCode errorCode)
-
musicInfo：歌曲数据 -
OnMusicListResultType
= void Function(List<
MusicInfo> ? musicInfos, int totalSize, KTVErrorCode errorCode) -
musicInfos：歌曲数据数组 - OnPlayProgressType = void Function(String musicId, int progress)
-
musicId：音乐 ID。 - OnPlayStateChangedType = void Function(String musicId, PlayState playState, KTVPlayerErrorCode errorCode)
-
musicId：音乐 ID。