EngineApi class

Constructors

EngineApi({BinaryMessenger? binaryMessenger})

Constructor for EngineApi. The binaryMessenger named argument is available for dependency injection. If it is left null, the default BinaryMessenger will be used which routes to the host platform.

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

addBeautyFilter(String arg_path, String arg_name) → Future<int>

addLiveStreamTask(AddOrUpdateLiveStreamTaskRequest arg_request) → Future<int>

addLocalRecorderStreamLayoutForTask(LocalRecordingLayoutConfig arg_config, int arg_uid, int arg_streamType, int arg_streamLayer, int arg_taskId) → Future<int>

addLocalRecordStreamForTask(LocalRecordingConfig arg_config, String arg_taskId) → Future<int>

adjustLoopBackRecordingSignalVolume(int arg_volume) → Future<int>

adjustPlaybackSignalVolume(int arg_volume) → Future<int>

adjustRecordingSignalVolume(int arg_volume) → Future<int>

adjustUserPlaybackSignalVolume(AdjustUserPlaybackSignalVolumeRequest arg_request) → Future<int>

aiManualInterrupt(int arg_dstUid) → Future<int>

AINSMode(int arg_mode) → Future<int>

checkPermission() → Future<List<String?>?>

clearStatsEventCallback() → Future<int>

create(CreateEngineRequest arg_request) → Future<int>

createChannel(String arg_channelTag) → Future<int>

enableAudioVolumeIndication(EnableAudioVolumeIndicationRequest arg_request) → Future<int>

enableBeauty(bool arg_enabled) → Future<int>

enableDualStreamMode(bool arg_enable) → Future<int>

enableEncryption(EnableEncryptionRequest arg_request) → Future<int>

enableLocalAudio(bool arg_enable) → Future<int>

enableLocalData(bool arg_enabled) → Future<int>

enableLocalSubStreamAudio(bool arg_enable) → Future<int>

enableLocalVideo(EnableLocalVideoRequest arg_request) → Future<int>

enableLoopbackRecording(bool arg_enable) → Future<int>

enableMediaPub(int arg_mediaType, bool arg_enable) → Future<int>

enableSpatializer(bool arg_enable, bool arg_applyToTeam) → Future<int>

enableSpatializerRoomEffects(bool arg_enable) → Future<int>

enableSuperResolution(bool arg_enable) → Future<int>

enableVideoCorrection(bool arg_enable) → Future<int>

enableVirtualBackground(EnableVirtualBackgroundRequest arg_request) → Future<int>

getConnectionState() → Future<int>

getEffectDuration(int arg_effectId) → Future<int>

getFeatureSupportedType(int arg_type) → Future<int>

getNetworkType() → Future<int>

getNtpTimeOffset() → Future<int>

getParameter(String arg_key, String arg_extraInfo) → Future<String>

isFeatureSupported(int arg_type) → Future<bool>

joinChannel(JoinChannelRequest arg_request) → Future<int>

leaveChannel() → Future<int>

muteAudioForPlayStreaming(String arg_streamId, bool arg_mute) → Future<int>

muteLocalAudioStream(bool arg_mute) → Future<int>

muteLocalSubStreamAudio(bool arg_muted) → Future<int>

muteLocalVideoStream(bool arg_mute, int arg_streamType) → Future<int>

muteVideoForPlayStreaming(String arg_streamId, bool arg_mute) → Future<int>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pausePlayStreaming(String arg_streamId) → Future<int>

pushExternalAudioFrame(AudioExternalFrame arg_frame) → Future<int>

pushExternalSubAudioFrame(AudioExternalFrame arg_frame) → Future<int>

pushExternalVideoFrame(int arg_streamType, VideoFrame arg_frame) → Future<int>

pushLocalRecorderVideoFrameForTask(int arg_uid, int arg_streamType, int arg_streamLayer, String arg_taskId, VideoFrame arg_frame) → Future<int>

release() → Future<int>

removeBeautyFilter() → Future<void>

removeLiveStreamTask(DeleteLiveStreamTaskRequest arg_request) → Future<int>

removeLocalRecorderStreamForTask(String arg_taskId) → Future<int>

removeLocalRecorderStreamLayoutForTask(int arg_uid, int arg_streamType, int arg_streamLayer, String arg_taskId) → Future<int>

remuxFlvToMp4(String arg_flvPath, String arg_mp4Path, bool arg_saveOri) → Future<int>

replaceLocalRecorderStreamLayoutForTask(List<LocalRecordingStreamInfo?> arg_infos, String arg_taskId) → Future<int>

reportCustomEvent(ReportCustomEventRequest arg_request) → Future<int>

resumePlayStreaming(String arg_streamId) → Future<int>

sendData(DataExternalFrame arg_frame) → Future<int>

sendSEIMsg(SendSEIMsgRequest arg_request) → Future<int>

setAudioEffectPreset(int arg_preset) → Future<int>

setAudioProfile(SetAudioProfileRequest arg_request) → Future<int>

setAudioRecvRange(int arg_audibleDistance, int arg_conversationalDistance, int arg_rollOffMode) → Future<int>

setAudioScenario(int arg_scenario) → Future<int>

setAudioSessionOperationRestriction(int arg_option) → Future<int>

setAudioSubscribeOnlyBy(SetAudioSubscribeOnlyByRequest arg_request) → Future<int>

setBeautyEffect(double arg_level, int arg_beautyType) → Future<int>

setBeautyFilterLevel(double arg_level) → Future<int>

setCameraCaptureConfig(SetCameraCaptureConfigRequest arg_request) → Future<int>

setChannelProfile(int arg_channelProfile) → Future<int>

setClientRole(int arg_role) → Future<int>

setCloudProxy(int arg_proxyType) → Future<int>

