PromptBuilder.AppendSsml Method

Definition

Namespace:

System.Speech.Synthesis

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0-rc.2.24473.5

Appends an SSML file to a PromptBuilder object.

Overloads

AppendSsml(String)	Appends the SSML file at the specified path to the PromptBuilder object.
AppendSsml(Uri)	Appends the SSML file at the specified URI to the PromptBuilder object.
AppendSsml(XmlReader)	Appends an XMLReader object that references an SSML prompt to the PromptBuilder object.

AppendSsml(String)

Appends the SSML file at the specified path to the PromptBuilder object.

public:
 void AppendSsml(System::String ^ path);

public void AppendSsml (string path);

member this.AppendSsml : string -> unit

Public Sub AppendSsml (path As String)

Parameters

path

String

A fully qualified path to the SSML file to append.

Examples

The example that follows creates a PromptBuilder object and appends the contents of an SSML file using the AppendSsml method.

using System;  
using System.Speech.Synthesis;  

namespace SampleSynthesis  
{  
  class Program  
  {  
    static void Main(string[] args)  
    {  

      // Initialize a new instance of the SpeechSynthesizer.  
      using (SpeechSynthesizer synth = new SpeechSynthesizer())  
      {  

        // Configure the audio output.   
        synth.SetOutputToDefaultAudioDevice();  

        // Create a PromptBuilder object and append a file that defines an SSML prompt.  
        PromptBuilder ssmlFile = new PromptBuilder();  
        ssmlFile.AppendSsml("c:\\test\\Weather.ssml");  

        // Speak the contents of the SSML prompt.  
        synth.Speak(ssmlFile);  
      }  

      Console.WriteLine();  
      Console.WriteLine("Press any key to exit...");  
      Console.ReadKey();  
    }  
  }  
}  

The following is the SSML file that the preceding example references.

<?xml version="1.0" encoding="ISO-8859-1"?>  
<speak version="1.0"  
 xmlns="http://www.w3.org/2001/10/synthesis"  
 xml:lang="en-US">  

  <s> The weather forecast for today is partly cloudy with some sun breaks. </s>  

</speak>  

Remarks

The SSML file must be an XML-format file that conforms to the Speech Synthesis Markup Language (SSML) Version 1.0 specification.

You can also append SSML markup as a string using AppendSsmlMarkup.

AppendSsml(Uri)

Appends the SSML file at the specified URI to the PromptBuilder object.

public:
 void AppendSsml(Uri ^ ssmlFile);

public void AppendSsml (Uri ssmlFile);

member this.AppendSsml : Uri -> unit

Public Sub AppendSsml (ssmlFile As Uri)

Parameters

ssmlFile

Uri

A fully qualified URI to the SSML file to append.

Examples

The example that follows creates a PromptBuilder object and appends the contents of an SSML file using the AppendSsml method.

using System;  
using System.Speech.Synthesis;  

namespace SampleSynthesis  
{  
  class Program  
  {  
    static void Main(string[] args)  
    {  

      // Initialize a new instance of the SpeechSynthesizer.  
      using (SpeechSynthesizer synth = new SpeechSynthesizer())  
      {  

        // Configure the audio output.   
        synth.SetOutputToDefaultAudioDevice();  

        // Create a PromptBuilder object and append a file that defines an SSML prompt.  
        PromptBuilder ssmlFile = new PromptBuilder();  
        ssmlFile.AppendSsml(new Uri("c:\\test\\Weather.ssml"));  

        // Speak the contents of the SSML prompt.  
        synth.Speak(ssmlFile);  
      }  

      Console.WriteLine();  
      Console.WriteLine("Press any key to exit...");  
      Console.ReadKey();  
    }  
  }  
}  

The following is the SSML file that the preceding example references.

<?xml version="1.0" encoding="ISO-8859-1"?>  
<speak version="1.0"  
 xmlns="http://www.w3.org/2001/10/synthesis"  
 xml:lang="en-US">  

  <s> The weather forecast for today is partly cloudy with some sun breaks. </s>  

</speak>  

Remarks

The SSML file must be an XML-format file that conforms to the Speech Synthesis Markup Language (SSML) Version 1.0 specification.

You can also append SSML markup as a string using AppendSsmlMarkup.

AppendSsml(XmlReader)

Appends an XMLReader object that references an SSML prompt to the PromptBuilder object.

public:
 void AppendSsml(System::Xml::XmlReader ^ ssmlFile);

public void AppendSsml (System.Xml.XmlReader ssmlFile);

member this.AppendSsml : System.Xml.XmlReader -> unit

Public Sub AppendSsml (ssmlFile As XmlReader)

Parameters

ssmlFile

XmlReader

A fully qualified name to the XML file to append.

Examples

The following example creates a PromptBuilder object from an XmlReader object that references a file containing Speech Synthesis Markup Language (SSML) markup.

using System;  
using System.Xml;  
using System.IO;  
using System.Speech.Synthesis;  

namespace SampleSynthesis  
{  
  class Program  
  {  
    static void Main(string[] args)  
    {  

      // Initialize a new instance of the SpeechSynthesizer.  
      using (SpeechSynthesizer synth = new SpeechSynthesizer())  
      {  

        // Configure the audio output.   
        synth.SetOutputToWaveFile(@"C:\test\weather.wav");  

        // Create a SoundPlayer instance to play the output audio file.  
        System.Media.SoundPlayer m_SoundPlayer =  
          new System.Media.SoundPlayer(@"C:\test\weather.wav");  

        // Create the path to the SSML file.  
        string weatherFile = Path.GetFullPath("c:\\test\\Weather.xml");  
        PromptBuilder builder = null;  

        // Create an XML Reader from the file, create a PromptBuilder and   
        // append the XmlReader.  
        if (File.Exists(weatherFile))  
        {  
          XmlReader reader = XmlReader.Create(weatherFile);  
          builder = new PromptBuilder();  
          builder.AppendSsml(reader);  
          reader.Close();  
        }  

        // Speak the prompt and play back the output file.  
        synth.Speak(builder);  
        m_SoundPlayer.Play();  
      }  

      Console.WriteLine();  
      Console.WriteLine("Press any key to exit...");  
      Console.ReadKey();  
    }  
  }  
}  

Remarks

The SSML file must be an XML-format file that conforms to the Speech Synthesis Markup Language (SSML) Version 1.0 specification.

You can also append SSML markup as a string using AppendSsmlMarkup.