Flutter SDK API Reference

dispose(): Future
isPipActivated(): Future
pipDispose(): Future
pipIsAutoEnterSupported(): Future
pipIsSupported(): Future
pipSetup(options: AgoraPipOptions): Future
pipStart(): Future
pipStop(): Future
registerPipStateChangedObserver(observer: AgoraPipStateChangedObserver): Future
unregisterPipStateChangedObserver(): Future

onPipStateChanged(state: AgoraPipState, error?: String?): void

enumeratePlaybackDevices(): List
enumerateRecordingDevices(): List
followSystemLoopbackDevice(enable: bool): Future
followSystemPlaybackDevice(enable: bool): Future
followSystemRecordingDevice(enable: bool): Future
getLoopbackDevice(): Future
getPlaybackDefaultDevice(): Future
getPlaybackDevice(): Future
getPlaybackDeviceInfo(): Future
getPlaybackDeviceMute(): Future
getPlaybackDeviceVolume(): Future
getRecordingDefaultDevice(): Future
getRecordingDevice(): Future
getRecordingDeviceInfo(): Future
getRecordingDeviceMute(): Future
getRecordingDeviceVolume(): Future
release(): Future
setLoopbackDevice(deviceId: String): Future
setPlaybackDevice(deviceId: String): Future
setPlaybackDeviceMute(mute: bool): Future
setPlaybackDeviceVolume(volume: int): Future
setRecordingDevice(deviceId: String): Future
setRecordingDeviceMute(mute: bool): Future
setRecordingDeviceVolume(volume: int): Future
startAudioDeviceLoopbackTest(indicationInterval: int): Future
startPlaybackDeviceTest(testAudioFilePath: String): Future
startRecordingDeviceTest(indicationInterval: int): Future
stopAudioDeviceLoopbackTest(): Future
stopPlaybackDeviceTest(): Future
stopRecordingDeviceTest(): Future

