RtcEngineEx class abstract
Interface class that provides multi-channel methods.
Inherits from RtcEngine.
- Implemented types
- Available extensions
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addVideoWatermark(
{required String watermarkUrl, required WatermarkOptions options}) → Future< void> -
Adds a local video watermark.
inherited
-
addVideoWatermarkEx(
{required String watermarkUrl, required WatermarkOptions options, required RtcConnection connection}) → Future< void> - Adds a local video watermark.
-
adjustAudioMixingPlayoutVolume(
int volume) → Future< void> -
Adjusts the local playback volume of the music file.
inherited
-
adjustAudioMixingPublishVolume(
int volume) → Future< void> -
Adjusts the remote playback volume of the music file.
inherited
-
adjustAudioMixingVolume(
int volume) → Future< void> -
Adjusts the playback volume of the music file.
inherited
-
adjustCustomAudioPlayoutVolume(
{required int trackId, required int volume}) → Future< void> -
Adjusts the local playback volume of a custom audio track.
inherited
-
adjustCustomAudioPublishVolume(
{required int trackId, required int volume}) → Future< void> -
Adjusts the remote playback volume of a custom audio track.
inherited
-
adjustLoopbackSignalVolume(
int volume) → Future< void> -
Adjusts the volume of the signal captured by the sound card.
inherited
-
adjustPlaybackSignalVolume(
int volume) → Future< void> -
Adjusts the signal volume of all remote users for local playback.
inherited
-
adjustRecordingSignalVolume(
int volume) → Future< void> -
Adjusts the volume of the audio recording signal.
inherited
-
adjustUserPlaybackSignalVolume(
{required int uid, required int volume}) → Future< void> -
Adjusts the playback volume of a specified remote user locally.
inherited
-
adjustUserPlaybackSignalVolumeEx(
{required int uid, required int volume, required RtcConnection connection}) → Future< void> - Adjusts the playback volume of a specified remote user locally.
-
clearVideoWatermarkEx(
RtcConnection connection) → Future< void> - Removes added video watermarks.
-
clearVideoWatermarks(
) → Future< void> -
Removes added video watermarks.
inherited
-
complain(
{required String callId, required String description}) → Future< void> -
Report call quality issues.
inherited
-
configRhythmPlayer(
AgoraRhythmPlayerConfig config) → Future< void> -
Configures the virtual metronome.
inherited
-
createCustomVideoTrack(
) → Future< int> -
Creates a custom video track.
inherited
-
createDataStream(
DataStreamConfig config) → Future< int> -
Creates a data stream.
inherited
-
createDataStreamEx(
{required DataStreamConfig config, required RtcConnection connection}) → Future< int> - Creates a data stream.
-
createVideoEffectObject(
{required String bundlePath, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future< VideoEffectObject?> -
Creates an IVideoEffectObject video effect object.
inherited
-
destroyCustomVideoTrack(
int videoTrackId) → Future< void> -
Destroys the specified video track.
inherited
-
destroyMediaPlayer(
MediaPlayer mediaPlayer) → Future< void> -
Destroys the media player.
inherited
-
destroyVideoEffectObject(
VideoEffectObject videoEffectObject) → Future< void> -
Destroys the video effect object.
inherited
-
disableAudio(
) → Future< void> -
Disables the audio module.
inherited
-
disableAudioSpectrumMonitor(
) → Future< void> -
Disables audio spectrum monitoring.
inherited
-
disableVideo(
) → Future< void> -
Disables the video module.
inherited
-
enableAudio(
) → Future< void> -
Enables the audio module.
inherited
-
enableAudioSpectrumMonitor(
{int intervalInMS = 100}) → Future< void> -
Enables audio spectrum monitoring.
inherited
-
enableAudioVolumeIndication(
{required int interval, required int smooth, required bool reportVad}) → Future< void> -
Enables audio volume indication.
inherited
-
enableAudioVolumeIndicationEx(
{required int interval, required int smooth, required bool reportVad, required RtcConnection connection}) → Future< void> - Enables audio volume indication.
-
enableCameraCenterStage(
bool enabled) → Future< void> -
Enables or disables the Center Stage feature.
inherited
-
enableContentInspect(
{required bool enabled, required ContentInspectConfig config}) → Future< void> -
Enables/disables local snapshot upload.
inherited
-
enableContentInspectEx(
{required bool enabled, required ContentInspectConfig config, required RtcConnection connection}) → 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.
inherited
-
enableDualStreamMode(
{required bool enabled, SimulcastStreamConfig? streamConfig}) → Future< void> -
Enables or disables dual-stream mode on the sending end and configures the low-quality stream.
inherited
-
enableDualStreamModeEx(
{required bool enabled, required SimulcastStreamConfig streamConfig, required RtcConnection connection}) → Future< void> - Enables or disables dual-stream mode on the sending end.
-
enableEncryption(
{required bool enabled, required EncryptionConfig config}) → Future< void> -
Enable or disable built-in encryption.
inherited
-
enableEncryptionEx(
{required RtcConnection connection, 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.
inherited
-
enableFaceDetection(
bool enabled) → Future< void> -
Enables/disables local face detection.
inherited
-
enableInEarMonitoring(
{required bool enabled, required EarMonitoringFilterType includeAudioFilters}) → Future< void> -
Enables in-ear monitoring.
inherited
-
enableInstantMediaRendering(
) → Future< void> -
Enables accelerated rendering of audio and video frames.
inherited
-
enableLocalAudio(
bool enabled) → Future< void> -
Enables or disables local audio capture.
inherited
-
enableLocalVideo(
bool enabled) → Future< void> -
Enables or disables local video capture.
inherited
-
enableLoopbackRecording(
{required bool enabled, String? deviceName}) → Future< void> -
Enables sound card capture.
inherited
-
enableLoopbackRecordingEx(
{required RtcConnection connection, required bool enabled, String? deviceName}) → Future< void> - Enables loopback recording.
-
enableMultiCamera(
{required bool enabled, required CameraCapturerConfiguration config}) → Future< void> -
Enables or disables multi-camera capture.
inherited
-
enableSoundPositionIndication(
bool enabled) → Future< void> -
Enables/disables stereo sound for remote users.
inherited
-
enableSpatialAudio(
bool enabled) → Future< void> -
Enables or disables spatial audio.
inherited
-
enableVideo(
) → Future< void> -
Enables the video module.
inherited
-
enableVideoImageSource(
{required bool enable, required ImageTrackOptions options}) → Future< void> -
Enables or disables the placeholder image streaming feature.
inherited
-
enableVirtualBackground(
{required bool enabled, required VirtualBackgroundSource backgroundSource, required SegmentationProperty segproperty, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future< void> -
Enables/disables virtual background.
inherited
-
enableVoiceAITuner(
{required bool enabled, required VoiceAiTunerType type}) → Future< void> -
Enables or disables the AI tuner feature.
inherited
-
enableWebSdkInteroperability(
bool enabled) → Future< void> -
Enable interoperability with Web SDK (applicable only in live broadcast scenarios).
inherited
-
getAudioDeviceInfo(
) → Future< DeviceInfo> -
Gets audio device information.
inherited
-
getAudioDeviceManager(
) → AudioDeviceManager -
Gets the AudioDeviceManager object to manage audio devices.
inherited
-
getAudioMixingCurrentPosition(
) → Future< int> -
Gets the playback progress of the music file.
inherited
-
getAudioMixingDuration(
) → Future< int> -
Gets the total duration of the music file.
inherited
-
getAudioMixingPlayoutVolume(
) → Future< int> -
Gets the local playback volume of the music file.
inherited
-
getAudioMixingPublishVolume(
) → Future< int> -
Gets the remote playback volume of the music file.
inherited
-
getAudioTrackCount(
) → Future< int> -
Gets the audio track index of the current music file.
inherited
-
getCallId(
) → Future< String> -
Gets the call ID.
inherited
-
getCallIdEx(
RtcConnection connection) → Future< String> - Gets the call ID using the connection ID.
-
getCameraMaxZoomFactor(
) → Future< double> -
Gets the maximum zoom factor supported by the camera.
inherited
-
getConnectionState(
) → Future< ConnectionStateType> -
Gets the current network connection state.
inherited
-
getConnectionStateEx(
RtcConnection connection) → Future< ConnectionStateType> - Gets the current network connection state.
-
getCurrentMonotonicTimeInMs(
) → Future< int> -
Gets the SDK's current monotonic time.
inherited
-
getEffectCurrentPosition(
int soundId) → Future< int> -
Gets the playback progress of the specified sound effect file.
inherited
-
getEffectDuration(
String filePath) → Future< int> -
Gets the total duration of the specified sound effect file.
inherited
-
getEffectsVolume(
) → Future< int> -
Gets the playback volume of audio effect files.
inherited
-
getErrorDescription(
int code) → Future< String> -
Gets the warning or error description.
inherited
-
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.
inherited
-
getFaceShapeAreaOptions(
{required FaceShapeArea shapeArea, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future< FaceShapeAreaOptions> -
Gets face shaping area options.
inherited
-
getFaceShapeBeautyOptions(
{MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future< FaceShapeBeautyOptions> -
Gets face shaping effect options.
inherited
-
getLocalSpatialAudioEngine(
) → LocalSpatialAudioEngine -
Gets the LocalSpatialAudioEngine object.
inherited
-
getMediaEngine(
) → MediaEngine -
Gets the MediaEngine object.
inherited
-
getNativeHandle(
) → Future< int> -
Gets the C++ handle of the Native SDK.
inherited
-
getNetworkType(
) → Future< int> -
Gets the local network connection type.
inherited
-
getNtpWallTimeInMs(
) → Future< int> -
Gets the current NTP (Network Time Protocol) time.
inherited
-
getScreenCaptureSources(
{required SIZE thumbSize, required SIZE iconSize, required bool includeScreen}) → Future< List< ScreenCaptureSourceInfo> > -
Gets the list of shareable screen and window objects.
inherited
-
getUserInfoByUid(
int uid) → Future< UserInfo> -
Gets user information by UID.
inherited
-
getUserInfoByUserAccount(
String userAccount) → Future< UserInfo> -
Gets user information by User Account.
inherited
-
getVersion(
) → Future< SDKBuildInfo> -
Gets the SDK version.
inherited
-
getVideoDeviceManager(
) → VideoDeviceManager -
Gets a VideoDeviceManager object to manage video devices.
inherited
-
getVolumeOfEffect(
int soundId) → Future< int> -
Gets the playback volume of the specified audio effect file.
inherited
-
initialize(
RtcEngineContext context) → Future< void> -
Initializes the RtcEngine.
inherited
-
isCameraAutoExposureFaceModeSupported(
) → Future< bool> -
Checks whether the device supports auto exposure.
inherited
-
isCameraAutoFocusFaceModeSupported(
) → Future< bool> -
Checks whether the device supports face auto-focus.
inherited
-
isCameraCenterStageSupported(
) → Future< bool> -
Checks whether the camera supports Center Stage.
inherited
-
isCameraExposurePositionSupported(
) → Future< bool> -
Checks whether the device supports manual exposure.
inherited
-
isCameraExposureSupported(
) → Future< bool> -
Checks whether the current camera supports exposure adjustment.
inherited
-
isCameraFaceDetectSupported(
) → Future< bool> -
Checks whether the device camera supports face detection.
inherited
-
isCameraFocusSupported(
) → Future< bool> -
Checks whether the device supports manual focus.
inherited
-
isCameraTorchSupported(
) → Future< bool> -
Checks whether the device supports keeping the flashlight on.
inherited
-
isCameraZoomSupported(
) → Future< bool> -
Checks whether the device supports camera zoom.
inherited
-
isFeatureAvailableOnDevice(
FeatureType type) → Future< bool> -
Checks whether the device supports the specified advanced feature.
inherited
-
isSpeakerphoneEnabled(
) → Future< bool> -
Checks whether the speakerphone is enabled.
inherited
-
joinChannel(
{required String token, required String channelId, required int uid, required ChannelMediaOptions options}) → Future< void> -
Sets media options and joins a channel.
inherited
-
joinChannelEx(
{required String token, required RtcConnection connection, required ChannelMediaOptions options}) → Future< void> - 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.
inherited
-
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.
inherited
-
leaveChannel(
{LeaveChannelOptions? options}) → Future< void> -
Sets channel options and leaves the channel.
inherited
-
leaveChannelEx(
{required RtcConnection connection, LeaveChannelOptions? options}) → Future< void> - Sets channel options and leaves the channel.
-
loadExtensionProvider(
{required String path, bool unloadAfterUse = false}) → Future< void> -
Loads an extension.
inherited
-
muteAllRemoteAudioStreams(
bool mute) → Future< void> -
Stops or resumes subscribing to all remote users' audio streams.
inherited
-
muteAllRemoteAudioStreamsEx(
{required bool mute, required RtcConnection connection}) → 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.
inherited
-
muteAllRemoteVideoStreamsEx(
{required bool mute, required RtcConnection connection}) → 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.
inherited
-
muteLocalAudioStreamEx(
{required bool mute, required RtcConnection connection}) → Future< void> - Stops or resumes publishing the local audio stream.
-
muteLocalVideoStream(
bool mute) → Future< void> -
Stops or resumes publishing the local video stream.
inherited
-
muteLocalVideoStreamEx(
{required bool mute, required RtcConnection connection}) → Future< void> - Stops or resumes publishing the local video stream.
-
muteRecordingSignal(
bool mute) → Future< void> -
Mutes the recording signal.
inherited
-
muteRemoteAudioStream(
{required int uid, required bool mute}) → Future< void> -
Stops or resumes subscribing to the audio stream of a specified remote user.
inherited
-
muteRemoteAudioStreamEx(
{required int uid, required bool mute, required RtcConnection connection}) → Future< void> - Stops or resumes receiving a specified audio stream.
-
muteRemoteVideoStream(
{required int uid, required bool mute}) → Future< void> -
Stops or resumes subscribing to the video stream of a specified remote user.
inherited
-
muteRemoteVideoStreamEx(
{required int uid, required bool mute, required RtcConnection connection}) → Future< void> - Stops or resumes receiving a specified video stream.
-
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.
inherited
-
pauseAllChannelMediaRelayEx(
RtcConnection connection) → Future< void> - Pauses media stream relay to all destination channels.
-
pauseAllEffects(
) → Future< void> -
Pauses playback of all audio effect files.
inherited
-
pauseAudioMixing(
) → Future< void> -
Pauses the playback of the music file.
inherited
-
pauseEffect(
int soundId) → Future< void> -
Pauses playback of the audio effect file.
inherited
-
playAllEffects(
{required int loopCount, required double pitch, required double pan, required int gain, bool publish = false}) → Future< void> -
Plays all audio effect files.
inherited
-
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.
inherited
-
playEffectEx(
{required RtcConnection connection, 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 audio effect in the channel.
-
preloadChannel(
{required String token, required String channelId, required int uid}) → Future< void> -
Preloads a channel using token, channelId, and uid.
inherited
-
preloadChannelWithUserAccount(
{required String token, required String channelId, required String userAccount}) → Future< void> -
Preloads a channel using token, channelId, and userAccount.
inherited
-
preloadEffect(
{required int soundId, required String filePath, int startPos = 0}) → Future< void> -
Loads the audio effect file into memory.
inherited
-
preloadEffectEx(
{required RtcConnection connection, required int soundId, required String filePath, int startPos = 0}) → Future< void> - Preloads the specified audio effect into the channel.
-
queryCameraFocalLengthCapability(
) → Future< List< FocalLengthInfo> > -
Queries the focal length capabilities supported by the camera.
inherited
-
queryCodecCapability(
int size) → Future< List< CodecCapInfo> > -
Queries the video codec capabilities supported by the SDK.
inherited
-
queryDeviceScore(
) → Future< int> -
Queries the device score level.
inherited
-
queryScreenCaptureCapability(
) → Future< int> -
Queries the maximum frame rate supported by the device during screen sharing.
inherited
-
rate(
{required String callId, required int rating, required String description}) → Future< void> -
Rates a call.
inherited
-
registerAudioEncodedFrameObserver(
{required AudioEncodedFrameObserverConfig config, required AudioEncodedFrameObserver observer}) → void -
Registers the audio encoded frame observer.
inherited
-
registerAudioSpectrumObserver(
AudioSpectrumObserver observer) → void -
Registers an audio spectrum observer.
inherited
-
registerEventHandler(
RtcEngineEventHandler eventHandler) → void -
Adds the main callback event.
inherited
-
registerExtension(
{required String provider, required String extension, MediaSourceType type = MediaSourceType.unknownMediaSource}) → Future< void> -
Registers an extension.
inherited
-
registerLocalUserAccount(
{required String appId, required String userAccount}) → Future< void> -
Registers the local user account.
inherited
-
registerMediaMetadataObserver(
{required MetadataObserver observer, required MetadataType type}) → void -
Registers a media metadata observer to receive or send metadata.
inherited
-
release(
{bool sync = false}) → Future< void> -
Destroys the RtcEngine object.
inherited
-
renewToken(
String token) → Future< void> -
Updates the token.
inherited
-
resumeAllChannelMediaRelay(
) → Future< void> -
Resumes media stream relay to all destination channels.
inherited
-
resumeAllChannelMediaRelayEx(
RtcConnection connection) → Future< void> - Resumes media stream relay to all destination channels.
-
resumeAllEffects(
) → Future< void> -
Resumes playback of all audio effect files.
inherited
-
resumeAudioMixing(
) → Future< void> -
Resumes the playback of the music file.
inherited
-
resumeEffect(
int soundId) → Future< void> -
Resumes playback of the specified audio effect file.
inherited
-
selectAudioTrack(
int index) → Future< void> -
Specifies the playback audio track of the current music file.
inherited
-
sendCustomReportMessage(
{required String id, required String category, required String event, required String label, required int value}) → Future< void> -
Sends a custom report message.
inherited
-
sendCustomReportMessageEx(
{required String id, required String category, required String event, required String label, required int value, required RtcConnection connection}) → Future< void> - Custom data reporting and analytics service.
-
sendMetaData(
{required Metadata metadata, required VideoSourceType sourceType}) → Future< void> -
Sends media metadata.
inherited
-
sendStreamMessage(
{required int streamId, required Uint8List data, required int length}) → Future< void> -
Sends a data stream.
inherited
-
sendStreamMessageEx(
{required int streamId, required Uint8List data, required int length, required RtcConnection connection}) → Future< void> - Sends a data stream.
-
setAdvancedAudioOptions(
{required AdvancedAudioOptions options, int sourceType = 0}) → Future< void> -
Sets advanced audio options.
inherited
-
setAINSMode(
{required bool enabled, required AudioAinsMode mode}) → Future< void> -
Enables or disables AI noise reduction and sets the noise reduction mode.
inherited
-
setAudioEffectParameters(
{required AudioEffectPreset preset, required int param1, required int param2}) → Future< void> -
Sets the parameters for SDK preset voice effects.
inherited
-
setAudioEffectPreset(
AudioEffectPreset preset) → Future< void> -
Sets the SDK preset voice effect.
inherited
-
setAudioMixingDualMonoMode(
AudioMixingDualMonoMode mode) → Future< void> -
Sets the channel mode of the current audio file.
inherited
-
setAudioMixingPitch(
int pitch) → Future< void> -
Adjusts the pitch of the locally played music file.
inherited
-
setAudioMixingPlaybackSpeed(
int speed) → Future< void> -
Sets the playback speed of the current music file.
inherited
-
setAudioMixingPosition(
int pos) → Future< void> -
Sets the playback position of the music file.
inherited
-
setAudioProfile(
{required AudioProfileType profile, AudioScenarioType scenario = AudioScenarioType.audioScenarioDefault}) → Future< void> -
Sets the audio encoding profile and audio scenario.
inherited
-
setAudioScenario(
AudioScenarioType scenario) → Future< void> -
Sets the audio scenario.
inherited
-
setAudioSessionOperationRestriction(
AudioSessionOperationRestriction restriction) → Future< void> -
Sets the SDK's permission to operate the Audio Session.
inherited
-
setBeautyEffectOptions(
{required bool enabled, required BeautyOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future< void> -
Sets beauty effect options.
inherited
-
setCameraAutoExposureFaceModeEnabled(
bool enabled) → Future< void> -
Enables or disables the auto exposure feature.
inherited
-
setCameraAutoFocusFaceModeEnabled(
bool enabled) → Future< void> -
Sets whether to enable face auto-focus.
inherited
-
setCameraCapturerConfiguration(
CameraCapturerConfiguration config) → Future< void> -
Sets the camera capture configuration.
inherited
-
setCameraDeviceOrientation(
{required VideoSourceType type, required VideoOrientation orientation}) → Future< void> -
Sets the rotation angle of the captured video.
inherited
-
setCameraExposureFactor(
double factor) → Future< void> -
Sets the exposure factor of the current camera.
inherited
-
setCameraExposurePosition(
{required double positionXinView, required double positionYinView}) → Future< void> -
Sets the manual exposure position.
inherited
-
setCameraFocusPositionInPreview(
{required double positionX, required double positionY}) → Future< void> -
Sets the manual focus position and triggers focusing.
inherited
-
setCameraStabilizationMode(
CameraStabilizationMode mode) → Future< void> -
Sets the camera stabilization mode.
inherited
-
setCameraTorchOn(
bool isOn) → Future< void> -
Sets whether to turn on the flashlight.
inherited
-
setCameraZoomFactor(
double factor) → Future< void> -
Sets the camera zoom factor.
inherited
-
setChannelProfile(
ChannelProfileType profile) → Future< void> -
Sets the channel profile.
inherited
-
setClientRole(
{required ClientRoleType role, ClientRoleOptions? options}) → Future< void> -
Sets the user role and audience latency level in live streaming.
inherited
-
setCloudProxy(
CloudProxyType proxyType) → Future< void> -
Sets the cloud proxy service.
inherited
-
setColorEnhanceOptions(
{required bool enabled, required ColorEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future< void> -
Sets the color enhancement feature.
inherited
-
setDefaultAudioRouteToSpeakerphone(
bool defaultToSpeaker) → Future< void> -
Sets the default audio route.
inherited
-
setDualStreamMode(
{required SimulcastStreamMode mode, SimulcastStreamConfig? streamConfig}) → Future< void> -
Sets the dual-stream mode on the sender and configures the low-quality video stream.
inherited
-
setDualStreamModeEx(
{required SimulcastStreamMode mode, required SimulcastStreamConfig streamConfig, required RtcConnection connection}) → Future< void> - Sets the dual-stream mode on the sender side.
-
setEarMonitoringAudioFrameParameters(
{required int sampleRate, required int channel, required RawAudioFrameOpModeType mode, required int samplesPerCall}) → Future< void> -
Sets the data format for the onEarMonitoringAudioFrame callback.
inherited
-
setEffectPosition(
{required int soundId, required int pos}) → Future< void> -
Sets the playback position of the specified audio effect file.
inherited
-
setEffectsVolume(
int volume) → Future< void> -
Sets the playback volume of audio effect files.
inherited
-
setEnableSpeakerphone(
bool speakerOn) → Future< void> -
Enables or disables speakerphone playback.
inherited
-
setExtensionProperty(
{required String provider, required String extension, required String key, required String value, MediaSourceType type = MediaSourceType.unknownMediaSource}) → Future< void> -
Sets an extension property.
inherited
-
setExtensionProviderProperty(
{required String provider, required String key, required String value}) → Future< void> -
Sets a property for the extension provider.
inherited
-
setExternalMediaProjection(
int mediaProjection) → Future< void> -
Sets an external MediaProjection to capture screen video stream.
inherited
-
setFaceShapeAreaOptions(
{required FaceShapeAreaOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future< void> -
Sets face shaping area options and specifies the media source.
inherited
-
setFaceShapeBeautyOptions(
{required bool enabled, required FaceShapeBeautyOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future< void> -
Sets face shaping effect options and specifies the media source.
inherited
-
setFilterEffectOptions(
{required bool enabled, required FilterEffectOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future< void> -
Sets filter effect options and specifies the media source.
inherited
-
setHeadphoneEQParameters(
{required int lowGain, required int highGain}) → Future< void> -
Sets the low-frequency and high-frequency parameters of the headphone equalizer.
inherited
-
setHeadphoneEQPreset(
HeadphoneEqualizerPreset preset) → Future< void> -
Sets the preset headphone equalizer effect.
inherited
-
setInEarMonitoringVolume(
int volume) → Future< void> -
Sets the in-ear monitoring volume.
inherited
-
setLocalRenderMode(
{required RenderModeType renderMode, VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAuto}) → Future< void> -
Updates the local view display mode.
inherited
-
setLocalRenderTargetFps(
{required VideoSourceType sourceType, required int targetFps}) → Future< void> -
Sets the maximum frame rate for local video rendering.
inherited
-
setLocalVideoMirrorMode(
VideoMirrorModeType mirrorMode) → Future< void> -
Sets the local video mirror mode.
inherited
-
setLocalVoiceEqualization(
{required AudioEqualizationBandFrequency bandFrequency, required int bandGain}) → Future< void> -
Sets the local voice equalization.
inherited
-
setLocalVoiceFormant(
double formantRatio) → Future< void> -
Sets the formant ratio to change the voice timbre.
inherited
-
setLocalVoicePitch(
double pitch) → Future< void> -
Sets the local voice pitch.
inherited
-
setLocalVoiceReverb(
{required AudioReverbType reverbKey, required int value}) → Future< void> -
Sets the local voice reverb effect.
inherited
-
setLogFile(
String filePath) → Future< void> -
Sets the log file.
inherited
-
setLogFileSize(
int fileSizeInKBytes) → Future< void> -
Sets the size of the SDK log file output.
inherited
-
setLogFilter(
LogFilterType filter) → Future< void> -
Sets the log output level.
inherited
-
setLogLevel(
LogLevel level) → Future< void> -
Sets the SDK log output level.
inherited
-
setLowlightEnhanceOptions(
{required bool enabled, required LowlightEnhanceOptions options, MediaSourceType type = MediaSourceType.primaryCameraSource}) → Future< void> -
Sets the low-light enhancement feature.
inherited
-
setMaxMetadataSize(
int size) → Future< void> -
Sets the maximum size of media metadata.
inherited
-
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.
inherited
-
setParameters(
String parameters) → Future< void> -
JSON configuration information for the SDK, used to provide technical preview or customized features.
inherited
-
setPlaybackAudioFrameBeforeMixingParameters(
{required int sampleRate, required int channel}) → Future< void> -
Sets the format of the raw audio playback data before mixing.
inherited
-
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.
inherited
-
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.
inherited
-
setRemoteDefaultVideoStreamType(
VideoStreamType streamType) → Future< void> -
Sets the default video stream type to subscribe to.
inherited
-
setRemoteRenderMode(
{required int uid, required RenderModeType renderMode, required VideoMirrorModeType mirrorMode}) → Future< void> -
Updates the display mode of the remote view.
inherited
-
setRemoteRenderModeEx(
{required int uid, required RenderModeType renderMode, required VideoMirrorModeType mirrorMode, required RtcConnection connection}) → Future< void> - Sets the display mode of the remote view.
-
setRemoteRenderTargetFps(
int targetFps) → Future< void> -
Sets the maximum frame rate for remote video rendering.
inherited
-
setRemoteSubscribeFallbackOption(
StreamFallbackOptions option) → Future< void> -
Sets the fallback option for subscribed audio and video streams under poor network conditions.
inherited
-
setRemoteUserSpatialAudioParams(
{required int uid, required SpatialAudioParams params}) → Future< void> -
Sets the spatial audio parameters for a remote user.
inherited
-
setRemoteVideoStreamType(
{required int uid, required VideoStreamType streamType}) → Future< void> -
Sets the video stream type to subscribe to.
inherited
-
setRemoteVideoStreamTypeEx(
{required int uid, required VideoStreamType streamType, required RtcConnection connection}) → 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.
inherited
-
setRemoteVideoSubscriptionOptionsEx(
{required int uid, required VideoSubscriptionOptions options, required RtcConnection connection}) → 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.
inherited
-
setRemoteVoicePositionEx(
{required int uid, required double pan, required double gain, required RtcConnection connection}) → Future< void> - Sets the 2D position of a remote user's voice, i.e., horizontal position.
-
setRouteInCommunicationMode(
int route) → Future< void> -
Selects the audio route in communication volume mode.
inherited
-
setScreenCaptureContentHint(
VideoContentHint contentHint) → Future< void> -
Sets the content type for screen sharing.
inherited
-
setScreenCaptureScenario(
ScreenScenarioType screenScenario) → Future< void> -
Sets the screen sharing scenario.
inherited
-
setSubscribeAudioAllowlist(
{required List< int> uidList, required int uidNumber}) → Future<void> -
Sets the audio subscription allowlist.
inherited
-
setSubscribeAudioAllowlistEx(
{required List< int> uidList, required int uidNumber, required RtcConnection connection}) → Future<void> - Sets the audio subscription allowlist.
-
setSubscribeAudioBlocklist(
{required List< int> uidList, required int uidNumber}) → Future<void> -
Sets the audio subscription blocklist.
inherited
-
setSubscribeAudioBlocklistEx(
{required List< int> uidList, required int uidNumber, required RtcConnection connection}) → Future<void> - Sets the audio subscription blocklist.
-
setSubscribeVideoAllowlist(
{required List< int> uidList, required int uidNumber}) → Future<void> -
Sets the video subscription allowlist.
inherited
-
setSubscribeVideoAllowlistEx(
{required List< int> uidList, required int uidNumber, required RtcConnection connection}) → Future<void> - Sets the video subscription allowlist.
-
setSubscribeVideoBlocklist(
{required List< int> uidList, required int uidNumber}) → Future<void> -
Sets the video subscription blocklist.
inherited
-
setSubscribeVideoBlocklistEx(
{required List< int> uidList, required int uidNumber, required RtcConnection connection}) → Future<void> - Sets the video subscription blocklist.
-
setupLocalVideo(
VideoCanvas canvas) → Future< void> -
Initializes the local view.
inherited
-
setupRemoteVideo(
VideoCanvas canvas) → Future< void> -
Initializes the remote user view.
inherited
-
setupRemoteVideoEx(
{required VideoCanvas canvas, required RtcConnection connection}) → 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.
inherited
-
setVideoEncoderConfiguration(
VideoEncoderConfiguration config) → Future< void> -
Sets the video encoding attributes.
inherited
-
setVideoEncoderConfigurationEx(
{required VideoEncoderConfiguration config, required RtcConnection connection}) → Future< void> - Sets the video encoding attributes.
-
setVideoScenario(
VideoApplicationScenarioType scenarioType) → Future< void> -
Sets the video application scenario.
inherited
-
setVoiceBeautifierParameters(
{required VoiceBeautifierPreset preset, required int param1, required int param2}) → Future< void> -
Sets the parameters for the preset voice beautifier effect.
inherited
-
setVoiceBeautifierPreset(
VoiceBeautifierPreset preset) → Future< void> -
Sets the preset voice beautifier effect.
inherited
-
setVoiceConversionPreset(
VoiceConversionPreset preset) → Future< void> -
Sets the preset voice conversion effect.
inherited
-
setVolumeOfEffect(
{required int soundId, required int volume}) → Future< void> -
Sets the playback volume of the specified audio effect file.
inherited
-
startAudioMixing(
{required String filePath, required bool loopback, required int cycle, int startPos = 0}) → Future< void> -
Starts playing a music file.
inherited
-
startCameraCapture(
{required VideoSourceType sourceType, required CameraCapturerConfiguration config}) → Future< void> -
Starts video capture using the camera.
inherited
-
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.
inherited
-
startLastmileProbeTest(
LastmileProbeConfig config) → Future< void> -
Starts the last-mile network probe test before a call.
inherited
-
startLocalAudioMixer(
LocalAudioMixerConfiguration config) → Future< void> -
Starts local audio mixing.
inherited
-
startLocalVideoTranscoder(
LocalTranscoderConfiguration config) → Future< void> -
Starts local video mixing.
inherited
-
startMediaRenderingTracing(
) → Future< void> -
Starts video frame rendering tracing.
inherited
-
startMediaRenderingTracingEx(
RtcConnection connection) → Future< void> - Starts video frame rendering tracing.
-
startOrUpdateChannelMediaRelay(
ChannelMediaRelayConfiguration configuration) → Future< void> -
Starts or updates cross-channel media stream relay.
inherited
-
startOrUpdateChannelMediaRelayEx(
{required ChannelMediaRelayConfiguration configuration, required RtcConnection connection}) → 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.
inherited
-
startPreviewWithoutSourceType(
) → Future< void> -
Starts video preview.
inherited
-
startRhythmPlayer(
{required String sound1, required String sound2, required AgoraRhythmPlayerConfig config}) → Future< void> -
Starts the virtual metronome.
inherited
-
startRtmpStreamWithoutTranscoding(
String url) → Future< void> -
Starts pushing streams without transcoding.
inherited
-
startRtmpStreamWithoutTranscodingEx(
{required String url, required RtcConnection connection}) → Future< void> - Starts pushing streams without transcoding.
-
startRtmpStreamWithTranscoding(
{required String url, required LiveTranscoding transcoding}) → Future< void> -
Starts pushing streams with transcoding settings.
inherited
-
startRtmpStreamWithTranscodingEx(
{required String url, required LiveTranscoding transcoding, required RtcConnection connection}) → Future< void> - Starts pushing streams with transcoding settings.
-
startScreenCapture(
ScreenCaptureParameters2 captureParams) → Future< void> -
Starts screen capture.
inherited
-
startScreenCaptureByDisplayId(
{required int displayId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}) → Future< void> -
Starts capturing the video stream of the specified screen.
inherited
-
startScreenCaptureByScreenRect(
{required Rectangle screenRect, required Rectangle regionRect, required ScreenCaptureParameters captureParams}) → Future< void> -
Starts capturing the video stream of a specified screen region.
inherited
-
startScreenCaptureBySourceType(
{required VideoSourceType sourceType, required ScreenCaptureConfiguration config}) → Future< void> -
Starts screen capture and specifies the video source.
inherited
-
startScreenCaptureByWindowId(
{required int windowId, required Rectangle regionRect, required ScreenCaptureParameters captureParams}) → Future< void> -
Starts capturing the video stream of a specified window.
inherited
-
stopAllEffects(
) → Future< void> -
Stops playback of all audio effect files.
inherited
-
stopAudioMixing(
) → Future< void> -
Stops playing the music file.
inherited
-
stopCameraCapture(
VideoSourceType sourceType) → Future< void> -
Stops video capture using the camera.
inherited
-
stopChannelMediaRelay(
) → Future< void> -
Stops cross-channel media stream relay. Once stopped, the broadcaster leaves all destination channels.
inherited
-
stopChannelMediaRelayEx(
RtcConnection connection) → 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.
inherited
-
stopEffect(
int soundId) → Future< void> -
Stops playback of the specified audio effect file.
inherited
-
stopLastmileProbeTest(
) → Future< void> -
Stops the last-mile network probe test before a call.
inherited
-
stopLocalAudioMixer(
) → Future< void> -
Stops local audio mixing.
inherited
-
stopLocalVideoTranscoder(
) → Future< void> -
Stops local video mixing.
inherited
-
stopPreview(
{VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary}) → Future< void> -
Stops video preview.
inherited
-
stopRhythmPlayer(
) → Future< void> -
Stops the virtual metronome.
inherited
-
stopRtmpStream(
String url) → Future< void> -
Stops the CDN stream.
inherited
-
stopRtmpStreamEx(
{required String url, required RtcConnection connection}) → Future< void> - Stops the RTMP stream.
-
stopScreenCapture(
) → Future< void> -
Stops screen capture.
inherited
-
stopScreenCaptureBySourceType(
VideoSourceType sourceType) → Future< void> -
Stops screen capture for the specified video source.
inherited
-
switchCamera(
) → Future< void> -
Switches between front and rear cameras.
inherited
-
takeSnapshot(
{required int uid, required String filePath}) → Future< void> -
Takes a snapshot of the video.
inherited
-
takeSnapshotEx(
{required RtcConnection connection, required int uid, required String filePath}) → Future< void> - Takes a video snapshot using the connection ID.
-
takeSnapshotWithConfig(
{required int uid, required SnapshotConfig config}) → Future< void> -
Takes a video snapshot at the specified observation point.
inherited
-
takeSnapshotWithConfigEx(
{required RtcConnection connection, required int uid, required SnapshotConfig config}) → Future< void> - Takes a video snapshot at the specified observation point using the connection ID.
-
toString(
) → String -
A string representation of this object.
inherited
-
unloadAllEffects(
) → Future< void> -
Releases all preloaded audio effect files from memory.
inherited
-
unloadEffect(
int soundId) → Future< void> -
Releases a specific preloaded audio effect file from memory.
inherited
-
unregisterAudioEncodedFrameObserver(
AudioEncodedFrameObserver observer) → void -
Unregisters the audio encoded frame observer.
inherited
-
unregisterAudioSpectrumObserver(
AudioSpectrumObserver observer) → void -
Unregisters the audio spectrum observer.
inherited
-
unregisterEventHandler(
RtcEngineEventHandler eventHandler) → void -
Removes the specified callback event.
inherited
-
unregisterMediaMetadataObserver(
{required MetadataObserver observer, required MetadataType type}) → void -
Unregisters the media metadata observer.
inherited
-
updateChannelMediaOptions(
ChannelMediaOptions options) → Future< void> -
Updates channel media options after joining the channel.
inherited
-
updateChannelMediaOptionsEx(
{required ChannelMediaOptions options, required RtcConnection connection}) → Future< void> - Updates channel media options after joining the channel.
-
updateLocalAudioMixerConfiguration(
LocalAudioMixerConfiguration config) → Future< void> -
Updates the configuration of local audio mixing.
inherited
-
updateLocalTranscoderConfiguration(
LocalTranscoderConfiguration config) → Future< void> -
Updates local video mixing configuration.
inherited
-
updatePreloadChannelToken(
String token) → Future< void> -
Updates the wildcard token for the preloaded channel.
inherited
-
updateRtmpTranscoding(
LiveTranscoding transcoding) → Future< void> -
Updates the RTMP transcoding configuration.
inherited
-
updateRtmpTranscodingEx(
{required LiveTranscoding transcoding, required RtcConnection connection}) → Future< void> - Updates the RTMP transcoding configuration.
-
updateScreenCapture(
ScreenCaptureParameters2 captureParams) → Future< void> -
Updates the parameter configuration for screen capture.
inherited
-
updateScreenCaptureParameters(
ScreenCaptureParameters captureParams) → Future< void> -
Updates the parameter configuration for screen capture.
inherited
-
updateScreenCaptureRegion(
Rectangle regionRect) → Future< void> -
Updates the region for screen capture.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited