EngineApi class

Constructors

EngineApi({BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''})

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

pigeonVar_binaryMessenger → BinaryMessenger?

final

pigeonVar_messageChannelSuffix → String

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addBeautyFilter(String path, String name) → Future<int>

addLiveStreamTask(AddOrUpdateLiveStreamTaskRequest request) → Future<int>

addLocalRecorderStreamLayoutForTask(LocalRecordingLayoutConfig config, int uid, int streamType, int streamLayer, int taskId) → Future<int>

addLocalRecordStreamForTask(LocalRecordingConfig config, String taskId) → Future<int>

adjustLoopBackRecordingSignalVolume(int volume) → Future<int>

adjustPlaybackSignalVolume(int volume) → Future<int>

adjustRecordingSignalVolume(int volume) → Future<int>

adjustUserPlaybackSignalVolume(AdjustUserPlaybackSignalVolumeRequest request) → Future<int>

aiManualInterrupt(int dstUid) → Future<int>

AINSMode(int mode) → Future<int>

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

clearStatsEventCallback() → Future<int>

create(CreateEngineRequest request) → Future<int>

createChannel(String channelTag) → Future<int>

enableAudioVolumeIndication(EnableAudioVolumeIndicationRequest request) → Future<int>

enableBeauty(bool enabled) → Future<int>

enableDualStreamMode(bool enable) → Future<int>

enableEncryption(EnableEncryptionRequest request) → Future<int>

enableLocalAudio(bool enable) → Future<int>

enableLocalData(bool enabled) → Future<int>

enableLocalSubStreamAudio(bool enable) → Future<int>

enableLocalVideo(EnableLocalVideoRequest request) → Future<int>

enableLoopbackRecording(bool enable) → Future<int>

enableMediaPub(int mediaType, bool enable) → Future<int>

enableSpatializer(bool enable, bool applyToTeam) → Future<int>

enableSpatializerRoomEffects(bool enable) → Future<int>

enableSuperResolution(bool enable) → Future<int>

enableVideoCorrection(bool enable) → Future<int>

enableVirtualBackground(EnableVirtualBackgroundRequest request) → Future<int>

getConnectionState() → Future<int>

getEffectDuration(int effectId) → Future<int>

getFeatureSupportedType(int type) → Future<int>

getNetworkType() → Future<int>

getNtpTimeOffset() → Future<int>

getParameter(String key, String extraInfo) → Future<String>

isFeatureSupported(int type) → Future<bool>

joinChannel(JoinChannelRequest request) → Future<int>

leaveChannel() → Future<int>

muteAudioForPlayStreaming(String streamId, bool mute) → Future<int>

muteLocalAudioStream(bool mute) → Future<int>

muteLocalSubStreamAudio(bool muted) → Future<int>

muteLocalVideoStream(bool mute, int streamType) → Future<int>

muteVideoForPlayStreaming(String streamId, bool mute) → Future<int>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pausePlayStreaming(String streamId) → Future<int>

pushExternalAudioFrame(AudioExternalFrame frame) → Future<int>

pushExternalSubAudioFrame(AudioExternalFrame frame) → Future<int>

pushExternalVideoFrame(int streamType, VideoFrame frame) → Future<int>

pushLocalRecorderVideoFrameForTask(int uid, int streamType, int streamLayer, String taskId, VideoFrame frame) → Future<int>

release() → Future<int>

removeBeautyFilter() → Future<void>

removeLiveStreamTask(DeleteLiveStreamTaskRequest request) → Future<int>

removeLocalRecorderStreamForTask(String taskId) → Future<int>

removeLocalRecorderStreamLayoutForTask(int uid, int streamType, int streamLayer, String taskId) → Future<int>

remuxFlvToMp4(String flvPath, String mp4Path, bool saveOri) → Future<int>

replaceLocalRecorderStreamLayoutForTask(List<LocalRecordingStreamInfo?> infos, String taskId) → Future<int>

reportCustomEvent(ReportCustomEventRequest request) → Future<int>

requestLLM(RequestLLMRequest request) → Future<NERtcLLMRequestResult>

请求LLM

resumePlayStreaming(String streamId) → Future<int>

sendData(DataExternalFrame frame) → Future<int>

sendSEIMsg(SendSEIMsgRequest request) → Future<int>

setAudioEffectPreset(int preset) → Future<int>

setAudioProfile(SetAudioProfileRequest request) → Future<int>

setAudioRecvRange(int audibleDistance, int conversationalDistance, int rollOffMode) → Future<int>

setAudioScenario(int scenario) → Future<int>

setAudioSessionOperationRestriction(int option) → Future<int>

setAudioSubscribeOnlyBy(SetAudioSubscribeOnlyByRequest request) → Future<int>

setBeautyEffect(double level, int beautyType) → Future<int>

setBeautyFilterLevel(double level) → Future<int>

setCameraCaptureConfig(SetCameraCaptureConfigRequest request) → Future<int>

setChannelProfile(int channelProfile) → Future<int>

setClientRole(int role) → Future<int>

setCloudProxy(int proxyType) → Future<int>