onMixedAudioEncodedFrame(frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
onPlaybackAudioEncodedFrame(frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void
onRecordAudioEncodedFrame(frameBuffer: Uint8List, length: int, audioEncodedFrameInfo: EncodedAudioFrameInfo): void

onPlaybackAudioFrameBeforeMixing(channelId: String, uid: int, audioFrame: AudioFrame): void

onEarMonitoringAudioFrame(audioFrame: AudioFrame): void
onMixedAudioFrame(channelId: String, audioFrame: AudioFrame): void
onPlaybackAudioFrame(channelId: String, audioFrame: AudioFrame): void
onRecordAudioFrame(channelId: String, audioFrame: AudioFrame): void

onFrame(frame: AudioPcmFrame): void

onLocalAudioSpectrum(data: AudioSpectrumData): void
onRemoteAudioSpectrum(spectrums: List, spectrumNumber: int): void

muteAllRemoteAudioStreams(mute: bool): Future
muteLocalAudioStream(mute: bool): Future
muteRemoteAudioStream(mute: int uid,required bool): Future
release(): unknown
setAudioRecvRange(range: double): Future
setDistanceUnit(unit: double): Future
setMaxAudioRecvCount(maxCount: int): Future
setPlayerAttenuation(forceSet: int playerId,required double attenuation,required bool): Future
setZones(zoneCount: SpatialAudioZone zones,required int): Future
updatePlayerPositionInfo(positionInfo: int playerId,required RemoteVoicePositionInfo): Future
updateSelfPosition(axisUp: List position,required List axisForward,required List axisRight,required List): Future

path(): unknown

clearRemotePositions(): Future
initialize(): Future
removeRemotePosition(uid: int): Future
setRemoteAudioAttenuation(forceSet: int uid,required double attenuation,required bool): Future
updateRemotePosition(posInfo: int uid,required RemoteVoicePositionInfo): Future

createCustomAudioTrack(config: AudioTrackType trackType,required AudioTrackConfig): Future
destroyCustomAudioTrack(trackId: int): Future
pullAudioFrame(frame: AudioFrame): Future
pushAudioFrame(null: AudioFrame frame,int trackId = 0): Future
pushVideoFrame(null: ExternalVideoFrame frame,int videoTrackId = 0): Future
registerAudioFrameObserver(observer: AudioFrameObserver): void
registerFaceInfoObserver(observer: FaceInfoObserver): void
registerVideoEncodedFrameObserver(observer: VideoEncodedFrameObserver): void
registerVideoFrameObserver(observer: VideoFrameObserver): void
setExternalAudioSink(channels: bool enabled,required int sampleRate,required int): Future
setExternalAudioSource(true: bool enabled,required int sampleRate,required int channels,bool localPlayback = false,bool publish =): Future
setExternalVideoSource(null: bool enabled,required bool useTexture,ExternalVideoSourceType sourceType = ExternalVideoSourceType.videoFrame,SenderOptions encodedVideoOption = const SenderOptions()): Future
unregisterAudioFrameObserver(observer: AudioFrameObserver): void
unregisterFaceInfoObserver(observer: FaceInfoObserver): void
unregisterVideoEncodedFrameObserver(observer: VideoEncodedFrameObserver): void
unregisterVideoFrameObserver(observer: VideoFrameObserver): void

adjustPlayoutVolume(volume: int): Future
adjustPublishSignalVolume(volume: int): Future
getAudioBufferDelay(): Future
getDuration(): Future
getMediaPlayerId(): int
getMute(): Future
getPlayPosition(): Future
getPlaySrc(): Future
getPlayoutVolume(): Future
getPublishSignalVolume(): Future
getState(): Future
getStreamCount(): Future
getStreamInfo(index: int): Future
mute(muted: bool): Future
open(startPos: String url,required int): Future
openWithMediaSource(source: MediaSource): Future
pause(): Future
play(): Future
playPreloadedSrc(src: String): Future
preloadSrc(startPos: String src,required int): Future
registerAudioFrameObserver(null: AudioPcmFrameSink observer,RawAudioFrameOpModeType mode = RawAudioFrameOpModeType.rawAudioFrameOpModeReadOnly): void
registerPlayerSourceObserver(observer: MediaPlayerSourceObserver): void
registerVideoFrameObserver(observer: MediaPlayerVideoFrameObserver): void
resume(): Future
seek(newPos: int): Future
selectAudioTrack(index: int): Future
selectMultiAudioTrack(publishTrackIndex: int playoutTrackIndex,required int): Future
setAudioDualMonoMode(mode: AudioDualMonoMode): Future
setAudioPitch(pitch: int): Future
setLoopCount(loopCount: int): Future
setPlaybackSpeed(speed: int): Future
setPlayerOptionInInt(value: String key,required int): Future
setPlayerOptionInString(value: String key,required String): Future
setRenderMode(renderMode: RenderModeType): Future
setSpatialAudioParams(params: SpatialAudioParams): Future
setView(view: int): Future
stop(): Future
switchSrc(true: String src,bool syncPts =): Future
unloadSrc(src: String): Future
unregisterAudioFrameObserver(observer: AudioPcmFrameSink): void
unregisterPlayerSourceObserver(observer: MediaPlayerSourceObserver): void
unregisterVideoFrameObserver(observer: MediaPlayerVideoFrameObserver): void

enableAutoRemoveCache(enable: bool): Future
getCacheDir(length: int): Future
getCacheFileCount(): Future
getMaxCacheFileCount(): Future
getMaxCacheFileSize(): Future
getMediaPlayerCacheManager(): MediaPlayerCacheManager
removeAllCaches(): Future
removeCacheByUri(uri: String): uture
removeOldCache(): Future
setCacheDir(path: String): Future
setMaxCacheFileCount(count: int): Future
setMaxCacheFileSize(cacheSize: int): Future

initialize(): Future

onAudioVolumeIndication(volume: int): void
onMetaData(data: Uint8List, length: int): void
onPlayBufferUpdated(playCachedBuffer: int): void
onPlayerCacheStats(stats: CacheStatistics): void
onPlayerEvent(eventCode: MediaPlayerEvent, elapsedTime: int, message: String): void
onPlayerInfoUpdated(info: PlayerUpdatedInfo): void
onPlayerPlaybackStats(stats: PlayerPlaybackStats): void
onPlayerSourceStateChanged(state: MediaPlayerState, reason: MediaPlayerReason): void
onPlayerSrcInfoChanged(from: SrcInfo, to: SrcInfo): void
onPositionChanged(positionMs: int, timestampMs: int): void
onPreloadEvent(src: String, event: PlayerPreloadEvent): void

onFrame(frame: VideoFrame): void

setMediaRecorderObserver(callback: RtcConnection connection,required MediaRecorderObserver): Future
startRecording(config: MediaRecorderConfiguration): Future
stopRecording(): Future

onRecorderInfoUpdated(channelId: String, uid: int, info: RecorderInfo): void
onRecorderStateChanged(channelId: String, uid: int, state: RecorderState, reason: RecorderReasonCode): void

onMetadataReceived(metadata: Metadata): void

get(index: int): Future
getCount(): Future

getCount(): int
getMusic(index: int): Music
getPage(): int
getPageSize(): int
getTotal(): int

createMusicPlayer(): Future
destroyMusicPlayer(musicPlayer: MusicPlayer): Future
getCaches(cacheInfoSize: int): Future ->
getInternalSongCode(jsonOption: int songCode,required String): Future
getLyric(null: int songCode,int lyricType = 0): Future
getMusicCharts(): Future
getMusicCollectionByMusicChartId(jsonOption?: int musicChartId,required int page,required int pageSize,String?): Future
getSongSimpleInfo(songCode: int): Future
initialize(configuration: MusicContentCenterConfiguration): Future
isPreloaded(songCode: int): Future
preload(songCode: int): Future
registerEventHandler(eventHandler: MusicContentCenterEventHandler): void
release(): Future
removeCache(songCode: int): Future
renewToken(token: String): Future
searchMusic(jsonOption?: String keyWord,required int page,required int pageSize,String?): Future
unregisterEventHandler(): void

onLyricResult(requestId: String, songCode: int, lyricUrl: String, reason: MusicContentCenterStateReason): void
onMusicChartsResult(requestId: String, result: List, reason: MusicContentCenterStateReason): void
onMusicCollectionResult(requestId: String, result: MusicCollection, reason: MusicContentCenterStateReason): void
onPreLoadEvent(requestId: String, songCode: int, percent: int, lyricUrl: String, state: PreloadState, reason: MusicContentCenterStateReason): void
onSongSimpleInfoResult(requestId: String, songCode: int, simpleInfo: String, reason: MusicContentCenterStateReason): void

openWithSongCode(null: int songCode,int startPos = 0): Future
setPlayMode(mode: MusicPlayMode): Future

addVideoWatermark(options: String watermarkUrl,required WatermarkOptions): Future
addVideoWatermarkWithConfig(configs: WatermarkConfig): Future
adjustAudioMixingPlayoutVolume(volume: int): Future
adjustAudioMixingPublishVolume(volume: int): Future
adjustAudioMixingVolume(volume: int): Future
adjustCustomAudioPlayoutVolume(volume: int trackId,required int): Future
adjustCustomAudioPublishVolume(volume: int trackId,required int): Future
adjustLoopbackSignalVolume(volume: int): Future
adjustPlaybackSignalVolume(volume: int): Future
adjustRecordingSignalVolume(volume: int): Future
adjustUserPlaybackSignalVolume(volume: int uid,required int): Future
clearVideoWatermarks(): Future
complain(description: String callId,required String): Future
configRhythmPlayer(config: AgoraRhythmPlayerConfig): Future
createAgoraRtcEngine(): RtcEngine
createCustomVideoTrack(): Future
createDataStream(config: DataStreamConfig): Future
createMediaPlayer(): Future
createMediaRecorder(info: RecorderStreamInfo): Future
createVideoEffectObject(null: String bundlePath,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
destroyCustomVideoTrack(videoTrackId: int): Future
destroyMediaPlayer(mediaPlayer: MediaPlayer): Future
destroyMediaRecorder(mediaRecorder: MediaRecorder): Future
destroyVideoEffectObject(videoEffectObject: VideoEffectObject): Future
disableAudio(): Future
disableAudioSpectrumMonitor(): Future
disableVideo(): Future
enableAudio(): Future
enableAudioSpectrumMonitor(null: int intervalInMS = 100): Future
enableAudioVolumeIndication(reportVad: int interval,required int smooth,required bool): Future
enableCameraCenterStage(enabled: bool): Future
enableContentInspect(config: bool enabled,required ContentInspectConfig): Future
enableCustomAudioLocalPlayback(enabled: int trackId,required bool): Future
enableDualStreamMode(streamConfig?: bool enabled,SimulcastStreamConfig?): Future
enableEncryption(config: bool enabled,required EncryptionConfig): Future
enableExtension(null: String provider,required String extension,bool enable = true,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
enableFaceDetection(enabled: bool): Future
enableInEarMonitoring(includeAudioFilters: bool enabled,required EarMonitoringFilterType): Future
enableInstantMediaRendering(): Future
enableLocalAudio(enabled: bool): Future
enableLocalVideo(enabled: bool): Future
enableLoopbackRecording(deviceName?: bool enabled,String?): Future
enableMultiCamera(config: bool enabled,required CameraCapturerConfiguration): Future
enableSoundPositionIndication(enabled: bool): Future
enableSpatialAudio(enabled: bool): Future
enableVideo(): Future
enableVideoImageSource(options: bool enable,required ImageTrackOptions): Future
enableVirtualBackground(null: bool enabled,required VirtualBackgroundSource backgroundSource,required SegmentationProperty segproperty,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
enableVoiceAITuner(type: bool enabled,required VoiceAiTunerType): Future
enableWebSdkInteroperability(enabled: bool): Future
getAudioDeviceInfo(): Future
getAudioDeviceManager(): AudioDeviceManager
getAudioMixingCurrentPosition(): Future
getAudioMixingDuration(): Future
getAudioMixingPlayoutVolume(): Future
getAudioMixingPublishVolume(): Future
getAudioTrackCount(): Future
getCallId(): Future
getCameraMaxZoomFactor(): Future
getConnectionState(): Future
getCurrentMonotonicTimeInMs(): Future
getEffectCurrentPosition(soundId: int): Future
getEffectDuration(filePath: String): Future
getEffectsVolume(): Future
getErrorDescription(code: int): Future
getExtensionProperty(null: String provider,required String extension,required String key,required int bufLen,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
getFaceShapeAreaOptions(null: FaceShapeArea shapeArea,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
getFaceShapeBeautyOptions(null: MediaSourceType type = MediaSourceType.primaryCameraSource): Future
getLocalSpatialAudioEngine(): LocalSpatialAudioEngine
getMediaEngine(): MediaEngine
getMusicContentCenter(): MusicContentCenter
getNativeHandle(): Future
getNetworkType(): Future
getNtpWallTimeInMs(): Future
getScreenCaptureSources(includeScreen: Size thumbSize,required Size iconSize,required bool): Future ->
getUserInfoByUid(uid: int): Future
getUserInfoByUserAccount(userAccount: String): Future
getVersion(): Future
getVideoDeviceManager(): VideoDeviceManager
getVolumeOfEffect(soundId: int): Future
initialize(context: RtcEngineContext): Future
isCameraAutoExposureFaceModeSupported(): Future
isCameraAutoFocusFaceModeSupported(): Future
isCameraCenterStageSupported(): Future
isCameraExposurePositionSupported(): Future
isCameraExposureSupported(): Future
isCameraFaceDetectSupported(): Future
isCameraFocusSupported(): Future
isCameraTorchSupported(): Future
isCameraZoomSupported(): Future
isFeatureAvailableOnDevice(type: FeatureType): Future
isSpeakerphoneEnabled(): Future
joinChannel(options: String token,required String channelId,required int uid,required ChannelMediaOptions): Future
joinChannelWithUserAccount(options?: String token,required String channelId,required String userAccount,ChannelMediaOptions?): Future
joinChannelWithUserAccountEx(options: String token,required String channelId,required String userAccount,required ChannelMediaOptions): Future
leaveChannel(options?: LeaveChannelOptions?): Future
loadExtensionProvider(false: String path,bool unloadAfterUse =): Future
muteAllRemoteAudioStreams(mute: bool): Future
muteAllRemoteVideoStreams(mute: bool): Future
muteLocalAudioStream(mute: bool): Future
muteLocalVideoStream(mute: bool): Future
muteRecordingSignal(mute: bool): Future
muteRemoteAudioStream(mute: int uid,required bool): Future
muteRemoteVideoStream(mute: int uid,required bool): Future
pauseAllChannelMediaRelay(): Future
pauseAllEffects(): Future
pauseAudioMixing(): Future
pauseEffect(soundId: int): Future
playAllEffects(false: int loopCount,required double pitch,required double pan,required int gain,bool publish =): Future
playEffect(null: int soundId,required String filePath,required int loopCount,required double pitch,required double pan,required int gain,bool publish = false,int startPos = 0): Future
preloadChannel(uid: String token,required String channelId,required int): Future
preloadChannelWithUserAccount(userAccount: String token,required String channelId,required String): Future
preloadEffect(null: int soundId,required String filePath,int startPos = 0): Future
queryCameraFocalLengthCapability(): Future ->
queryCodecCapability(size: int): Future ->
queryDeviceScore(): Future
queryScreenCaptureCapability(): Future
rate(description: String callId,required int rating,required String): Future
registerAudioEncodedFrameObserver(observer: AudioEncodedFrameObserverConfig config,required AudioEncodedFrameObserver): void
registerAudioSpectrumObserver(observer: AudioSpectrumObserver): void
registerEventHandler(eventHandler: RtcEngineEventHandler): void
registerExtension(null: String provider,required String extension,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
registerLocalUserAccount(userAccount: String appId,required String): Future
registerMediaMetadataObserver(type: MetadataObserver observer,required MetadataType): void
release(false: bool sync =): Future
removeVideoWatermark(id: String): Future
renewToken(token: String): Future
resumeAllChannelMediaRelay(): Future
resumeAllEffects(): Future
resumeAudioMixing(): Future
resumeEffect(soundId: int): Future
selectAudioTrack(index: int): Future
sendCustomReportMessage(value: String id,required String category,required String event,required String label,required int): Future
sendMetaData(sourceType: Metadata metadata,required VideoSourceType): Future
sendStreamMessage(length: int streamId,required Uint8List data,required int): Future
setAINSMode(mode: bool enabled,required AudioAinsMode): Future
setAVSyncSource(uid: String channelId,required int): Future
setAdvancedAudioOptions(options: AdvancedAudioOptions): Future
setAudioEffectParameters(param2: AudioEffectPreset preset,required int param1,required int): Future
setAudioEffectPreset(preset: AudioEffectPreset): Future
setAudioMixingDualMonoMode(mode: AudioMixingDualMonoMode): Future
setAudioMixingPitch(pitch: int): Future
setAudioMixingPlaybackSpeed(speed: int): Future
setAudioMixingPosition(pos: int): Future
setAudioProfile(null: AudioProfileType profile,AudioScenarioType scenario = AudioScenarioType.audioScenarioDefault): Future
setAudioScenario(scenario: AudioScenarioType): Future
setAudioSessionOperationRestriction(restriction: AudioSessionOperationRestriction): Future
setBeautyEffectOptions(null: bool enabled,required BeautyOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setCameraAutoExposureFaceModeEnabled(enabled: bool): Future
setCameraAutoFocusFaceModeEnabled(enabled: bool): Future
setCameraCapturerConfiguration(config: CameraCapturerConfiguration): Future
setCameraDeviceOrientation(orientation: VideoSourceType type,required VideoOrientation): Future
setCameraExposureFactor(factor: double): Future
setCameraExposurePosition(positionYinView: double positionXinView,required double): Future
setCameraFocusPositionInPreview(positionY: double positionX,required double): Future
setCameraStabilizationMode(mode: CameraStabilizationMode): Future
setCameraTorchOn(isOn: bool): Future
setCameraZoomFactor(factor: double): Future
setChannelProfile(profile: ChannelProfileType): Future
setClientRole(options?: ClientRoleType role,ClientRoleOptions?): Future
setCloudProxy(proxyType: CloudProxyType): Future
setColorEnhanceOptions(null: bool enabled,required ColorEnhanceOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setDefaultAudioRouteToSpeakerphone(defaultToSpeaker: bool): Future
setDualStreamMode(streamConfig?: SimulcastStreamMode mode,SimulcastStreamConfig?): Future
setEarMonitoringAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int): Future
setEffectPosition(pos: int soundId,required int): Future
setEffectsVolume(volume: int): Future
setEnableSpeakerphone(speakerOn: bool): Future
setExtensionProperty(null: String provider,required String extension,required String key,required String value,MediaSourceType type = MediaSourceType.unknownMediaSource): Future
setExtensionProviderProperty(value: String provider,required String key,required String): Future
setExternalMediaProjection(mediaProjection: int): Future
setExternalRemoteEglContext(eglContext: int): Future
setFaceShapeAreaOptions(null: FaceShapeAreaOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setFaceShapeBeautyOptions(null: bool enabled,required FaceShapeBeautyOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setFilterEffectOptions(null: bool enabled,required FilterEffectOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setHeadphoneEQParameters(highGain: int lowGain,required int): Future
setHeadphoneEQPreset(preset: HeadphoneEqualizerPreset): Future
setInEarMonitoringVolume(volume: int): Future
setLocalAccessPoint(config: LocalAccessPointConfiguration): Future
setLocalRenderMode(null: RenderModeType renderMode,VideoMirrorModeType mirrorMode = VideoMirrorModeType.videoMirrorModeAuto): Future
setLocalRenderTargetFps(targetFps: VideoSourceType sourceType,required int): Future
setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): Future
setLocalVoiceEqualization(bandGain: AudioEqualizationBandFrequency bandFrequency,required int): Future
setLocalVoiceFormant(formantRatio: double): Future
setLocalVoicePitch(pitch: double): Future
setLocalVoiceReverb(value: AudioReverbType reverbKey,required int): Future
setLogFile(filePath: String): Future
setLogFileSize(fileSizeInKBytes: int): Future
setLogFilter(filter: LogFilterType): Future
setLogLevel(level: LogLevel): Future
setLowlightEnhanceOptions(null: bool enabled,required LowlightEnhanceOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setMaxMetadataSize(size: int): Future
setMixedAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required int): Future
setParameters(parameters: String): Future
setPlaybackAudioFrameBeforeMixingParameters(samplesPerCall: int sampleRate,required int channel {required int sampleRate,required int): Future
setPlaybackAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int): Future
setRecordingAudioFrameParameters(samplesPerCall: int sampleRate,required int channel,required RawAudioFrameOpModeType mode,required int): Future
setRemoteDefaultVideoStreamType(streamType: VideoStreamType): Future
setRemoteRenderMode(mirrorMode: int uid,required RenderModeType renderMode,required VideoMirrorModeType): Future
setRemoteRenderTargetFps(targetFps: int): Future
setRemoteSubscribeFallbackOption(option: StreamFallbackOptions): Future
setRemoteUserSpatialAudioParams(params: int uid,required SpatialAudioParams): Future
setRemoteVideoStreamType(streamType: int uid,required VideoStreamType): Future
setRemoteVideoSubscriptionOptions(options: int uid,required VideoSubscriptionOptions): Future
setRemoteVoicePosition(gain: int uid,required double pan,required double): Future
setRouteInCommunicationMode(route: int): Future
setScreenCaptureContentHint(contentHint: VideoContentHint): Future
setScreenCaptureScenario(screenScenario: ScreenScenarioType): Future
setSubscribeAudioAllowlist(uidNumber: List uidList,required int): Future
setSubscribeAudioBlocklist(uidNumber: List uidList,required int): Future
setSubscribeVideoAllowlist(uidNumber: List uidList,required int): Future
setSubscribeVideoBlocklist(uidNumber: List uidList,required int): Future
setVideoDenoiserOptions(null: bool enabled,required VideoDenoiserOptions options,MediaSourceType type = MediaSourceType.primaryCameraSource): Future
setVideoEncoderConfiguration(config: VideoEncoderConfiguration): Future
setVideoScenario(scenarioType: VideoApplicationScenarioType): Future
setVoiceBeautifierParameters(param2: VoiceBeautifierPreset preset,required int param1,required int): Future
setVoiceBeautifierPreset(preset: VoiceBeautifierPreset): Future
setVoiceConversionPreset(preset: VoiceConversionPreset): Future
setVolumeOfEffect(volume: int soundId,required int): Future
setupLocalVideo(canvas: VideoCanvas): Future
setupRemoteVideo(canvas: VideoCanvas): Future
startAudioMixing(null: String filePath,required bool loopback,required int cycle,int startPos = 0): Future
startAudioRecording(config: AudioRecordingConfiguration): Future
startCameraCapture(config: VideoSourceType sourceType,required CameraCapturerConfiguration): Future
startEchoTest(config: EchoTestConfiguration): Future
startLastmileProbeTest(config: LastmileProbeConfig): Future
startLocalAudioMixer(config: LocalAudioMixerConfiguration): Future
startLocalVideoTranscoder(config: LocalTranscoderConfiguration): Future
startMediaRenderingTracing(): Future
startOrUpdateChannelMediaRelay(configuration: ChannelMediaRelayConfiguration): Future
startPreview(null: VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary): Future
startPreviewWithoutSourceType(): Future
startRhythmPlayer(config: String sound1,required String sound2,required AgoraRhythmPlayerConfig): Future
startRtmpStreamWithTranscoding(transcoding: String url,required LiveTranscoding): Future
startRtmpStreamWithoutTranscoding(url: String): Future
startScreenCapture(captureParams: ScreenCaptureParameters2): Future
startScreenCaptureByDisplayId(captureParams: int displayId,required Rectangle regionRect,required ScreenCaptureParameters): Future
startScreenCaptureByScreenRect(captureParams: Rectangle screenRect,required Rectangle regionRect,required ScreenCaptureParameters): Future
startScreenCaptureBySourceType(config: VideoSourceType sourceType,required ScreenCaptureConfiguration): Future
startScreenCaptureByWindowId(captureParams: int windowId,required Rectangle regionRect,required ScreenCaptureParameters): Future
stopAllEffects(): Future
stopAudioMixing(): Future
stopAudioRecording(): Future
stopCameraCapture(sourceType: VideoSourceType): Future
stopChannelMediaRelay(): Future
stopEchoTest(): Future
stopEffect(soundId: int): Future
stopLastmileProbeTest(): Future
stopLocalAudioMixer(): Future
stopLocalVideoTranscoder(): Future
stopPreview(null: VideoSourceType sourceType = VideoSourceType.videoSourceCameraPrimary): Future
stopRhythmPlayer(): Future
stopRtmpStream(url: String): Future
stopScreenCapture(): Future
stopScreenCaptureBySourceType(sourceType: VideoSourceType): Future
switchCamera(): Future
takeSnapshot(filePath: int uid,required String): Future
takeSnapshotWithConfig(config: int uid,required SnapshotConfig): Future
unloadAllEffects(): Future
unloadEffect(soundId: int): Future
unregisterAudioEncodedFrameObserver(observer: AudioEncodedFrameObserver): void
unregisterAudioSpectrumObserver(observer: AudioSpectrumObserver): void
unregisterEventHandler(eventHandler: RtcEngineEventHandler): void
unregisterMediaMetadataObserver(type: MetadataObserver observer,required MetadataType): void
updateChannelMediaOptions(options: ChannelMediaOptions): Future
updateLocalAudioMixerConfiguration(config: LocalAudioMixerConfiguration): Future
updateLocalTranscoderConfiguration(config: LocalTranscoderConfiguration): Future
updatePreloadChannelToken(token: String): Future
updateRtmpTranscoding(transcoding: LiveTranscoding): Future
updateScreenCapture(captureParams: ScreenCaptureParameters2): Future
updateScreenCaptureParameters(captureParams: ScreenCaptureParameters): Future
updateScreenCaptureRegion(regionRect: Rectangle): Future