Index library

Classes

AECConfig

App-wide echo cancellation settings.

AudioRoutingConfig

Full wake-word audio routing configuration.

AudioRoutingOverride

Partial route override: omitted fields preserve the resolved hardware route.

KeyWordFlutterPC

A class that manages a keyword detection engine and coordinates communication with native platforms using MethodChannel and EventChannel.

PlaybackRoutingConfig

Native playback ducking and restoration policy.

RouteConfigEntry

A per-route audio routing entry for iOS wake-word detection.

SpeakerVerificationMicController

Flutter equivalent of the React Native SpeakerVerificationMicController.

SpeakerVerificationRNBridgeInstance

Flutter equivalent of the React Native SpeakerVerificationRNBridgeInstance.

STTDuckingConfig

Native recognition ducking and restoration policy.

UseModel

A class to manage multiple KeyWordFlutterPC instances, providing convenient APIs for creating, starting, stopping, and removing them.

WakewordAECConfig

Echo cancellation preferences; actual availability depends on hardware.

WakeWordDuringTTSConfig

Temporary detector sensitivity during physical playback.

Enums

AECMode

App-wide echo cancellation mode shared by STT, wake word, and TTS.

WakewordAudioCategory

iOS audio session category values used by wake-word audio routing.

WakewordAudioMode

iOS audio session mode values used by wake-word audio routing.

WakewordAudioOption

iOS audio session category options used by wake-word audio routing.

WakewordPreferredInput

Preferred input selection for wake-word audio routing.

Properties

gLicenseKey ↔ String

A global license key for use across UseModel instances. It can be set via UseModel.setKeywordDetectionLicense.

getter/setter pair

Functions

createKeyWordFlutterPCInstance(String instanceId, {bool isSticky = false}) → KeyWordFlutterPC

Creates and returns a new KeyWordFlutterPC instance with the provided instanceId and optional isSticky value.

createSpeakerVerificationInstance(String engineId) → Future<SpeakerVerificationRNBridgeInstance>

Creates a speaker verification engine wrapper.

createSpeakerVerificationMicController(String controllerId) → Future<SpeakerVerificationMicController>

Creates a speaker verification mic controller wrapper.

getAudioSessionConfigSnapshot() → Future<Map<String, dynamic>>

Returns the current native audio session snapshot.

onSpeakerVerificationError(void callback(Map<String, dynamic>)) → StreamSubscription<Map<String, dynamic>>

Streams speaker verification error events.

onSpeakerVerificationOnboardingDone(void callback(Map<String, dynamic>)) → StreamSubscription<Map<String, dynamic>>

Streams speaker verification onboarding completion events.

onSpeakerVerificationOnboardingProgress(void callback(Map<String, dynamic>)) → StreamSubscription<Map<String, dynamic>>

Streams speaker verification onboarding progress events.

onSpeakerVerificationVerifyResult(void callback(Map<String, dynamic>)) → StreamSubscription<Map<String, dynamic>>

Streams speaker verification result events.

pauseDetection(String instanceId, {bool stopMic = false}) → Future<bool>

Pauses detection for an instance by instanceId.

removeAllRNBridgeListeners() → Future<void>

Cancels all bridge listeners.

setWakewordAudioRoutingConfig(AudioRoutingConfig config) → Future<void>

Sets the native wake-word audio routing configuration.

setWakewordTTSActive(String instanceId, bool active) → Future<bool>

Tells the native audio coordinator whether physical TTS playback is active.

unPauseDetection(String instanceId) → Future<bool>

Resumes detection for an instance by instanceId.

Typedefs

DetectionCallback = void Function(Map<String, dynamic> event)

A callback signature for when a keyword phrase is detected.