SpeechRecognitionEngine Members

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Provides the means to access and manage a speech recognition engine.

The SpeechRecognitionEngine type exposes the following members.

Constructors

  NameDescription
Public methodSpeechRecognitionEngine()()()()Initializes a new instance of the SpeechRecognitionEngine class using the default speech recognizer for the system.
Public methodSpeechRecognitionEngine(CultureInfo)Initializes a new instance of the SpeechRecognitionEngine class using the default speech recognizer for a specified locale.
Public methodSpeechRecognitionEngine(String)Initializes a new instance of the SpeechRecognitionEngine class with a string parameter that specifies the name of the recognizer to use.
Public methodSpeechRecognitionEngine(RecognizerInfo)Initializes a new instance of the SpeechRecognitionEngine using the information in a RecognizerInfo object to specify the recognizer to use.
Top

Properties

  NameDescription
Public propertyAudioFormatGets the format of the audio being received by the SpeechRecognitionEngine.
Public propertyAudioLevelGets the level of the audio being received by the SpeechRecognitionEngine.
Public propertyAudioPositionGets the current location in the audio stream being generated by the device that is providing input to the SpeechRecognitionEngine.
Public propertyAudioStateGets the state of the audio being received by the SpeechRecognitionEngine.
Public propertyBabbleTimeoutGets or sets the interval of time that a SpeechRecognitionEngine accepts input containing only background noise before finalizing recognition.
Public propertyEndSilenceTimeoutGets or sets the interval of silence that the SpeechRecognitionEngine will accept at the end of unambiguous input before finalizing a recognition operation.
Public propertyEndSilenceTimeoutAmbiguousGets or sets the interval of silence that the SpeechRecognitionEngine will accept at the end of ambiguous input before finalizing a recognition operation.
Public propertyGrammarsGets a collection of the Grammar objects that are loaded in this SpeechRecognitionEngine instance.
Public propertyInitialSilenceTimeoutGets or sets the time interval during which a SpeechRecognitionEngine accepts input containing only silence before finalizing recognition.
Public propertyMaxAlternatesGets or sets the maximum number of alternate recognition results that the SpeechRecognitionEngine returns for each recognition operation.
Public propertyNormalizerCollectionGets the normalizer collection.
Public propertyRecognizerAudioPositionGets the current location of the SpeechRecognitionEngine in the audio input that it is processing.
Public propertyRecognizerInfoGets information about the current instance of SpeechRecognitionEngine.
Top

Methods

  NameDescription
