RtcEngine class abstract

The base interface class of the RTC SDK that implements core real-time audio and video features.

RtcEngine provides the main methods for app calls. You must call createAgoraRtcEngine to create a RtcEngine object before calling other APIs.

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>

Adds a local video watermark.

adjustAudioMixingPlayoutVolume(int volume) → Future<void>

Adjusts the local playback volume of the music file.

adjustAudioMixingPublishVolume(int volume) → Future<void>

Adjusts the remote playback volume of the music file.

adjustAudioMixingVolume(int volume) → Future<void>

Adjusts the playback volume of the music file.

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

Adjusts the local playback volume of a custom audio track.

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

Adjusts the remote playback volume of a custom audio track.

adjustLoopbackSignalVolume(int volume) → Future<void>

Adjusts the volume of the signal captured by the sound card.

adjustPlaybackSignalVolume(int volume) → Future<void>

Adjusts the signal volume of all remote users for local playback.

adjustRecordingSignalVolume(int volume) → Future<void>

Adjusts the volume of the audio recording signal.

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

Adjusts the playback volume of a specified remote user locally.

clearVideoWatermarks() → Future<void>

Removes added video watermarks.

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

Report call quality issues.

configRhythmPlayer(AgoraRhythmPlayerConfig config) → Future<void>

Configures the virtual metronome.

createCustomVideoTrack() → Future<int>

Creates a custom video track.

createDataStream(DataStreamConfig config) → Future<int>

Creates a data stream.

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

Creates an IVideoEffectObject video effect object.

destroyCustomVideoTrack(int videoTrackId) → Future<void>

Destroys the specified video track.

destroyMediaPlayer(MediaPlayer mediaPlayer) → Future<void>

Destroys the media player.

destroyVideoEffectObject(VideoEffectObject videoEffectObject) → Future<void>

Destroys the video effect object.

disableAudio() → Future<void>

Disables the audio module.

disableAudioSpectrumMonitor() → Future<void>

Disables audio spectrum monitoring.

disableVideo() → Future<void>

Disables the video module.

enableAudio() → Future<void>

Enables the audio module.

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

Enables audio spectrum monitoring.

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

Enables audio volume indication.

enableCameraCenterStage(bool enabled) → Future<void>

Enables or disables the Center Stage feature.

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

Enables/disables local snapshot upload.

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

Sets whether to play the external audio source locally.

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

Enables or disables dual-stream mode on the sending end and configures the low-quality stream.

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

Enable or disable built-in encryption.

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

Enables or disables an extension.

enableFaceDetection(bool enabled) → Future<void>

Enables/disables local face detection.

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

Enables in-ear monitoring.

enableInstantMediaRendering() → Future<void>

Enables accelerated rendering of audio and video frames.

enableLocalAudio(bool enabled) → Future<void>

Enables or disables local audio capture.

enableLocalVideo(bool enabled) → Future<void>

Enables or disables local video capture.

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

Enables sound card capture.

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

Enables or disables multi-camera capture.

enableSoundPositionIndication(bool enabled) → Future<void>

Enables/disables stereo sound for remote users.

enableSpatialAudio(bool enabled) → Future<void>

Enables or disables spatial audio.

enableVideo() → Future<void>

Enables the video module.

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

Enables or disables the placeholder image streaming feature.

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

Enables/disables virtual background.

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

Enables or disables the AI tuner feature.

enableWebSdkInteroperability(bool enabled) → Future<void>

Enable interoperability with Web SDK (applicable only in live broadcast scenarios).

getAudioDeviceInfo() → Future<DeviceInfo>

Gets audio device information.

getAudioDeviceManager() → AudioDeviceManager

Gets the AudioDeviceManager object to manage audio devices.

getAudioMixingCurrentPosition() → Future<int>

Gets the playback progress of the music file.

getAudioMixingDuration() → Future<int>

Gets the total duration of the music file.

getAudioMixingPlayoutVolume() → Future<int>

Gets the local playback volume of the music file.

getAudioMixingPublishVolume() → Future<int>

Gets the remote playback volume of the music file.

getAudioTrackCount() → Future<int>

Gets the audio track index of the current music file.

getCallId() → Future<String>

Gets the call ID.

