RtcEngine class abstract

RTC SDK 的基础接口类，实现实时音视频的主要功能。

RtcEngine 提供了 App 调用的主要方法。 在调用其他 API 之前，必须先调用 createAgoraRtcEngine 创建 RtcEngine 对象。

Implementers

• RtcEngineEx

Available extensions

• RtcEngineDebug

Constructors

RtcEngine()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addVideoWatermark({required String watermarkUrl, required WatermarkOptions options}) → Future<void>

添加本地视频水印。

addVideoWatermarkWithConfig(WatermarkConfig configs) → Future<void>

向本地视频流添加水印图像。

adjustAudioMixingPlayoutVolume(int volume) → Future<void>

调节音乐文件在本地播放的音量。

adjustAudioMixingPublishVolume(int volume) → Future<void>

调节音乐文件远端播放音量。

adjustAudioMixingVolume(int volume) → Future<void>

调节音乐文件的播放音量。

adjustCustomAudioPlayoutVolume({required int trackId, required int volume}) → Future<void>

调节自定义音频采集轨道在本地播放的音量。

adjustCustomAudioPublishVolume({required int trackId, required int volume}) → Future<void>

调节自定义音频采集轨道在远端播放的音量。

adjustLoopbackSignalVolume(int volume) → Future<void>

调节声卡采集信号音量。

adjustPlaybackSignalVolume(int volume) → Future<void>

调节本地播放的所有远端用户信号音量。

adjustRecordingSignalVolume(int volume) → Future<void>

调节音频采集信号音量。

adjustUserPlaybackSignalVolume({required int uid, required int volume}) → Future<void>

调节本地播放的指定远端用户信号音量。

clearVideoWatermarks() → Future<void>

删除已添加的视频水印。

complain({required String callId, required String description}) → Future<void>

投诉通话质量。

configRhythmPlayer(AgoraRhythmPlayerConfig config) → Future<void>

配置虚拟节拍器。

createCustomVideoTrack() → Future<int>

创建一个自定义的视频轨道。

createDataStream(DataStreamConfig config) → Future<int>

创建数据流。

createMediaRecorder(RecorderStreamInfo info) → Future<MediaRecorder?>

创建音视频录制对象。

