RTCVideo class Null safety
引擎接口
Constructors
- RTCVideo()
Properties
- audioMixingManager → RTCAudioMixingManager
-
创建混音管理接口实例
read-only
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
checkVideoEffectLicense(
String licenseFile) → Future< int?> - 视频特效许可证检查 [...]
-
clearVideoWatermark(
{StreamIndex streamIndex = StreamIndex.main}) → Future< void> - 移除指定视频流的水印
-
createRTCRoom(
String roomId) → Future< RTCRoom?> - 创建 RTC 房间 [...]
-
destroy(
) → Future< void> - 销毁由 RTCVideo.createRTCVideo 所创建引擎实例，并释放所有相关资源 [...]
-
enableAudioPropertiesReport(
AudioPropertiesConfig config) → Future< void> - 启用音量提示 [...]
-
enableEffectBeauty(
bool enable) → Future< int?> - 开启/关闭基础美颜 [...]
-
enableExternalSoundCard(
bool enable) → Future< void> - 启用匹配外置声卡的音频处理模式 [...]
-
enablePlaybackDucking(
bool enable) → Future< void> - 打开/关闭音量闪避功能，适用于“一起看”等场景 [...]
-
enableSimulcastMode(
bool enable) → Future< int?> - 设置视频流发布端是否开启发布多路编码参数不同的视频流的模式，默认关闭 [...]
-
enableVideoEffect(
bool enable) → Future< int?> - 创建/销毁视频特效引擎 [...]
-
enableVocalInstrumentBalance(
bool enable) → Future< void> - 开启/关闭音量均衡功能 [...]
-
feedback(
{required List< ProblemFeedback> types, required String problemDesc}) → Future<int?> - 将用户反馈的问题上报到 RTC [...]
-
getAudioRoute(
) → Future< AudioRoute> - 获取当前使用的音频播放路由 [...]
-
getCameraZoomMaxRatio(
) → Future< double?> - 获取当前使用的摄像头（前置/后置）的最大变焦倍数
-
getPeerOnlineStatus(
String peerUid) → Future< void> - 发送消息前，查询指定远端用户或本地用户的登录状态 [...]
-
isCameraExposurePositionSupported(
) → Future< bool?> - 检查当前使用的摄像头是否支持手动设置曝光点
-
isCameraFocusPositionSupported(
) → Future< bool?> - 检查当前使用的摄像头是否支持手动对焦
-
isCameraTorchSupported(
) → Future< bool?> - 检测当前使用的摄像头（前置/后置），是否支持闪光灯
-
isCameraZoomSupported(
) → Future< bool?> - 检测当前使用的摄像头（前置/后置），是否支持变焦（数码/光学变焦）
-
login(
{required String token, required String uid}) → Future< int?> - 登录以发送房间外消息和向业务服务器发送消息 [...]
-
logout(
) → Future< void> - 登出 [...]
-
muteAudioPlayback(
bool muteState) → Future< void> - 控制本地音频流播放状态：播放/不播放 [...]
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
registerFaceDetectionObserver(
{RTCFaceDetectionObserver? observer, int interval = 0}) → Future< int?> - 注册人脸检测结果回调观察者 [...]
-
removeLocalVideo(
{StreamIndex streamType = StreamIndex.main}) → Future< int?> - 取消设置本地视频画布
-
removePublicStreamVideo(
String publicStreamId) → Future< int?> - 取消设置公共流视频画布
-
removeRemoteVideo(
{required String roomId, required String uid, StreamIndex streamType = StreamIndex.main}) → Future< int?> - 取消设置远端视频画布
-
sendScreenCaptureExtensionMessage(
Uint8List message) → Future< void> - 仅适用于 iOS，向屏幕共享 Extension 发送自定义消息 [...]
-
sendSEIMessage(
{StreamIndex streamIndex = StreamIndex.main, required Uint8List message, required int repeatCount}) → Future< int?> - 通过视频帧发送 SEI 数据。 [...]
-
sendServerBinaryMessage(
Uint8List message) → Future< int?> - 客户端给业务服务器发送二进制消息 [...]
-
sendServerMessage(
String message) → Future< int?> - 客户端给业务服务器发送文本消息 [...]
-
sendStreamSyncInfo(
{required Uint8List data, required StreamSyncInfoConfig config}) → Future< int?> - 发送音频流同步信息 [...]
-
sendUserBinaryMessageOutsideRoom(
{required String uid, required Uint8List message, required MessageConfig config}) → Future< int?> - 给房间外指定的用户发送二进制消息 [...]
-
sendUserMessageOutsideRoom(
{required String uid, required String message, required MessageConfig config}) → Future< int?> - 给房间外指定的用户发送文本消息 [...]
-
setAudioProfile(
AudioProfileType audioProfile) → Future< void> - 设置音质档位 [...]
-
setAudioRoute(
AudioRoute audioRoute) → Future< int?> - 设置当前音频播放路由 [...]
-
setAudioScenario(
AudioScenario audioScenario) → Future< void> - 设置音频场景类型 [...]
-
setBackgroundSticker(
{String? modelPath, VirtualBackgroundSource? source}) → Future< int?> - 将摄像头采集画面中的人像背景替换为指定图片或纯色背景 [...]
-
setBeautyIntensity(
{required EffectBeautyMode beautyMode, required double intensity}) → Future< int?> - 调整基础美颜强度 [...]
-
setBusinessId(
String businessId) → Future< void> - 设置业务标识参数。 [...]
-
setCameraExposureCompensation(
double val) → Future< int?> - 设置当前使用的摄像头的曝光补偿 [...]
-
setCameraExposurePosition(
Offset position) → Future< int?> - 设置当前使用的摄像头的曝光点 [...]
-
setCameraFocusPosition(
Offset position) → Future< int?> - 设置当前使用的摄像头的对焦点 [...]
-
setCameraTorch(
TorchState torchState) → Future< int?> - 打开/关闭当前使用的摄像头（前置/后置）的闪光灯 [...]
-
setCameraZoomRatio(
double zoom) → Future< int?> - 设置当前使用的摄像头（前置/后置）的变焦倍数 [...]
-
setCaptureVolume(
{StreamIndex index = StreamIndex.main, required int volume}) → Future< void> - 调节音频采集音量 [...]
-
setDefaultAudioRoute(
AudioRoute audioRoute) → Future< int?> - 将默认的音频播放设备设置为听筒或扬声器 [...]
-
setEarMonitorMode(
EarMonitorMode mode) → Future< void> - 开启/关闭耳返功能 [...]
-
setEarMonitorVolume(
int volume) → Future< void> - 设置耳返的音量 [...]
-
setEncryptInfo(
{required EncryptType aesType, required String key}) → Future< void> - 设置传输时使用内置加密的方式 [...]
-
setLocalVideoMirrorType(
MirrorType mirrorType) → Future< int?> - 为本地采集到的视频流开启镜像 [...]
-
setLocalVoicePitch(
int pitch) → Future< void> - 开启本地语音变调功能，多用于 K 歌场景 [...]
-
setMaxVideoEncoderConfig(
VideoEncoderConfig maxSolution) → Future< int?> - 视频发布端设置期望发布的最大分辨率视频流参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等 [...]
-
setPlaybackVolume(
int volume) → Future< void> - 调节本地播放的所有远端用户混音后的音量 [...]
-
setPublishFallbackOption(
PublishFallbackOption option) → Future< int?> - 设置发布的音视频流回退选项 [...]
-
setRemoteAudioPlaybackVolume(
{required String roomId, required String uid, required int volume}) → Future< void> - 调节来自指定远端用户的音频播放音量 [...]
-
setRemoteUserPriority(
{required String roomId, required String uid, required RemoteUserPriority priority}) → Future< int?> - 设置指定远端用户在回退中的优先级 [...]
-
setRTCVideoEventHandler(
RTCVideoEventHandler handler) → void - 设置事件回调的接收类
-
setRuntimeParameters(
Map< String, dynamic> params) → Future<void> - 设置运行时的参数
-
setScreenAudioStreamIndex(
StreamIndex index) → Future< void> - 在屏幕共享时，设置屏幕音频流和麦克风采集到的音频流的混流方式 [...]
-
setScreenVideoEncoderConfig(
VideoEncoderConfig screenSolution) → Future< int?> - 为发布的屏幕共享视频流设置期望的编码参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等 [...]
-
setServerParams(
{required String signature, required String url}) → Future< void> - 设置应用服务器参数 [...]
-
setSubscribeFallbackOption(
SubscribeFallbackOption option) → Future< int?> - 设置订阅的音视频流回退选项 [...]
-
setVideoCaptureConfig(
VideoCaptureConfig config) → Future< int?> - 设置 RTC SDK 内部采集时的视频采集参数，包括分辨率、帧率等 [...]
-
setVideoEffectAlgoModelPath(
String modelPath) → Future< void> - 设置视频特效算法模型路径
-
setVideoEffectColorFilter(
String? resFile) → Future< int?> - 设置颜色滤镜 [...]
-
setVideoEffectColorFilterIntensity(
double intensity) → Future< int?> - 设置已启用的颜色滤镜强度 [...]
-
setVideoEffectNodes(
List< String> ? effectNodes) → Future<int?> - 设置视频特效素材包 [...]
-
setVideoEncoderConfig(
List< VideoEncoderConfig> channelSolutions) → Future<int?> - 视频发布端设置推送多路流时各路流的参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等 [...]
-
setVideoOrientation(
VideoOrientation orientation) → Future< void> - 在自定义视频前处理及编码前，设置 RTC 链路中的视频帧朝向，默认为 Adaptive 模式 [...]
-
setVideoRotationMode(
VideoRotationMode rotationMode) → Future< int?> - 设置采集视频的旋转模式，默认以 App 方向为旋转参考系 [...]
-
setVideoWatermark(
{StreamIndex streamIndex = StreamIndex.main, required String imagePath, required WatermarkConfig watermarkConfig}) → Future< void> - 在指定视频流上添加水印 [...]
-
setVoiceChangerType(
VoiceChangerType voiceChanger) → Future< void> - 设置变声特效类型 [...]
-
setVoiceReverbType(
VoiceReverbType voiceReverb) → Future< void> - 设置混响特效类型 [...]
-
startASR(
{required RTCASRConfig asrConfig, required RTCASREngineEventHandler handler}) → Future< void> - 开启自动语音识别服务 [...]
-
startAudioCapture(
) → Future< void> - 开启内部音频采集，默认为关闭状态 [...]
-
startCloudProxy(
List< CloudProxyInfo> cloudProxiesInfo) → Future<void> - 开启云代理 [...]
-
startEchoTest(
EchoTestConfig config, int delayTime) → Future< int?> - 开启音视频回路测试 [...]
-
startFileRecording(
{StreamIndex streamIndex = StreamIndex.main, required RecordingConfig config, required RecordingType recordingType}) → Future< int?> - 将通话过程中的音视频数据录制到本地的文件中 [...]
-
startLiveTranscoding(
{required String taskId, required LiveTranscoding transcoding, required RTCLiveTranscodingObserver observer}) → Future< void> - 新增转推直播任务，并设置合流的图片、视频视图布局和音频属性 [...]
-
startNetworkDetection(
{required bool isTestUplink, required int expectedUplinkBitrate, required bool isTestDownlink, required int expectedDownlinkBitrate}) → Future< NetworkDetectionStartReturn> - 开启通话前网络探测 [...]
-
startPlayPublicStream(
String publicStreamId) → Future< int?> - 订阅指定公共流 [...]
-
startPushPublicStream(
{required String publicStreamId, required PublicStreaming publicStreamParam}) → Future< int?> - 发布一路公共流 [...]
-
startPushSingleStreamToCDN(
{required String taskId, required PushSingleStreamParam param, required RTCPushSingleStreamToCDNObserver observer}) → Future< void> - 新增单流转推直播任务 [...]
-
startScreenCapture(
ScreenMediaType type) → Future< void> - 使用 RTC SDK 内部采集模块开始采集屏幕音频流和（或）视频流 [...]
-
startVideoCapture(
) → Future< void> - 开启内部视频采集，默认为关闭状态 [...]
-
stopASR(
) → Future< void> - 关闭语音识别服务
-
stopAudioCapture(
) → Future< void> - 关闭内部音频采集，默认为关闭状态 [...]
-
stopCloudProxy(
) → Future< void> - 关闭云代理
-
stopEchoTest(
) → Future< int?> - 停止音视频回路测试 [...]
-
stopFileRecording(
{StreamIndex streamIndex = StreamIndex.main}) → Future< void> - 停止本地录制 [...]
-
stopLiveTranscoding(
String taskId) → Future< void> - 停止转推直播
-
stopNetworkDetection(
) → Future< void> - 停止通话前网络探测 [...]
-
stopPlayPublicStream(
String publicStreamId) → Future< int?> - 取消订阅指定公共流
-
stopPushPublicStream(
String publicStreamId) → Future< int?> - 停止发布公共流
-
stopPushStreamToCDN(
String taskId) → Future< void> - 停止单流转推直播任务
-
stopScreenCapture(
) → Future< void> - 屏幕共享时，停止屏幕流采集
-
stopVideoCapture(
) → Future< void> - 关闭本地视频采集，默认为关闭状态 [...]
-
switchCamera(
CameraId cameraId) → Future< void> - 切换移动端前置/后置摄像头 [...]
-
toString(
) → String -
A string representation of this object. [...]
inherited
-
updateLiveTranscoding(
{required String taskId, required LiveTranscoding transcoding}) → Future< void> - 更新转推直播参数
-
updateLoginToken(
String token) → Future< void> - 更新用户用于登录的 Token [...]
-
updatePublicStreamParam(
{required String publicStreamId, required PublicStreaming publicStreamParam}) → Future< int?> - 更新发布的公共流参数
-
updateScreenCapture(
ScreenMediaType type) → Future< void> - 开启屏幕采集后，更新采集的媒体类型
-
updateVideoEffectNode(
{required String effectNode, required String key, required double value}) → Future< int?> - 设置特效强度 [...]
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited
Static Methods
-
createRTCVideo(
RTCVideoContext context) → Future< RTCVideo?> - 创建引擎对象 [...]
-
getErrorDescription(
int code) → Future< String?> - 获取 SDK 内各种错误码、警告码的描述文字
-
getSdkVersion(
) → Future< String?> - 获取当前 SDK 版本信息