getCameraMaxZoomFactor() → Future<double>

Gets the maximum zoom factor supported by the camera.

getConnectionState() → Future<ConnectionStateType>

Gets the current network connection state.

getCurrentMonotonicTimeInMs() → Future<int>

Gets the SDK's current monotonic time.

getEffectCurrentPosition(int soundId) → Future<int>

Gets the playback progress of the specified sound effect file.

getEffectDuration(String filePath) → Future<int>

Gets the total duration of the specified sound effect file.

getEffectsVolume() → Future<int>

Gets the playback volume of audio effect files.

getErrorDescription(int code) → Future<String>

Gets the warning or error description.

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

Retrieves detailed information about the extension.

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

Gets face shaping area options.

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

Gets face shaping effect options.

getLocalSpatialAudioEngine() → LocalSpatialAudioEngine

Gets the LocalSpatialAudioEngine object.

getMediaEngine() → MediaEngine

Gets the MediaEngine object.

getNativeHandle() → Future<int>

Gets the C++ handle of the Native SDK.

getNetworkType() → Future<int>

Gets the local network connection type.

getNtpWallTimeInMs() → Future<int>

Gets the current NTP (Network Time Protocol) time.

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

Gets the list of shareable screen and window objects.

getUserInfoByUid(int uid) → Future<UserInfo>

Gets user information by UID.

getUserInfoByUserAccount(String userAccount) → Future<UserInfo>

Gets user information by User Account.

getVersion() → Future<SDKBuildInfo>

Gets the SDK version.

getVideoDeviceManager() → VideoDeviceManager

Gets a VideoDeviceManager object to manage video devices.

getVolumeOfEffect(int soundId) → Future<int>

Gets the playback volume of the specified audio effect file.

initialize(RtcEngineContext context) → Future<void>

Initializes the RtcEngine.

isCameraAutoExposureFaceModeSupported() → Future<bool>

Checks whether the device supports auto exposure.

isCameraAutoFocusFaceModeSupported() → Future<bool>

Checks whether the device supports face auto-focus.

isCameraCenterStageSupported() → Future<bool>

Checks whether the camera supports Center Stage.

isCameraExposurePositionSupported() → Future<bool>

Checks whether the device supports manual exposure.

isCameraExposureSupported() → Future<bool>

Checks whether the current camera supports exposure adjustment.

isCameraFaceDetectSupported() → Future<bool>

Checks whether the device camera supports face detection.

isCameraFocusSupported() → Future<bool>

Checks whether the device supports manual focus.

isCameraTorchSupported() → Future<bool>

Checks whether the device supports keeping the flashlight on.

isCameraZoomSupported() → Future<bool>

Checks whether the device supports camera zoom.

isFeatureAvailableOnDevice(FeatureType type) → Future<bool>

Checks whether the device supports the specified advanced feature.

isSpeakerphoneEnabled() → Future<bool>

Checks whether the speakerphone is enabled.

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

Sets media options and joins a channel.

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

Joins a channel using a User Account and token, and sets channel media options.

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

Joins a channel using a User Account and token, and sets channel media options.

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

Sets channel options and leaves the channel.

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

Loads an extension.

muteAllRemoteAudioStreams(bool mute) → Future<void>

Stops or resumes subscribing to all remote users' audio streams.

muteAllRemoteVideoStreams(bool mute) → Future<void>

Stops or resumes subscribing to all remote users' video streams.

muteLocalAudioStream(bool mute) → Future<void>

Stops or resumes publishing the local audio stream.

muteLocalVideoStream(bool mute) → Future<void>

Stops or resumes publishing the local video stream.

muteRecordingSignal(bool mute) → Future<void>

Mutes the recording signal.

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

Stops or resumes subscribing to the audio stream of a specified remote user.

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

Stops or resumes subscribing to the video stream of a specified remote user.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pauseAllChannelMediaRelay() → Future<void>

Pauses media stream relay to all destination channels.

pauseAllEffects() → Future<void>

Pauses playback of all audio effect files.

pauseAudioMixing() → Future<void>

Pauses the playback of the music file.

pauseEffect(int soundId) → Future<void>

Pauses playback of the audio effect file.

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

Plays all audio effect files.

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>

