AppendTextWithAlias Method

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Appends text to the PromptBuilder object and specifies the alias text to be spoken in place of the appended text.

Namespace:  Microsoft.Speech.Synthesis
Assembly:  Microsoft.Speech (in Microsoft.Speech.dll)

Syntax

Visual Basic (Declaration)
Public Sub AppendTextWithAlias ( _
	textToSpeak As String, _
	substitute As String _
)
Visual Basic (Usage)
Dim instance As PromptBuilder
Dim textToSpeak As String
Dim substitute As String

instance.AppendTextWithAlias(textToSpeak, _
	substitute)
C#
public void AppendTextWithAlias(
	string textToSpeak,
	string substitute
)

Parameters

textToSpeak
Type: System..::..String

A string containing the text representation.

substitute
Type: System..::..String

A string containing the text to be spoken.

Remarks

This allows a document to contain both a spoken and a written form for a prompt. For example, the written form could be an acronym, such as SAPI, and the spoken form could be the expanded text for the acronym, in this case Speech Application Programming Interface.

Examples

The following example appends a text string ("Speech Synthesis Markup Language") and its alias ("SSML") to a PromptBuilder object. The synthesizer will pronounce "S S M L".

 Copy imageCopy Code
PromptBuilder alias = new PromptBuilder();
alias.AppendTextWithAlias("Speech Synthesis Markup Language","SSML"); 

See Also