Automation Interfaces and Objects (SAPI 5.4)

Speech API 5.4
Microsoft Speech API 5.4

Automation Interfaces and Objects

The Automation Interfaces provide object-oriented access to the speech recognition and text-to-speech capabilities of SAPI.

Please note that all automation interface names begin with "ISpeech" and that all automation object names begin with "Sp." Applications can explicitly create object variables which instantiate automation objects, using the "CreateObject" statement or the "New" keyword in a "Dim" or "Set" statement. Object variables which instantiate automation interfaces, on the other hand, are only created by the methods, properties and events of automation objects.

Additionally, some automation interfaces are implemented by automation objects, and the properties and methods of those interfaces are inherited by the objects. For example, the ISpeechBaseStream interface defines a set of properties and methods for storing and manipulating audio data in memory. The SpFileStream, SpMemoryStream and SpCustomStream objects implement the ISpeechBaseStream interface; as a result, the methods and properties of the ISpeechBaseStream interface are available in all three objects.

Automation Interfaces and Objects

SAPI 5.1 Automation consists of the following interfaces and objects:

ISpeechAudioSupports the control of real-time audio streams, such as those connected to a live microphone or telephone line.
ISpeechAudioBufferInfoDefines the audio stream buffer information.
ISpeechAudioStatusProvides control over the operation of real-time audio streams.
ISpeechBaseStreamDefines properties and methods common to all audio stream objects.
ISpeechDataKeyProvides access to the speech configuration database.
ISpeechGrammarRuleDefines the properties and methods of a speech grammar rule.
ISpeechGrammarRulesRepresents a collection of ISpeechGrammarRule objects.
ISpeechGrammarRuleStatePresents the properties and methods of a speech grammar rule state.
ISpeechGrammarRuleStateTransitionReturns data about a transition from one rule state to another, or from a rule state to the end of a rule.
ISpeechGrammarRuleStateTransitionsRepresents a collection of ISpeechGrammarRuleStateTransition objects.
ISpeechLexiconPronunciationProvides access to the pronunciations of a speech lexicon word.
ISpeechLexiconPronunciationsRepresents a collection of ISpeechLexiconPronunciation objects.
ISpeechLexiconWordProvides access to a speech lexicon word.
ISpeechLexiconWordsRepresents a collection of ISpeechLexiconWord objects.
ISpeechObjectTokensRepresents a collection of SpObjectToken objects.
ISpeechPhraseAlternateEnables applications to retrieve alternate phrase information from an SR engine, and to update the SR engine's language model to reflect committed alternate changes.
ISpeechPhraseAlternatesRepresents a collection of ISpeechPhraseAlternate objects.
ISpeechPhraseElementProvides access to information about a word or phrase.
ISpeechPhraseElementsRepresents a collection of ISpeechPhraseElement objects.
ISpeechPhraseInfoContains properties detailing phrase elements.
ISpeechPhrasePropertiesRepresents a collection of ISpeechPhraseProperty objects.
ISpeechPhrasePropertyStores the information for a semantic property.
ISpeechPhraseReplacementSpecifies a replacement, or text normalization, of one or more spoken words.
ISpeechPhraseReplacementsRepresents a collection of ISpeechPhraseElement objects.
ISpeechPhraseRuleContains information about a speech phrase rule.
ISpeechPhraseRulesRepresents a collection of ISpeechPhraseRule objects.
ISpeechRecognizerStatusReturns the status of the speech recognition engine represented by the recognizer object.
ISpeechRecoGrammarEnables applications to manage the words and phrases for the SR engine.
ISpeechRecoResultReturns information about the recognition engine's hypotheses, recognitions, and false recognitions.
ISpeechRecoResultDispatchCannot be QI'd for but allows IDispatch access to both ISpeechRecoResult and ISpeechXMLRecoResult.
ISpeechRecoResultTimesContains the time information for speech recognition results.
ISpeechVoiceStatusContains status information about an SpVoice object.
ISpeechXMLRecoResultIs used to acquire the semantic results of speech recognition and return them as an SML document.
SpAudioFormatDefines an audio format.
SpCustomStreamSupports supports the use of existing IStream objects in SAPI.
SpFileStreamProvides the ability to open files as audio streams and save audio streams as files.
SpInProcRecoContextDefines a recognition context, or a collection of settings, that requests a specific type of recognition as determined by the needs of an application.
SpInProcRecoContext (Events)Defines the types of events that a recognition context can receive.
SpInProcRecognizerRepresents a speech recognition engine.
SpLexiconProvides access to lexicons, which contain information about words that can be recognized or spoken.
SpMemoryStreamSupports audio stream operations in memory.
SpMMAudioInRepresents the audio implementation for the standard Windows wave-in multimedia layer.
SpMMAudioOutRepresents the audio implementation for the standard Windows wave-out multimedia layer.
SpObjectTokenSupports object token entries.
SpObjectTokenCategoryRepresents a class of object tokens.
SpPhoneConverterSupports conversion from the SAPI character phoneset to the Id phoneset.
SpPhraseInfoBuilderProvides the ability to rebuild phrase information from audio data saved to memory.
SpSharedRecoContextDefines a recognition context, or a collection of settings, that requests a specific type of recognition as determined by the needs of an application.
SpSharedRecoContext (Events)Defines the types of events that a recognition context can receive.
SpSharedRecognizerRepresents a speech recognition engine.
SpTextSelectionInformationProvides access to the text selection information pertaining to a word sequence buffer.
SpUnCompressedLexiconProvides access to lexicons, which contain information about words that can be recognized or spoken.
SpVoiceEnables an application to perform text synthesis operations.
SpVoice (Events)defines the types of events that can be received by an SpVoice object.
SpWaveFormatExDefines the format of waveform-audio data.