Plays the specified local or online audio effect file.

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

Preloads a channel using token, channelId, and uid.

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

Preloads a channel using token, channelId, and userAccount.

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

Loads the audio effect file into memory.

queryCameraFocalLengthCapability() → Future<List<FocalLengthInfo>>

Queries the focal length capabilities supported by the camera.

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

Queries the video codec capabilities supported by the SDK.

queryDeviceScore() → Future<int>

Queries the device score level.

queryScreenCaptureCapability() → Future<int>

Queries the maximum frame rate supported by the device during screen sharing.

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

Rates a call.

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

Registers the audio encoded frame observer.

registerAudioSpectrumObserver(AudioSpectrumObserver observer) → void

Registers an audio spectrum observer.

registerEventHandler(RtcEngineEventHandler eventHandler) → void

Adds the main callback event.

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

Registers an extension.

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

Registers the local user account.

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

Registers a media metadata observer to receive or send metadata.

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

Destroys the RtcEngine object.

renewToken(String token) → Future<void>

Updates the token.

resumeAllChannelMediaRelay() → Future<void>

Resumes media stream relay to all destination channels.

resumeAllEffects() → Future<void>

Resumes playback of all audio effect files.

resumeAudioMixing() → Future<void>

Resumes the playback of the music file.

resumeEffect(int soundId) → Future<void>

Resumes playback of the specified audio effect file.

selectAudioTrack(int index) → Future<void>

Specifies the playback audio track of the current music file.

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

Sends a custom report message.

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

Sends media metadata.

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

Sends a data stream.

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

Sets advanced audio options.

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

Enables or disables AI noise reduction and sets the noise reduction mode.

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

Sets the parameters for SDK preset voice effects.

setAudioEffectPreset(AudioEffectPreset preset) → Future<void>

Sets the SDK preset voice effect.

setAudioMixingDualMonoMode(AudioMixingDualMonoMode mode) → Future<void>

Sets the channel mode of the current audio file.

setAudioMixingPitch(int pitch) → Future<void>

Adjusts the pitch of the locally played music file.

setAudioMixingPlaybackSpeed(int speed) → Future<void>

Sets the playback speed of the current music file.

setAudioMixingPosition(int pos) → Future<void>

Sets the playback position of the music file.

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

Sets the audio encoding profile and audio scenario.

setAudioScenario(AudioScenarioType scenario) → Future<void>

Sets the audio scenario.

setAudioSessionOperationRestriction(AudioSessionOperationRestriction restriction) → Future<void>

Sets the SDK's permission to operate the Audio Session.

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

Sets beauty effect options.

setCameraAutoExposureFaceModeEnabled(bool enabled) → Future<void>

Enables or disables the auto exposure feature.

setCameraAutoFocusFaceModeEnabled(bool enabled) → Future<void>

Sets whether to enable face auto-focus.

setCameraCapturerConfiguration(CameraCapturerConfiguration config) → Future<void>

Sets the camera capture configuration.

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

Sets the rotation angle of the captured video.

setCameraExposureFactor(double factor) → Future<void>

Sets the exposure factor of the current camera.

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

Sets the manual exposure position.

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

Sets the manual focus position and triggers focusing.

setCameraStabilizationMode(CameraStabilizationMode mode) → Future<void>

Sets the camera stabilization mode.

setCameraTorchOn(bool isOn) → Future<void>

Sets whether to turn on the flashlight.

setCameraZoomFactor(double factor) → Future<void>

Sets the camera zoom factor.

setChannelProfile(ChannelProfileType profile) → Future<void>

Sets the channel profile.

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

Sets the user role and audience latency level in live streaming.

setCloudProxy(CloudProxyType proxyType) → Future<void>

Sets the cloud proxy service.

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

Sets the color enhancement feature.

setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker) → Future<void>

Sets the default audio route.

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

Sets the dual-stream mode on the sender and configures the low-quality video stream.

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

Sets the data format for the onEarMonitoringAudioFrame callback.

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

Sets the playback position of the specified audio effect file.

setEffectsVolume(int volume) → Future<void>

Sets the playback volume of audio effect files.

setEnableSpeakerphone(bool speakerOn) → Future<void>

Enables or disables speakerphone playback.

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

