ISpRecoContext::SetVoice
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method sets the voice associated with the speech recognition context.
Syntax
HRESULT SetVoice(
ISpVoice* pVoice,
BOOL fAllowFormatChanges
);
Parameters
- pVoice
[in] Pointer to an object implementing ISpVoice to associate with the speech recognition context. If this value is NULL, the currently associated voice is released.
- fAllowFormatChanges
[in] Value specifying if the engine allows the voice format alteration. Set this value to TRUE if the alteration is allowed, and to FALSE otherwise. See Remarks section.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
E_POINTER |
pVoice is invalid or bad. |
FAILED(hr) |
Appropriate error message. |
Remarks
If fAllowFormatChanges is TRUE, then the Voice's output format will be the same format as the associated SR engine's audio input format (see ISpRecognizer and ISpSREngine::GetInputAudioFormat). Using the same audio format for input and output source is useful for sound cards that do not support full-duplex audio (such as input format must match output format). If the input format quality is lower than the output format quality, the output format quality will be down-sampled to the lower quality.
After calling ISpRecoContext::SetVoice, an application that calls ISpRecoContext::GetVoice will retrieve the originally "set" ISpVoice interface pointer.
Example
The following code snippet illustrates the use of this method and "barge-in" setup.
HRESULT hr = S_OK;
// create a shared recognition context
hr = cpRecoContext.CoCreateInstance(CLSID_SpSharedRecoContext);
// Check hr
// create a voice
hr = cpVoice.CoCreateInstance(CLSID_SpVoice);
// Check hr
// associate the voice with the context (with same audio format as context)
hr = cpRecoContext->SetVoice(cpVoice, TRUE);
// Check hr
// tell the associated Voice to stop speaking when the SR Engine hears a
recognizable sound
hr = cpRecoContext->SetVoicePurgeEvent(SPFEI(SPEI_SOUND_START));
// Check hr
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |