Recognizer class
Defines the base class Recognizer which mainly contains common event handlers.
Properties
| internal |
|
| session |
Defines event handler for session started events. |
| session |
Defines event handler for session stopped events. |
| speech |
Defines event handler for speech stopped events. |
| speech |
Defines event handler for speech started events. |
| telemetry |
This method returns the current state of the telemetry setting. |
Methods
| close(() => void, (error: string) => void) | Dispose of associated resources. |
| dispose(boolean) | This method performs cleanup of resources. The Boolean parameter disposing indicates whether the method is called from Dispose (if disposing is true) or from the finalizer (if disposing is false). Derived classes should override this method to dispose resource if needed. |
| enable |
This method globally enables or disables telemetry. |
Property Details
internalData
object internalDataProperty Value
object
sessionStarted
Defines event handler for session started events.
public sessionStarted: (sender: Recognizer, event: SessionEventArgs) => voidProperty Value
(sender: Recognizer, event: SessionEventArgs) => void
sessionStopped
Defines event handler for session stopped events.
public sessionStopped: (sender: Recognizer, event: SessionEventArgs) => voidProperty Value
(sender: Recognizer, event: SessionEventArgs) => void
speechEndDetected
Defines event handler for speech stopped events.
public speechEndDetected: (sender: Recognizer, event: RecognitionEventArgs) => voidProperty Value
(sender: Recognizer, event: RecognitionEventArgs) => void
speechStartDetected
Defines event handler for speech started events.
public speechStartDetected: (sender: Recognizer, event: RecognitionEventArgs) => voidProperty Value
(sender: Recognizer, event: RecognitionEventArgs) => void
telemetryEnabled
This method returns the current state of the telemetry setting.
static boolean telemetryEnabledProperty Value
boolean
true if the telemetry is enabled, false otherwise.
Method Details
close(() => void, (error: string) => void)
Dispose of associated resources.
function close(cb?: () => void, errorCb?: (error: string) => void)Parameters
- cb
-
() => void
- errorCb
-
(error: string) => void
dispose(boolean)
This method performs cleanup of resources. The Boolean parameter disposing indicates whether the method is called from Dispose (if disposing is true) or from the finalizer (if disposing is false). Derived classes should override this method to dispose resource if needed.
function dispose(disposing: boolean): Promise<void>Parameters
- disposing
-
boolean
Flag to request disposal.
Returns
Promise<void>
enableTelemetry(boolean)
This method globally enables or disables telemetry.
static function enableTelemetry(enabled: boolean)Parameters
- enabled
-
boolean
Global setting for telemetry collection. If set to true, telemetry information like microphone errors, recognition errors are collected and sent to Microsoft. If set to false, no telemetry is sent to Microsoft.