ISpVoice::Speak (SAPI 5.3)

  • Article

Microsoft Speech API 5.3

ISpVoice::Speak

ISpVoice::Speak speaks the contents of a text string or file.

  
    HRESULT Speak(
   LPCWSTR       *pwcs,
   DWORD          dwFlags,
   ULONG         *pulStreamNumber
);

Parameters

  • pwcs
    [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.
  • dwFlags
    [in] Flags used to control the rendering process for this call. The flag values are contained in the SPEAKFLAGS enumeration.
  • pulStreamNumber
    [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.

Return values

Value
S_OK
E_INVALIDARG
E_POINTER
E_OUTOFMEMORY
SPERR_INVALID_FLAGS
SPERR_DEVICE_BUSY

Remarks

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.