setExternalAudioSource(bool arg_enabled, int arg_sampleRate, int arg_channels) → Future<int>

setExternalSubStreamAudioSource(bool arg_enabled, int arg_sampleRate, int arg_channels) → Future<int>

setExternalVideoSource(int arg_streamType, bool arg_enable) → Future<int>

setLocalMediaPriority(SetLocalMediaPriorityRequest arg_request) → Future<int>

setLocalPublishFallbackOption(int arg_option) → Future<int>

setLocalVideoConfig(SetLocalVideoConfigRequest arg_request) → Future<int>

setLocalVideoWatermarkConfigs(SetLocalVideoWatermarkConfigsRequest arg_request) → Future<int>

setLocalVoiceEqualization(SetLocalVoiceEqualizationRequest arg_request) → Future<int>

setLocalVoicePitch(double arg_pitch) → Future<int>

setLocalVoiceReverbParam(SetLocalVoiceReverbParamRequest arg_request) → Future<int>

setMultiPathOption(SetMultiPathOptionRequest arg_request) → Future<int>

setParameters(Map<String?, Object?> arg_params) → Future<int>

setRangeAudioMode(int arg_audioMode) → Future<int>

setRangeAudioTeamID(int arg_teamID) → Future<int>

setRemoteHighPriorityAudioStream(SetRemoteHighPriorityAudioStreamRequest arg_request) → Future<int>

setRemoteSubscribeFallbackOption(int arg_option) → Future<int>

setSpatializerRenderMode(int arg_renderMode) → Future<int>

setSpatializerRoomProperty(SpatializerRoomProperty arg_property) → Future<int>

setStatsEventCallback() → Future<int>

setStreamAlignmentProperty(bool arg_enable) → Future<int>

setSubscribeAudioAllowlist(List<int?> arg_uidArray) → Future<int>

setSubscribeAudioBlocklist(List<int?> arg_uidArray, int arg_streamType) → Future<int>

setUpSpatializer() → Future<int>

setVideoCorrectionConfig(SetVideoCorrectionConfigRequest arg_request) → Future<int>

setVideoDump(int arg_dumpType) → Future<int>

setVideoRotationMode(int arg_rotationMode) → Future<int>

setVideoStreamLayerCount(int arg_layerCount) → Future<int>

setVoiceBeautifierPreset(int arg_preset) → Future<int>

showLocalRecorderStreamDefaultCoverForTask(bool arg_showEnabled, int arg_uid, int arg_streamType, int arg_streamLayer, String arg_taskId) → Future<int>

startASRCaption(StartASRCaptionRequest arg_request) → Future<int>

startAudioDump() → Future<int>

startAudioDumpWithType(int arg_dumpType) → Future<int>

startAudioRecording(StartAudioRecordingRequest arg_request) → Future<int>

startAudioRecordingWithConfig(AudioRecordingConfigurationRequest arg_request) → Future<int>

startBeauty() → Future<int>

startChannelMediaRelay(StartOrUpdateChannelMediaRelayRequest arg_request) → Future<int>

startLastmileProbeTest(StartLastmileProbeTestRequest arg_request) → Future<int>

startPlayStreaming(StartPlayStreamingRequest arg_request) → Future<int>

startPushStreaming(StartPushStreamingRequest arg_request) → Future<int>

startScreenCapture(StartScreenCaptureRequest arg_request) → Future<int>

startVideoPreview(StartorStopVideoPreviewRequest arg_request) → Future<int>

stopASRCaption() → Future<int>

stopAudioDump() → Future<int>

stopAudioRecording() → Future<int>

stopBeauty() → Future<void>

stopChannelMediaRelay() → Future<int>

stopLastmileProbeTest() → Future<int>

stopLocalRecorderRemuxMp4(String arg_taskId) → Future<int>

stopPlayStreaming(String arg_streamId) → Future<int>

stopPushStreaming() → Future<int>

stopRemuxFlvToMp4() → Future<int>

stopScreenCapture() → Future<int>

stopVideoPreview(StartorStopVideoPreviewRequest arg_request) → Future<int>

subscribeAllRemoteAudio(bool arg_subscribe) → Future<int>

subscribeRemoteAudio(SubscribeRemoteAudioRequest arg_request) → Future<int>

subscribeRemoteData(bool arg_subscribe, int arg_userID) → Future<int>

subscribeRemoteSubStreamAudio(SubscribeRemoteSubStreamAudioRequest arg_request) → Future<int>

subscribeRemoteSubStreamVideo(SubscribeRemoteSubStreamVideoRequest arg_request) → Future<int>

subscribeRemoteVideoStream(SubscribeRemoteVideoStreamRequest arg_request) → Future<int>

switchChannel(SwitchChannelRequest arg_request) → Future<int>

takeLocalSnapshot(int arg_streamType, String arg_path) → Future<int>

takeRemoteSnapshot(int arg_uid, int arg_streamType, String arg_path) → Future<int>

toString() → String

A string representation of this object.

inherited

updateChannelMediaRelay(StartOrUpdateChannelMediaRelayRequest arg_request) → Future<int>

updateLiveStreamTask(AddOrUpdateLiveStreamTaskRequest arg_request) → Future<int>

updateLocalRecorderStreamLayoutForTask(List<LocalRecordingStreamInfo?> arg_infos, String arg_taskId) → Future<int>

updateLocalRecorderWaterMarksForTask(List<VideoWatermarkConfig?> arg_watermarks, String arg_taskId) → Future<int>

updatePermissionKey(String arg_key) → Future<int>

updateSelfPosition(PositionInfo arg_positionInfo) → Future<int>

uploadSdkInfo() → Future<int>

version() → Future<NERtcVersion>

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

codec → const MessageCodec<Object?>