ISpVoice::Speak (SAPI 5.4)
ISpVoice::Speak speaks the contents of a text string or file.
HRESULT Speak( LPCWSTR *pwcs, DWORD dwFlags, ULONG *pulStreamNumber );
- [in, string] Pointer to the null-terminated text string (possibly containing XML markup) to be synthesized. This value can be NULL when dwFlags is set to SPF_PURGEBEFORESPEAK indicating that any remaining data to be synthesized should be discarded. If dwFlags is set to SPF_IS_FILENAME, this value should point to a null-terminated, fully qualified path to a file.
- [in] Flags used to control the rendering process for this call. The flag values are contained in the SPEAKFLAGS enumeration.
- [out] Pointer to a ULONG which receives the current input stream number associated with this Speak request. Each time a string is spoken, an associated stream number is returned. Events queued back to the application related to this string will contain this number. If NULL, no value is passed back.
|S_OK||Function completed successfully.|
|E_INVALIDARG||One or more parameters are invalid.|
|E_OUTOFMEMORY||Exceeded available memory.|
|SPERR_INVALID_FLAGS||Invalid flags specified for this operation.|
|SPERR_DEVICE_BUSY||Timeout occurred on synchronous call.|
Normally, pulStreamNumber will just be 1. If, however, several asynchronous Speak (or SpeakStream) calls are received and must be queued, the stream number will be incremented for each call.
If Speak is called with markup parameters such as Emph, Spell, and Context, that cannot be empty, SAPI does not return an error code. For example, the following example returns S_OK.
hr = cpVoice->Speak(L"<EMPH;/>Do; it now", SPF_IS_XML, 0);