Sets an extension property.

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

Sets a property for the extension provider.

setExternalMediaProjection(int mediaProjection) → Future<void>

Sets an external MediaProjection to capture screen video stream.

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

Sets face shaping area options and specifies the media source.

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

Sets face shaping effect options and specifies the media source.

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

Sets filter effect options and specifies the media source.

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

Sets the low-frequency and high-frequency parameters of the headphone equalizer.

setHeadphoneEQPreset(HeadphoneEqualizerPreset preset) → Future<void>

Sets the preset headphone equalizer effect.

setInEarMonitoringVolume(int volume) → Future<void>

Sets the in-ear monitoring volume.

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

Updates the local view display mode.

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

Sets the maximum frame rate for local video rendering.

setLocalVideoMirrorMode(VideoMirrorModeType mirrorMode) → Future<void>

Sets the local video mirror mode.

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

Sets the local voice equalization.

setLocalVoiceFormant(double formantRatio) → Future<void>

Sets the formant ratio to change the voice timbre.

setLocalVoicePitch(double pitch) → Future<void>

Sets the local voice pitch.

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

Sets the local voice reverb effect.

setLogFile(String filePath) → Future<void>

Sets the log file.

setLogFileSize(int fileSizeInKBytes) → Future<void>

Sets the size of the SDK log file output.

setLogFilter(LogFilterType filter) → Future<void>

Sets the log output level.

setLogLevel(LogLevel level) → Future<void>

Sets the SDK log output level.

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

Sets the low-light enhancement feature.

setMaxMetadataSize(int size) → Future<void>

Sets the maximum size of media metadata.

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

Sets the format of the raw audio data after audio mixing for capture and playback.

setParameters(String parameters) → Future<void>

JSON configuration information for the SDK, used to provide technical preview or customized features.

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

Sets the format of the raw audio playback data before mixing.

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

Sets the format of the raw audio data for playback.

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

Sets the format of the raw audio data for capture.

setRemoteDefaultVideoStreamType(VideoStreamType streamType) → Future<void>

Sets the default video stream type to subscribe to.

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

Updates the display mode of the remote view.

setRemoteRenderTargetFps(int targetFps) → Future<void>

Sets the maximum frame rate for remote video rendering.

setRemoteSubscribeFallbackOption(StreamFallbackOptions option) → Future<void>

Sets the fallback option for subscribed audio and video streams under poor network conditions.

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

Sets the spatial audio parameters for a remote user.

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

Sets the video stream type to subscribe to.

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

Sets the subscription options for the remote video stream.

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

Sets the 2D position of a remote user's voice on the horizontal plane.

setRouteInCommunicationMode(int route) → Future<void>

Selects the audio route in communication volume mode.

setScreenCaptureContentHint(VideoContentHint contentHint) → Future<void>

Sets the content type for screen sharing.

setScreenCaptureScenario(ScreenScenarioType screenScenario) → Future<void>

Sets the screen sharing scenario.

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

Sets the audio subscription allowlist.

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

Sets the audio subscription blocklist.

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

Sets the video subscription allowlist.

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

Sets the video subscription blocklist.

setupLocalVideo(VideoCanvas canvas) → Future<void>

Initializes the local view.

setupRemoteVideo(VideoCanvas canvas) → Future<void>

Initializes the remote user view.

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

Sets the video denoising feature.

setVideoEncoderConfiguration(VideoEncoderConfiguration config) → Future<void>

Sets the video encoding attributes.

setVideoScenario(VideoApplicationScenarioType scenarioType) → Future<void>

Sets the video application scenario.

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

Sets the parameters for the preset voice beautifier effect.

setVoiceBeautifierPreset(VoiceBeautifierPreset preset) → Future<void>

Sets the preset voice beautifier effect.

setVoiceConversionPreset(VoiceConversionPreset preset) → Future<void>

Sets the preset voice conversion effect.

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

Sets the playback volume of the specified audio effect file.

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

Starts playing a music file.

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

Starts video capture using the camera.

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

Available on RtcEngine, provided by the RtcEngineDebug extension

startEchoTest(EchoTestConfiguration config) → Future<void>

Starts an audio and video call loop test.

startLastmileProbeTest(LastmileProbeConfig config) → Future<void>

