FlutterWakeWord class

Provides a Dart API for configuring and controlling wake word detection.

Constructors

FlutterWakeWord()

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

useModel → UseModel

The model manager used to create, start, and stop detector instances.

final

Methods

createInstance(String instanceId, String modelName, double threshold, int bufferCnt) → Future<void>

Creates a detection instance for a single wake word modelName.

createInstanceMulti(String instanceId, List<String> modelNames, List<double> thresholds, List<int> bufferCnts, List<int> msBetweenCallback) → Future<void>

Creates a detection instance that can listen for multiple wake word models.

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

Returns the current native audio session snapshot.

getPlatformVersion() → Future<String?>

Returns the current platform version.

getRecordingWav(String instanceId) → Future<String?>

Returns the current recording WAV path or native payload for instanceId.

getRecordingWavArray(String instanceId) → Future<List<int>>

Returns the current recording as a WAV byte array for instanceId.

getVADParams(String instanceId) → Future<Map<String, dynamic>>

Returns VAD runtime params for instanceId.

getVoiceProps(String instanceId) → Future<Map<String, dynamic>>

Returns native VAD voice properties for instanceId.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onKeywordDetectionEvent() → Stream<Map<String, dynamic>>

Streams keyword detection events.

onVADDetectionEvent(String instanceId) → Stream<Map<String, dynamic>>

Streams VAD events for instanceId.

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

Pauses detection for instanceId.

removeAllRNBridgeListeners() → Future<void>

Cancels all tracked bridge listeners.

setKeywordDetectionLicense(String license) → Future<void>

Sets the keyword detection license used by subsequently created instances.

setKeywordLicense(String instanceId, String license) → Future<bool>

Alias for setting the keyword license on instanceId.

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

Tells an Android detector whether physical TTS playback is active.

setVADParams(String instanceId, double threshold, int msWindow) → Future<bool>

Sets VAD runtime params for instanceId.

setWakewordAudioRoutingConfig(AudioRoutingConfig config) → Future<void>

Sets native wake-word audio routing config.

startKeywordDetection(double threshold) → Future<void>

Starts keyword detection for all configured instances.

startSilentVADDetection(String instanceId) → Future<bool>

Starts silent VAD detection for instanceId.

startVADDetection(String instanceId) → Future<bool>

Starts VAD detection for instanceId.

stopKeywordDetection() → Future<void>

Stops keyword detection for all configured instances.

stopSilentVADDetection(String instanceId) → Future<bool>

Stops silent VAD detection for instanceId.

stopVADDetection(String instanceId) → Future<bool>

Stops VAD detection for instanceId.

toString() → String

A string representation of this object.

inherited

unPauseDetection(String instanceId) → Future<bool>

Resumes detection for instanceId.

Operators

operator ==(Object other) → bool

The equality operator.

inherited