Public methodDispose()()()()Disposes the SpeechRecognitionEngine object.
Protected methodDispose(Boolean)Disposes the SpeechRecognitionEngine object and releases resources used during the session.
Public methodEmulateRecognize(String)Emulates input of a phrase to the speech recognizer, using text in place of audio for synchronous speech recognition.
Public methodEmulateRecognize(String, EmulateOptions)Emulates input of a phrase to the speech recognizer, using text in place of audio for synchronous speech recognition, and specifies the type of recognition operation to perform.
Public methodEmulateRecognize(String, CompareOptions)Emulates audio input to the recognition engine, using text in place of audio for synchronous speech recognition, and specifies how the recognizer handles Unicode comparison between the phrase and the loaded speech recognition grammars
Public methodEmulateRecognize(array<RecognizedWordUnit>[]()[][], CompareOptions)Emulates input of specific words to the speech recognizer, using an array of RecognizedWordUnit objects in place of audio for synchronous speech recognition, and specifies how the recognizer handles Unicode comparison between the words and the loaded speech recognition grammars.
Public methodEmulateRecognize(String, CompareOptions, EmulateOptions)Emulates audio input to the recognition engine, using text in place of audio for synchronous speech recognition, specifies how the recognizer handles Unicode comparison between the phrase and the loaded speech recognition grammars, and specifies the type of recognition operation to perform.
Public methodEmulateRecognize(array<RecognizedWordUnit>[]()[][], CompareOptions, EmulateOptions)Emulates input of specific words to the speech recognizer, using an array of RecognizedWordUnit objects in place of audio for synchronous speech recognition, specifies how the recognizer handles Unicode comparison between the words and the loaded speech recognition grammars, and specifies the type of recognition operation to perform.
Public methodEmulateRecognizeAsync(String)Emulates input of a phrase to the speech recognizer, using text in place of audio for asynchronous speech recognition.
Public methodEmulateRecognizeAsync(String, EmulateOptions)Emulates input of a phrase to the speech recognizer, using text in place of audio for asynchronous speech recognition, and specifies the type of recognition operation to perform.
Public methodEmulateRecognizeAsync(String, CompareOptions)Emulates input of a phrase to the speech recognizer, using text in place of audio for asynchronous speech recognition, and specifies how the recognizer handles Unicode comparison between the phrase and the loaded speech recognition grammars.
Public methodEmulateRecognizeAsync(array<RecognizedWordUnit>[]()[][], CompareOptions)Emulates input of specific words to the speech recognizer, using text in place of audio for asynchronous speech recognition, and specifies how the recognizer handles Unicode comparison between the words and the loaded speech recognition grammars.
Public methodEmulateRecognizeAsync(String, CompareOptions, EmulateOptions)Emulates audio input to the recognition engine, using text in place of audio for asynchronous speech recognition, specifies how the recognizer handles Unicode comparison between the phrase and the loaded speech recognition grammars, and specifies the type of recognition operation to perform.
Public methodEmulateRecognizeAsync(array<RecognizedWordUnit>[]()[][], CompareOptions, EmulateOptions)Emulates input of specific words to the speech recognizer, using an array of RecognizedWordUnit objects in place of audio for asynchronous speech recognition, specifies how the recognizer handles Unicode comparison between the words and the loaded speech recognition grammars, and specifies the type of recognition operation to perform.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodStatic memberInstalledRecognizersReturns information for all of the installed speech recognizers on the current system.
Public methodLoadGrammarSynchronously loads a Grammar object.
Public methodLoadGrammarAsyncAsynchronously loads a Grammar object.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodQueryRecognizerSettingReturns the values of the current settings for a speech recognition engine managed by a SpeechRecognitionEngine object.
Public methodRecognize()()()()Performs a synchronous speech recognition operation.
Public methodRecognize(TimeSpan)Performs a synchronous speech recognition operation with a specified initial silence timeout period.
Public methodRecognizeAsync()()()()Performs a single, asynchronous speech recognition operation.
Public methodRecognizeAsync(RecognizeMode)Performs one or more asynchronous speech recognition operations.
Public methodRecognizeAsyncCancelTerminates asynchronous recognition without waiting for the current recognition operation to complete.
Public methodRecognizeAsyncStopStops asynchronous recognition after the current recognition operation completes.
Public methodRequestRecognizerUpdate()()()()Requests that the recognizer pauses to update its state.
Public methodRequestRecognizerUpdate(Object)Requests that the recognizer pauses to update its state and provides a user token for the associated event.
Public methodRequestRecognizerUpdate(Object, TimeSpan)Requests that the recognizer pauses to update its state and provides an offset and a user token for the associated event.
Public methodSetInputToAudioStreamConfigures the SpeechRecognitionEngine object to receive input from an audio stream.
Public methodSetInputToDefaultAudioDeviceConfigures the SpeechRecognitionEngine object to receive input from the default audio device.
Public methodSetInputToNullDisables the input to the speech recognizer.
Public methodSetInputToWaveFileConfigures the SpeechRecognitionEngine object to receive input from a Waveform audio format (.wav) file.
Public methodSetInputToWaveStreamConfigures the SpeechRecognitionEngine object to receive input from a stream that contains Waveform audio format (.wav) data.
Public methodSimulateRecognizeSimulates recognition of the specified string.
Public methodToString (Inherited from Object.)
Public methodUnloadAllGrammarsUnloads all Grammar objects from the recognizer.
Public methodUnloadGrammarUnloads a specified Grammar object from the SpeechRecognitionEngine instance.
Public methodUpdateRecognizerSetting(String, Int32)Updates the specified setting for the SpeechRecognitionEngine with the specified integer value.
Public methodUpdateRecognizerSetting(String, String)Updates the specified setting for the SpeechRecognitionEngine with the specified integer value.
Top

Events

  NameDescription
Public eventAudioLevelUpdatedRaised when the SpeechRecognitionEngine reports the level of its audio input.
Public eventAudioSignalProblemOccurredRaised when the SpeechRecognitionEngine detects a problem in the audio signal.
Public eventAudioStateChangedRaised when the state changes in the audio being received by the SpeechRecognitionEngine.
Public eventEmulateRecognizeCompletedRaised when the SpeechRecognitionEngine finalizes an asynchronous recognition operation of emulated input.
Public eventLoadGrammarCompletedRaised when the SpeechRecognitionEngine finishes the asynchronous loading of a Grammar object.
Public eventRecognizeCompletedRaised when the SpeechRecognitionEngine finalizes an asynchronous recognition operation.
Public eventRecognizerUpdateReachedRaised when a running SpeechRecognitionEngine pauses to accept modifications.
Public eventSpeechDetectedRaised when the SpeechRecognitionEngine detects input that it can identify as speech.
Public eventSpeechHypothesizedRaised when the SpeechRecognitionEngine has recognized a word or words that may be a component of multiple complete phrases in a grammar.
Public eventSpeechRecognitionRejectedRaised when the SpeechRecognitionEngine receives input that does not match any of its loaded and enabled Grammar objects.
Public eventSpeechRecognizedRaised when the SpeechRecognitionEngine receives input that matches any of its loaded and enabled Grammar objects.
Top

See Also