Microsoft Speech SDK

Interface: ISpeechRecoContext

RetainedAudio Property

The RetainedAudio property gets and sets the audio retention status of the recognition context.

By default, a recognition context does not retain audio and is initially set to SRAONone. Calls attempting to access non-existent audio result in an SPERR_NO_AUDIO_DATA error. The calls ISpeechRecoResult.Audio and ISpeechRecoResult.SpeakAudio result in this error. The error can also occur when setting an SpAudioFormat instance.

To retain the audio, set this property to SRAORetainAudio.

Syntax

Parts

SpeechRecoContext

The owning object.

SpeechRetainedAudioOptions

Set: A SpeechRetainedAudioOptions constant that sets the property.
Get: A SpeechRetainedAudioOptions constant that gets the property.

Example

The following Visual Basic form code demonstrates the use of the ISpeechRecoContext.RetainedAudio. The application displays the text of the recognition along with the actual spoken part.

To run this code, create a form with the following control:

Paste this code into the Declarations section of the form.

Public WithEvents RC As SpSharedRecoContext
Public myGrammar As ISpeechRecoGrammar

Private Sub Form_Load()
    Set RC = New SpSharedRecoContext
    RC.RetainedAudio = SRAORetainAudio
    Set myGrammar = RC.CreateGrammar
    
    myGrammar.DictationSetState SGDSActive
End Sub

Private Sub RC_Recognition(ByVal StreamNumber As Long, ByVal StreamPosition As Variant, ByVal RecognitionType As SpeechLib.SpeechRecognitionType, ByVal Result As SpeechLib.ISpeechRecoResult)
    Label1.Caption = Result.PhraseInfo.GetText
    Result.SpeakAudio
End Sub