SpeechSynthesizer::SpeakAsync Method (String^)

.NET Framework (current version)

Asynchronously speaks the contents of a string.

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

Syntax

public:
Prompt^ SpeakAsync(
	String^ textToSpeak
)

Parameters

textToSpeak: Type: System::String^
The text to speak.

Return Value

Type: System.Speech.Synthesis::Prompt^

Returns the object that contains the content to speak.

To asynchronously speak a string that contains SSML markup, use the SpeakSsmlAsync method. To synchronously speak the contents of a string, use the Speak method. You can cancel the asynchronous speaking of a prompt with the SpeakAsyncCancel or the SpeakAsyncCancelAll method.

Examples

As shown in the following example, the SpeakAsync method provides the simplest means to generate speech output asynchronously.

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();

      // Speak a string asynchronously.
      synth.SpeakAsync("What is your favorite color?");

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

Version Information

.NET Framework
Available since 3.0