Starts the last-mile network probe test before a call.

startLocalAudioMixer(LocalAudioMixerConfiguration config) → Future<void>

Starts local audio mixing.

startLocalVideoTranscoder(LocalTranscoderConfiguration config) → Future<void>

Starts local video mixing.

startMediaRenderingTracing() → Future<void>

Starts video frame rendering tracing.

startOrUpdateChannelMediaRelay(ChannelMediaRelayConfiguration configuration) → Future<void>

Starts or updates cross-channel media stream relay.

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

Starts video preview and specifies the video source.

startPreviewWithoutSourceType() → Future<void>

Starts video preview.

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

Starts the virtual metronome.

startRtmpStreamWithoutTranscoding(String url) → Future<void>

Starts pushing streams without transcoding.

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

Starts pushing streams with transcoding settings.

startScreenCapture(ScreenCaptureParameters2 captureParams) → Future<void>

Starts screen capture.

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

Starts capturing the video stream of the specified screen.

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

Starts capturing the video stream of a specified screen region.

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

Starts screen capture and specifies the video source.

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

Starts capturing the video stream of a specified window.

stopAllEffects() → Future<void>

Stops playback of all audio effect files.

stopAudioMixing() → Future<void>

Stops playing the music file.

stopCameraCapture(VideoSourceType sourceType) → Future<void>

Stops video capture using the camera.

stopChannelMediaRelay() → Future<void>

Stops cross-channel media stream relay. Once stopped, the broadcaster leaves all destination channels.

stopDumpVideo() → Future<void>

Available on RtcEngine, provided by the RtcEngineDebug extension

stopEchoTest() → Future<void>

Stops the audio call loopback test.

stopEffect(int soundId) → Future<void>

Stops playback of the specified audio effect file.

stopLastmileProbeTest() → Future<void>

Stops the last-mile network probe test before a call.

stopLocalAudioMixer() → Future<void>

Stops local audio mixing.

stopLocalVideoTranscoder() → Future<void>

Stops local video mixing.

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

Stops video preview.

stopRhythmPlayer() → Future<void>

Stops the virtual metronome.

stopRtmpStream(String url) → Future<void>

Stops the CDN stream.

stopScreenCapture() → Future<void>

Stops screen capture.

stopScreenCaptureBySourceType(VideoSourceType sourceType) → Future<void>

Stops screen capture for the specified video source.

switchCamera() → Future<void>

Switches between front and rear cameras.

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

Takes a snapshot of the video.

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

Takes a video snapshot at the specified observation point.

toString() → String

A string representation of this object.

inherited

unloadAllEffects() → Future<void>

Releases all preloaded audio effect files from memory.

unloadEffect(int soundId) → Future<void>

Releases a specific preloaded audio effect file from memory.

unregisterAudioEncodedFrameObserver(AudioEncodedFrameObserver observer) → void

Unregisters the audio encoded frame observer.

unregisterAudioSpectrumObserver(AudioSpectrumObserver observer) → void

Unregisters the audio spectrum observer.

unregisterEventHandler(RtcEngineEventHandler eventHandler) → void

Removes the specified callback event.

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

Unregisters the media metadata observer.

updateChannelMediaOptions(ChannelMediaOptions options) → Future<void>

Updates channel media options after joining the channel.

updateLocalAudioMixerConfiguration(LocalAudioMixerConfiguration config) → Future<void>

Updates the configuration of local audio mixing.

updateLocalTranscoderConfiguration(LocalTranscoderConfiguration config) → Future<void>

Updates local video mixing configuration.

updatePreloadChannelToken(String token) → Future<void>

Updates the wildcard token for the preloaded channel.

updateRtmpTranscoding(LiveTranscoding transcoding) → Future<void>

Updates the RTMP transcoding configuration.

updateScreenCapture(ScreenCaptureParameters2 captureParams) → Future<void>

Updates the parameter configuration for screen capture.

updateScreenCaptureParameters(ScreenCaptureParameters captureParams) → Future<void>

Updates the parameter configuration for screen capture.

updateScreenCaptureRegion(Rectangle regionRect) → Future<void>

Updates the region for screen capture.

Operators

operator ==(Object other) → bool

The equality operator.

inherited