createVideoEffectObject({required String bundlePath, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<VideoEffectObject?>

创建一个 IVideoEffectObject 视频特效对象。

destroyCustomVideoTrack(int videoTrackId) → Future<void>

销毁指定的视频轨道。

destroyMediaPlayer(MediaPlayer mediaPlayer) → Future<void>

销毁媒体播放器。

destroyMediaRecorder(MediaRecorder mediaRecorder) → Future<void>

销毁音视频录制对象。

destroyVideoEffectObject(VideoEffectObject videoEffectObject) → Future<void>

销毁视频特效对象。

disableAudio() → Future<void>

关闭音频模块。

disableAudioSpectrumMonitor() → Future<void>

关闭音频频谱监测。

disableVideo() → Future<void>

关闭视频模块。

enableAudio() → Future<void>

启用音频模块。

enableAudioSpectrumMonitor({int intervalInMS = 100}) → Future<void>

开启音频频谱监测。

enableAudioVolumeIndication({required int interval, required int smooth, required bool reportVad}) → Future<void>

启用用户音量提示。

enableCameraCenterStage(bool enabled) → Future<void>

开启或关闭人像锁定功能。

enableContentInspect({required bool enabled, required ContentInspectConfig config}) → Future<void>

开启/关闭本地截图上传。

enableCustomAudioLocalPlayback({required int trackId, required bool enabled}) → Future<void>

设置是否在本地播放外部音频源。

enableDualStreamMode({required bool enabled, SimulcastStreamConfig? streamConfig}) → Future<void>

在发送端开启或关闭双流模式并设置视频小流。

enableEncryption({required bool enabled, required EncryptionConfig config}) → Future<void>

开启或关闭内置加密。

enableExtension({required String provider, required String extension, bool enable = true, MediaSourceType type = MediaSourceType.unknownMediaSource}) → Future<void>

启用/禁用插件。

enableFaceDetection(bool enabled) → Future<void>

开启/关闭本地人脸检测。

enableInEarMonitoring({required bool enabled, required EarMonitoringFilterType includeAudioFilters}) → Future<void>

开启耳返功能。

enableInstantMediaRendering() → Future<void>

开启音视频帧加速渲染。

enableLocalAudio(bool enabled) → Future<void>

开启或关闭本地音频采集。

enableLocalVideo(bool enabled) → Future<void>

开关本地视频采集。

enableLoopbackRecording({required bool enabled, String? deviceName}) → Future<void>

开启声卡采集。

enableMultiCamera({required bool enabled, required CameraCapturerConfiguration config}) → Future<void>

开启或关闭多路摄像头采集。

enableSoundPositionIndication(bool enabled) → Future<void>

开启/关闭远端用户的语音立体声。

enableSpatialAudio(bool enabled) → Future<void>

开启或关闭空间音频。

enableVideo() → Future<void>

启用视频模块。

enableVideoImageSource({required bool enable, required ImageTrackOptions options}) → Future<void>

设置是否开启垫片推流功能。

enableVirtualBackground({required bool enabled, required VirtualBackgroundSource backgroundSource, required SegmentationProperty segproperty, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<void>

开启/关闭虚拟背景。

enableVoiceAITuner({required bool enabled, required VoiceAiTunerType type}) → Future<void>

开启或关闭 AI 调音器功能。

enableWebSdkInteroperability(bool enabled) → Future<void>

打开与 Web SDK 的互通（仅在直播场景适用）。

getAudioDeviceInfo() → Future<DeviceInfo>

获取音频设备信息。

getAudioDeviceManager() → AudioDeviceManager

获取 AudioDeviceManager 对象，以管理音频设备。

getAudioMixingCurrentPosition() → Future<int>

获取音乐文件的播放进度。

getAudioMixingDuration() → Future<int>

获取音乐文件总时长。

getAudioMixingPlayoutVolume() → Future<int>

获取音乐文件的本地播放音量。

getAudioMixingPublishVolume() → Future<int>

获取音乐文件的远端播放音量。

getAudioTrackCount() → Future<int>

获取当前音乐文件的音轨索引。

getCallId() → Future<String>

获取通话 ID。

getCameraMaxZoomFactor() → Future<double>

获取摄像头支持的最大放大倍率。

getConnectionState() → Future<ConnectionStateType>

获取当前网络连接状态。

getCurrentMonotonicTimeInMs() → Future<int>

获取 SDK 当前的 Monotonic Time。

getEffectCurrentPosition(int soundId) → Future<int>

获取指定音效文件的播放进度。

getEffectDuration(String filePath) → Future<int>

获取指定音效文件总时长。

getEffectsVolume() → Future<int>

获取音效文件的播放音量。

getErrorDescription(int code) → Future<String>

获取警告或错误描述。

getExtensionProperty({required String provider, required String extension, required String key, required int bufLen, MediaSourceType type = MediaSourceType.unknownMediaSource}) → Future<String>

获取插件的详细信息。

getFaceShapeAreaOptions({required FaceShapeArea shapeArea, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<FaceShapeAreaOptions>

获取美型部位选项。

getFaceShapeBeautyOptions({MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<FaceShapeBeautyOptions>

获取美型效果选项。

getLocalSpatialAudioEngine() → LocalSpatialAudioEngine

获取 LocalSpatialAudioEngine 对象。

getMediaEngine() → MediaEngine

获取 MediaEngine 对象。

getMusicContentCenter() → MusicContentCenter

获取 MusicContentCenter 。

getNativeHandle() → Future<int>

获取 Native SDK 的 C++ 句柄。

getNetworkType() → Future<int>

获取本地网络连接类型。

getNtpWallTimeInMs() → Future<int>

获取当前的 NTP (网络时间协议) 时间。

getScreenCaptureSources({required SIZE thumbSize, required SIZE iconSize, required bool includeScreen}) → Future<List<ScreenCaptureSourceInfo>>

获取可共享的屏幕和窗口对象列表。

getUserInfoByUid(int uid) → Future<UserInfo>

通过 UID 获取用户信息。

getUserInfoByUserAccount(String userAccount) → Future<UserInfo>

通过 User Account 获取用户信息。

getVersion() → Future<SDKBuildInfo>

获取 SDK 版本。

getVideoDeviceManager() → VideoDeviceManager

获取 VideoDeviceManager 对象，以管理视频设备。

getVolumeOfEffect(int soundId) → Future<int>

获取指定音效文件的播放音量。

initialize(RtcEngineContext context) → Future<void>

初始化 RtcEngine 。

isCameraAutoExposureFaceModeSupported() → Future<bool>

检测设备是否支持自动曝光功能。

isCameraAutoFocusFaceModeSupported() → Future<bool>

检测设备是否支持人脸对焦功能。

isCameraCenterStageSupported() → Future<bool>

查询摄像头是否支持人像锁定。

isCameraExposurePositionSupported() → Future<bool>

检测设备是否支持手动曝光功能。

isCameraExposureSupported() → Future<bool>

查询当前摄像头是否支持曝光调节。

isCameraFaceDetectSupported() → Future<bool>

检查设备摄像头是否支持人脸检测。

isCameraFocusSupported() → Future<bool>

检测设备是否支持手动对焦功能。

isCameraTorchSupported() → Future<bool>

检测设备是否支持闪光灯常开。

isCameraZoomSupported() → Future<bool>

检测设备是否支持摄像头缩放功能。

isFeatureAvailableOnDevice(FeatureType type) → Future<bool>

查询设备是否支持指定进阶功能。

isSpeakerphoneEnabled() → Future<bool>

检查扬声器状态启用状态。

joinChannel({required String token, required String channelId, required int uid, required ChannelMediaOptions options}) → Future<void>

设置媒体选项并加入频道。

joinChannelWithUserAccount({required String token, required String channelId, required String userAccount, ChannelMediaOptions? options}) → Future<void>

使用 User Account 和 Token 加入频道，并设置频道媒体选项。

joinChannelWithUserAccountEx({required String token, required String channelId, required String userAccount, required ChannelMediaOptions options}) → Future<void>

使用 User Account 和 Token 加入频道，并设置频道媒体选项。

leaveChannel({LeaveChannelOptions? options}) → Future<void>

设置频道选项并离开频道。

loadExtensionProvider({required String path, bool unloadAfterUse = false}) → Future<void>

加载插件。

muteAllRemoteAudioStreams(bool mute) → Future<void>

取消或恢复订阅所有远端用户的音频流。

muteAllRemoteVideoStreams(bool mute) → Future<void>

取消或恢复订阅所有远端用户的视频流。

muteLocalAudioStream(bool mute) → Future<void>

取消或恢复发布本地音频流。

muteLocalVideoStream(bool mute) → Future<void>

取消或恢复发布本地视频流。

muteRecordingSignal(bool mute) → Future<void>

是否将录音信号静音。

muteRemoteAudioStream({required int uid, required bool mute}) → Future<void>

取消或恢复订阅指定远端用户的音频流。

muteRemoteVideoStream({required int uid, required bool mute}) → Future<void>

取消或恢复订阅指定远端用户的视频流。

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pauseAllChannelMediaRelay() → Future<void>

暂停向所有目标频道转发媒体流。

pauseAllEffects() → Future<void>

暂停所有音效文件播放。

pauseAudioMixing() → Future<void>

暂停播放音乐文件。

pauseEffect(int soundId) → Future<void>

暂停音效文件播放。

playAllEffects({required int loopCount, required double pitch, required double pan, required int gain, bool publish = false}) → Future<void>

播放所有音效文件。

playEffect({required int soundId, required String filePath, required int loopCount, required double pitch, required double pan, required int gain, bool publish = false, int startPos = 0}) → Future<void>

播放指定的本地或在线音效文件。

preloadChannel({required String token, required String channelId, required int uid}) → Future<void>

使用 token 、 channelId 、 uid 预加载频道。

preloadChannelWithUserAccount({required String token, required String channelId, required String userAccount}) → Future<void>

使用 token 、 channelId 、 userAccount 预加载频道。

preloadEffect({required int soundId, required String filePath, int startPos = 0}) → Future<void>

将音效文件加载至内存。

queryCameraFocalLengthCapability() → Future<List<FocalLengthInfo>>

查询摄像头支持的焦距能力。

queryCodecCapability(int size) → Future<List<CodecCapInfo>>

查询 SDK 支持的视频编解码能力。

queryDeviceScore() → Future<int>

查询设备评分等级。

queryScreenCaptureCapability() → Future<int>

查询设备在屏幕共享时支持的最高帧率。

rate({required String callId, required int rating, required String description}) → Future<void>

给通话评分。

registerAudioEncodedFrameObserver({required AudioEncodedFrameObserverConfig config, required AudioEncodedFrameObserver observer}) → void

注册音频编码数据观测器。

registerAudioSpectrumObserver(AudioSpectrumObserver observer) → void

注册音频频谱观测器。

registerEventHandler(RtcEngineEventHandler eventHandler) → void

添加主回调事件。

registerExtension({required String provider, required String extension, MediaSourceType type = MediaSourceType.unknownMediaSource}) → Future<void>

注册插件。

registerLocalUserAccount({required String appId, required String userAccount}) → Future<void>

注册本地用户 User Account。

registerMediaMetadataObserver({required MetadataObserver observer, required MetadataType type}) → void

注册媒体 metadata 观测器用于接收或发送 metadata。

release({bool sync = false}) → Future<void>

销毁 RtcEngine 对象。

removeVideoWatermark(String id) → Future<void>

从本地视频中移除水印图像。

renewToken(String token) → Future<void>

更新 Token。

resumeAllChannelMediaRelay() → Future<void>

恢复向所有目标频道转发媒体流。

resumeAllEffects() → Future<void>

恢复播放所有音效文件。

resumeAudioMixing() → Future<void>

恢复播放音乐文件。

resumeEffect(int soundId) → Future<void>

恢复播放指定音效文件。

selectAudioTrack(int index) → Future<void>

指定当前音乐文件的播放音轨。

sendCustomReportMessage({required String id, required String category, required String event, required String label, required int value}) → Future<void>

发送自定义上报消息。

sendMetaData({required Metadata metadata, required VideoSourceType sourceType}) → Future<void>

发送媒体附属信息。

sendStreamMessage({required int streamId, required Uint8List data, required int length}) → Future<void>

发送数据流。

setAdvancedAudioOptions({required AdvancedAudioOptions options, int sourceType = 0}) → Future<void>

设置音频的高级选项。

setAINSMode({required bool enabled, required AudioAinsMode mode}) → Future<void>

设置是否开启 AI 降噪功能并设置降噪模式。

setAudioEffectParameters({required AudioEffectPreset preset, required int param1, required int param2}) → Future<void>

设置 SDK 预设人声音效的参数。

setAudioEffectPreset(AudioEffectPreset preset) → Future<void>

设置 SDK 预设的人声音效。

setAudioMixingDualMonoMode(AudioMixingDualMonoMode mode) → Future<void>

设置当前音频文件的声道模式。

setAudioMixingPitch(int pitch) → Future<void>

调整本地播放的音乐文件的音调。

setAudioMixingPlaybackSpeed(int speed) → Future<void>

设置当前音乐文件的播放速度。

setAudioMixingPosition(int pos) → Future<void>

设置音乐文件的播放位置。

setAudioProfile({required AudioProfileType profile, AudioScenarioType scenario = AudioScenarioType.audioScenarioDefault}) → Future<void>

设置音频编码属性和音频场景。

setAudioScenario(AudioScenarioType scenario) → Future<void>

设置音频场景。

setAudioSessionOperationRestriction(AudioSessionOperationRestriction restriction) → Future<void>

设置 SDK 对 Audio Session 的操作权限。

setAVSyncSource({required String channelId, required int uid}) → Future<void>

设置发流端音画同步。

setBeautyEffectOptions({required bool enabled, required BeautyOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<void>

设置美颜效果选项。

setCameraAutoExposureFaceModeEnabled(bool enabled) → Future<void>

设置是否开启自动曝光功能。

setCameraAutoFocusFaceModeEnabled(bool enabled) → Future<void>

设置是否开启人脸对焦功能。

setCameraCapturerConfiguration(CameraCapturerConfiguration config) → Future<void>

设置摄像头采集配置。

setCameraDeviceOrientation({required VideoSourceType type, required VideoOrientation orientation}) → Future<void>

设置采集视频的旋转角度。

setCameraExposureFactor(double factor) → Future<void>

设置当前摄像头的曝光系数。

setCameraExposurePosition({required double positionXinView, required double positionYinView}) → Future<void>

设置手动曝光位置。

setCameraFocusPositionInPreview({required double positionX, required double positionY}) → Future<void>

设置手动对焦位置，并触发对焦。

setCameraStabilizationMode(CameraStabilizationMode mode) → Future<void>

设置摄像头防抖模式。

setCameraTorchOn(bool isOn) → Future<void>

设置是否打开闪光灯。

setCameraZoomFactor(double factor) → Future<void>

设置摄像头放大比例。

setChannelProfile(ChannelProfileType profile) → Future<void>

设置频道场景。

setClientRole({required ClientRoleType role, ClientRoleOptions? options}) → Future<void>

设置直播场景下的用户角色和观众端延时级别。

setCloudProxy(CloudProxyType proxyType) → Future<void>

设置云代理服务。

setColorEnhanceOptions({required bool enabled, required ColorEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<void>

设置色彩增强功能。

setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker) → Future<void>

设置默认的音频路由。

setDirectCdnStreamingAudioConfiguration(AudioProfileType profile) → Future<void>

设置主播端直接向 CDN 推流时的音频编码属性。

setDirectCdnStreamingVideoConfiguration(VideoEncoderConfiguration config) → Future<void>

设置主播端直接向 CDN 推流时的视频编码属性。

setDualStreamMode({required SimulcastStreamMode mode, SimulcastStreamConfig? streamConfig}) → Future<void>

在发送端设置双流模式并设置视频小流。

setEarMonitoringAudioFrameParameters({required int sampleRate, required int channel, required RawAudioFrameOpModeType mode, required int samplesPerCall}) → Future<void>

设置耳返的音频数据格式。

setEffectPosition({required int soundId, required int pos}) → Future<void>

设置指定音效文件的播放位置。

setEffectsVolume(int volume) → Future<void>

设置音效文件的播放音量。

setEnableSpeakerphone(bool speakerOn) → Future<void>

开启或关闭扬声器播放。

setExtensionProperty({required String provider, required String extension, required String key, required String value, MediaSourceType type = MediaSourceType.unknownMediaSource}) → Future<void>

设置插件的属性。

setExtensionProviderProperty({required String provider, required String key, required String value}) → Future<void>

设置插件服务商的属性。

setExternalMediaProjection(int mediaProjection) → Future<void>

设置 SDK 外部的 MediaProjection 采集屏幕视频流。

setFaceShapeAreaOptions({required FaceShapeAreaOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<void>

设置美型部位选项并指定媒体源。

setFaceShapeBeautyOptions({required bool enabled, required FaceShapeBeautyOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<void>

设置美型效果选项并指定媒体源。

setFilterEffectOptions({required bool enabled, required FilterEffectOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<void>

设置滤镜效果选项并指定媒体源。

setHeadphoneEQParameters({required int lowGain, required int highGain}) → Future<void>

设置耳机均衡器的低频和高频参数。

setHeadphoneEQPreset(HeadphoneEqualizerPreset preset) → Future<void>

设置预设的耳机均衡效果。

setInEarMonitoringVolume(int volume) → Future<void>

设置耳返音量。

setLocalAccessPoint(LocalAccessPointConfiguration config) → Future<void>

配置与声网私有媒体服务器接入模块的连接。

setLocalRenderMode({required RenderModeType renderMode, VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAuto}) → Future<void>

更新本地视图显示模式。

setLocalRenderTargetFps({required VideoSourceType sourceType, required int targetFps}) → Future<void>

设置本地视频渲染的最大帧率。

setLocalVideoMirrorMode(VideoMirrorModeType mirrorMode) → Future<void>

设置本地视频镜像。

setLocalVoiceEqualization({required AudioEqualizationBandFrequency bandFrequency, required int bandGain}) → Future<void>

设置本地语音音效均衡。

setLocalVoiceFormant(double formantRatio) → Future<void>

设置共振峰比率以改变语音的音色。

setLocalVoicePitch(double pitch) → Future<void>

设置本地语音音调。

setLocalVoiceReverb({required AudioReverbType reverbKey, required int value}) → Future<void>

设置本地音效混响。

setLogFile(String filePath) → Future<void>

设置日志文件

setLogFileSize(int fileSizeInKBytes) → Future<void>

设置 SDK 输出的日志文件的大小。

setLogFilter(LogFilterType filter) → Future<void>

设置日志输出等级。

setLogLevel(LogLevel level) → Future<void>

设置 SDK 的日志输出级别。

setLowlightEnhanceOptions({required bool enabled, required LowlightEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<void>

设置暗光增强功能。

setMaxMetadataSize(int size) → Future<void>

设置媒体附属信息的最大大小。

setMixedAudioFrameParameters({required int sampleRate, required int channel, required int samplesPerCall}) → Future<void>

设置采集和播放音频混音后的原始音频数据格式。

setParameters(String parameters) → Future<void>

SDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。

setPlaybackAudioFrameBeforeMixingParameters({required int sampleRate, required int channel, required int samplesPerCall}) → Future<void>

设置混音前的原始音频播放数据格式。

setPlaybackAudioFrameParameters({required int sampleRate, required int channel, required RawAudioFrameOpModeType mode, required int samplesPerCall}) → Future<void>

设置播放的原始音频数据格式。

setRecordingAudioFrameParameters({required int sampleRate, required int channel, required RawAudioFrameOpModeType mode, required int samplesPerCall}) → Future<void>

设置采集的原始音频数据格式。

setRemoteDefaultVideoStreamType(VideoStreamType streamType) → Future<void>

设置默认订阅的视频流类型。

setRemoteRenderMode({required int uid, required RenderModeType renderMode, required VideoMirrorModeType mirrorMode}) → Future<void>

更新远端视图显示模式。

setRemoteRenderTargetFps(int targetFps) → Future<void>

设置视频在远端渲染的最大帧率。

setRemoteSubscribeFallbackOption(StreamFallbackOptions option) → Future<void>

设置弱网环境下订阅的音视频流回退选项。

setRemoteUserSpatialAudioParams({required int uid, required SpatialAudioParams params}) → Future<void>

设置远端用户的空间音频参数。

setRemoteVideoStreamType({required int uid, required VideoStreamType streamType}) → Future<void>

设置订阅的视频流类型。

setRemoteVideoSubscriptionOptions({required int uid, required VideoSubscriptionOptions options}) → Future<void>

设置远端视频流的订阅选项。

setRemoteVoicePosition({required int uid, required double pan, required double gain}) → Future<void>

设置远端用户声音的 2D 位置，即水平面位置。

setRouteInCommunicationMode(int route) → Future<void>

选择通话音量模式下的音频路由。

setScreenCaptureContentHint(VideoContentHint contentHint) → Future<void>

设置屏幕共享内容类型。

setScreenCaptureScenario(ScreenScenarioType screenScenario) → Future<void>

设置屏幕共享的场景。

setSubscribeAudioAllowlist({required List<int> uidList, required int uidNumber}) → Future<void>

设置音频订阅白名单。

setSubscribeAudioBlocklist({required List<int> uidList, required int uidNumber}) → Future<void>

设置音频订阅黑名单。

setSubscribeVideoAllowlist({required List<int> uidList, required int uidNumber}) → Future<void>

设置视频订阅白名单。

setSubscribeVideoBlocklist({required List<int> uidList, required int uidNumber}) → Future<void>

设置视频订阅黑名单。

setupLocalVideo(VideoCanvas canvas) → Future<void>

初始化本地视图。

setupRemoteVideo(VideoCanvas canvas) → Future<void>

初始化远端用户视图。

setVideoDenoiserOptions({required bool enabled, required VideoDenoiserOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future<void>

设置视频降噪功能。

setVideoEncoderConfiguration(VideoEncoderConfiguration config) → Future<void>

设置视频编码属性。

setVideoScenario(VideoApplicationScenarioType scenarioType) → Future<void>

设置视频业务场景。

setVoiceBeautifierParameters({required VoiceBeautifierPreset preset, required int param1, required int param2}) → Future<void>

设置预设美声效果的参数。

setVoiceBeautifierPreset(VoiceBeautifierPreset preset) → Future<void>

设置预设的美声效果。

setVoiceConversionPreset(VoiceConversionPreset preset) → Future<void>

设置预设的变声效果。

setVolumeOfEffect({required int soundId, required int volume}) → Future<void>

设置指定音效文件的播放音量。

startAudioMixing({required String filePath, required bool loopback, required int cycle, int startPos = 0}) → Future<void>

开始播放音乐文件。

startAudioRecording(AudioRecordingConfiguration config) → Future<void>

开始客户端录音并进行录音配置。

startCameraCapture({required VideoSourceType sourceType, required CameraCapturerConfiguration config}) → Future<void>

开始通过摄像头采集视频。

startDirectCdnStreaming({required DirectCdnStreamingEventHandler eventHandler, required String publishUrl, required DirectCdnStreamingMediaOptions options}) → Future<void>

设置主播端开始直接向 CDN 推流。

startDumpVideo(int type, String dir) → Future<void>

Available on RtcEngine, provided by the RtcEngineDebug extension

startEchoTest(EchoTestConfiguration config) → Future<void>

开始音视频通话回路测试。

startLastmileProbeTest(LastmileProbeConfig config) → Future<void>

开始通话前网络质量探测。

startLocalAudioMixer(LocalAudioMixerConfiguration config) → Future<void>

开启本地音频合流。

startLocalVideoTranscoder(LocalTranscoderConfiguration config) → Future<void>

开启本地合图。

startMediaRenderingTracing() → Future<void>

开启视频帧渲染数据打点。

startOrUpdateChannelMediaRelay(ChannelMediaRelayConfiguration configuration) → Future<void>

开始或更新跨频道媒体流转发。

startPreview({VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary}) → Future<void>

开启视频预览并指定预览的视频源。

startPreviewWithoutSourceType() → Future<void>

开启视频预览。

startRhythmPlayer({required String sound1, required String sound2, required AgoraRhythmPlayerConfig config}) → Future<void>

开启虚拟节拍器。

startRtmpStreamWithoutTranscoding(String url) → Future<void>

开始非转码推流。

startRtmpStreamWithTranscoding({required String url, required LiveTranscoding transcoding}) → Future<void>

开始旁路推流并设置转码属性。

startScreenCapture(ScreenCaptureParameters2 captureParams) → Future<void>

开始屏幕采集。

startScreenCaptureByDisplayId({required int displayId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}) → Future<void>

开始采集指定屏幕的视频流。

startScreenCaptureByScreenRect({required Rectangle screenRect, required Rectangle regionRect, required ScreenCaptureParameters captureParams}) → Future<void>

开始采集指定屏幕区域的视频流。

startScreenCaptureBySourceType({required VideoSourceType sourceType, required ScreenCaptureConfiguration config}) → Future<void>

开始屏幕采集并指定视频源。

startScreenCaptureByWindowId({required int windowId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}) → Future<void>

开始采集指定窗口的视频流。

stopAllEffects() → Future<void>

停止播放所有音效文件。

stopAudioMixing() → Future<void>

停止播放音乐文件。

stopAudioRecording() → Future<void>

停止客户端录音。

stopCameraCapture(VideoSourceType sourceType) → Future<void>

停止通过摄像头采集视频。

stopChannelMediaRelay() → Future<void>

停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。

stopDirectCdnStreaming() → Future<void>

设置主播端停止直接向 CDN 推流。

stopDumpVideo() → Future<void>

Available on RtcEngine, provided by the RtcEngineDebug extension

stopEchoTest() → Future<void>

停止语音通话回路测试。

stopEffect(int soundId) → Future<void>

停止播放指定音效文件。

stopLastmileProbeTest() → Future<void>

停止通话前网络质量探测。

stopLocalAudioMixer() → Future<void>

停止本地音频合流。

stopLocalVideoTranscoder() → Future<void>

停止本地合图。

stopPreview({VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary}) → Future<void>

停止视频预览。

stopRhythmPlayer() → Future<void>

关闭虚拟节拍器。

stopRtmpStream(String url) → Future<void>

结束旁路推流。

stopScreenCapture() → Future<void>

停止屏幕采集。

stopScreenCaptureBySourceType(VideoSourceType sourceType) → Future<void>

停止对指定的视频源进行屏幕采集。

switchCamera() → Future<void>

切换前置/后置摄像头。

takeSnapshot({required int uid, required String filePath}) → Future<void>

对视频截图。

takeSnapshotWithConfig({required int uid, required SnapshotConfig config}) → Future<void>

在指定观测位置进行视频截图。

toString() → String

A string representation of this object.

inherited

unloadAllEffects() → Future<void>

从内存释放所有预加载音效文件。

unloadEffect(int soundId) → Future<void>

从内存释放某个预加载的音效文件。

unregisterAudioEncodedFrameObserver(AudioEncodedFrameObserver observer) → void

取消注册音频编码数据观测器。

unregisterAudioSpectrumObserver(AudioSpectrumObserver observer) → void

取消注册音频频谱观测器。

unregisterEventHandler(RtcEngineEventHandler eventHandler) → void

删除指定的回调事件。

unregisterMediaMetadataObserver({required MetadataObserver observer, required MetadataType type}) → void

取消注册媒体 metadata 观测器。

updateChannelMediaOptions(ChannelMediaOptions options) → Future<void>

加入频道后更新频道媒体选项。

updateLocalAudioMixerConfiguration(LocalAudioMixerConfiguration config) → Future<void>

更新本地音频合流的配置。

updateLocalTranscoderConfiguration(LocalTranscoderConfiguration config) → Future<void>

更新本地合图配置。

updatePreloadChannelToken(String token) → Future<void>

更新预加载频道的通配 Token。

updateRtmpTranscoding(LiveTranscoding transcoding) → Future<void>

更新旁路推流转码属性。

updateScreenCapture(ScreenCaptureParameters2 captureParams) → Future<void>

更新屏幕采集的参数配置。

updateScreenCaptureParameters(ScreenCaptureParameters captureParams) → Future<void>

更新屏幕采集的参数配置。

updateScreenCaptureRegion(Rectangle regionRect) → Future<void>

更新屏幕采集的区域。

Operators

operator ==(Object other) → bool

The equality operator.

inherited