VXPLib Documentation: COM

IVXPQuickHTML::GetSpeechText

Returns a text string to be processed by a TTS (Text-To-Speech) engine. The returned text can be formated in a way to comply with any Speech SDK.


HRESULT GetSpeechText(VXPSpeechFormat format, VARIANT_BOOL bIncludeComments, VARIANT_BOOL bIncludeText, BSTR * Text);


Parameters

format [in, defaultvalue(sfNone)] - Format for all sound tags in the document. See Remarks.
bIncludeComments [in, defaultvalue(TRUE)] - Include all comment blocks as regular text
bIncludeText [in, defaultvalue(TRUE)] - Include text visible in the document
Text [out, retval] - Returned text
Remarks

This function allows to extract text from the current QHTML document, and apply a formatting to it compliant with any Text-To-Speech platform.
The way to format text is defined using type VXPSpeechFormat:
  • sfNone - All sound tags are to be skipped
  • sfDefault - Sound tags returned exactly the way they were declared
  • sfMicrosoftTTS - Sound tags returned surrounded by two backslash symbols \\sound_tag\\ to comply with the Microsoft syntax for text-to-speech control tags
  • sfXML - Sound tags returned surrounded by two angle brackets to comply with XML presentation of fine speech formatting
This formatting is applicable only to contents of QHTML within speech tags <&...>
See Also

IVXPQuickHTML | Tag <&...> | Speech Example


This document was last updated on 03/02/2003