setExternalAudioSource(bool enabled, int sampleRate, int channels) → Future<int>

setExternalSubStreamAudioSource(bool enabled, int sampleRate, int channels) → Future<int>

setExternalVideoSource(int streamType, bool enable) → Future<int>

setLocalMediaPriority(SetLocalMediaPriorityRequest request) → Future<int>

setLocalPublishFallbackOption(int option) → Future<int>

setLocalVideoConfig(SetLocalVideoConfigRequest request) → Future<int>

setLocalVideoWatermarkConfigs(SetLocalVideoWatermarkConfigsRequest request) → Future<int>

setLocalVoiceEqualization(SetLocalVoiceEqualizationRequest request) → Future<int>

setLocalVoicePitch(double pitch) → Future<int>

setLocalVoiceReverbParam(SetLocalVoiceReverbParamRequest request) → Future<int>

setMultiPathOption(SetMultiPathOptionRequest request) → Future<int>

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

setRangeAudioMode(int audioMode) → Future<int>

setRangeAudioTeamID(int teamID) → Future<int>

setRemoteHighPriorityAudioStream(SetRemoteHighPriorityAudioStreamRequest request) → Future<int>

setRemoteSubscribeFallbackOption(int option) → Future<int>

setSpatializerRenderMode(int renderMode) → Future<int>

setSpatializerRoomProperty(SpatializerRoomProperty property) → Future<int>

setStatsEventCallback() → Future<int>

setStreamAlignmentProperty(bool enable) → Future<int>

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

setSubscribeAudioBlocklist(List<int?> uidArray, int streamType) → Future<int>

setUpSpatializer() → Future<int>

setVideoCorrectionConfig(SetVideoCorrectionConfigRequest request) → Future<int>

setVideoDump(int dumpType) → Future<int>

setVideoRotationMode(int rotationMode) → Future<int>

setVideoStreamLayerCount(int layerCount) → Future<int>

setVoiceBeautifierPreset(int preset) → Future<int>

showLocalRecorderStreamDefaultCoverForTask(bool showEnabled, int uid, int streamType, int streamLayer, String taskId) → Future<int>

startASRCaption(StartASRCaptionRequest request) → Future<int>

startAudioDump() → Future<int>

startAudioDumpWithType(int dumpType) → Future<int>

startAudioRecording(StartAudioRecordingRequest request) → Future<int>

startAudioRecordingWithConfig(AudioRecordingConfigurationRequest request) → Future<int>

startBeauty() → Future<int>

startChannelMediaRelay(StartOrUpdateChannelMediaRelayRequest request) → Future<int>

startLastmileProbeTest(StartLastmileProbeTestRequest request) → Future<int>

startPlayStreaming(StartPlayStreamingRequest request) → Future<int>

startPushStreaming(StartPushStreamingRequest request) → Future<int>

startScreenCapture(StartScreenCaptureRequest request) → Future<int>

startVideoPreview(StartorStopVideoPreviewRequest request) → Future<int>

stopASRCaption() → Future<int>

stopAudioDump() → Future<int>

stopAudioRecording() → Future<int>

stopBeauty() → Future<void>

stopChannelMediaRelay() → Future<int>

stopLastmileProbeTest() → Future<int>

stopLocalRecorderRemuxMp4(String taskId) → Future<int>

stopPlayStreaming(String streamId) → Future<int>

stopPushStreaming() → Future<int>

stopRemuxFlvToMp4() → Future<int>

stopScreenCapture() → Future<int>

stopVideoPreview(StartorStopVideoPreviewRequest request) → Future<int>

subscribeAllRemoteAudio(bool subscribe) → Future<int>

subscribeRemoteAudio(SubscribeRemoteAudioRequest request) → Future<int>

subscribeRemoteData(bool subscribe, int userID) → Future<int>

subscribeRemoteSubStreamAudio(SubscribeRemoteSubStreamAudioRequest request) → Future<int>

subscribeRemoteSubStreamVideo(SubscribeRemoteSubStreamVideoRequest request) → Future<int>

subscribeRemoteVideoStream(SubscribeRemoteVideoStreamRequest request) → Future<int>

switchChannel(SwitchChannelRequest request) → Future<int>

takeLocalSnapshot(int streamType, String path) → Future<int>

takeRemoteSnapshot(int uid, int streamType, String path) → Future<int>

toString() → String

A string representation of this object.

inherited

updateChannelMediaRelay(StartOrUpdateChannelMediaRelayRequest request) → Future<int>

updateLiveStreamTask(AddOrUpdateLiveStreamTaskRequest request) → Future<int>

updateLocalRecorderStreamLayoutForTask(List<LocalRecordingStreamInfo?> infos, String taskId) → Future<int>

updateLocalRecorderWaterMarksForTask(List<VideoWatermarkConfig?> watermarks, String taskId) → Future<int>

updatePermissionKey(String key) → Future<int>

updateSelfPosition(PositionInfo positionInfo) → Future<int>

uploadSdkInfo() → Future<int>

version() → Future<NERtcVersion>

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

pigeonChannelCodec → const MessageCodec<Object?>