SpeechSynthesizer.SpeakAsync Method (PromptBuilder)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Asynchronously speaks the contents of a PromptBuilder object.

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

public Prompt SpeakAsync(
	PromptBuilder promptBuilder
)

Parameters

promptBuilder
Type: System.Speech.Synthesis.PromptBuilder

The content to speak.

Return Value

Type: System.Speech.Synthesis.Prompt

Returns the object that contains the content to speak.

To synchronously speak the contents of a PromptBuilder object, use Speak.

The following example creates a PromptBuilder object from a string and passes the object as an argument to the SpeakAsync method.

using System;
using System.Speech.Synthesis;

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

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

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

      // Create a PromptBuilder object and append a text string.
      PromptBuilder song = new PromptBuilder();
      song.AppendText("Say the name of the song you want to hear");

      // Speak the contents of the prompt asynchronously.
      synth.SpeakAsync(song);

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


.NET Framework
Available since 3.0
Return to top
Show: