Edit

PromptBuilder.AppendSsmlMarkup(String) Method

  • Reference

Definition

Namespace:
System.Speech.Synthesis
Assembly:
System.Speech.dll
Package:
System.Speech v8.0.0
Package:
System.Speech v9.0.0-preview.3.24172.9
Source:
PromptBuilder.cs
Source:
PromptBuilder.cs
Source:
PromptBuilder.cs

Appends the specified string containing SSML markup to the PromptBuilder object.

public:
 void AppendSsmlMarkup(System::String ^ ssmlMarkup);
public void AppendSsmlMarkup (string ssmlMarkup);
member this.AppendSsmlMarkup : string -> unit
Public Sub AppendSsmlMarkup (ssmlMarkup As String)

Parameters

ssmlMarkup
String

A string containing SSML markup.

Remarks

You must use the appropriate escape characters when appending SSML markup. Notice the backward-slashes preceding the quotation marks enclosing the value of the interpret-as attribute in the following example:

builder.AppendSsmlMarkup("<say-as interpret-as = \"characters\"> chair </say-as>");

Note

The string used as an argument to AppendSsmlMarkup cannot include a speak element.

When using AppendSsmlMarkup to specify inline pronunciations in a phoneme element, you can use phones from any of the following phonetic alphabets, provided that the current speech engine supports it:

  • International Phonetic Alphabet (IPA)

  • Universal Phone Set (UPS)

  • SAPI Phone Set

Any SSML-compliant speech engine will speak phones from the IPA.

You can also append a file containing SSML markup using one of the AppendSsml methods. To append text to be spoken that is not formatted with markup language, use one of the AppendText, AppendTextWithAlias, AppendTextWithHint, or AppendTextWithPronunciation methods.

Applies to