SpeechSynthesizer.State Property

Definition

Namespace:

System.Speech.Synthesis

Assembly:

System.Speech.dll

Package:

System.Speech v9.0.0-rc.2.24473.5

Source:

SpeechSynthesizer.cs

Gets the current speaking state of the SpeechSynthesizer object.

public:
 property System::Speech::Synthesis::SynthesizerState State { System::Speech::Synthesis::SynthesizerState get(); };

public System.Speech.Synthesis.SynthesizerState State { get; }

member this.State : System.Speech.Synthesis.SynthesizerState

Public ReadOnly Property State As SynthesizerState

Property Value

SynthesizerState

Returns the current speaking state of the SpeechSynthesizer object.

Examples

The following example illustrates the state of the SpeechSynthesizer before, during, and after speaking a prompt.

using System;
using System.Threading;
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();

      // Subscribe to the SpeakProgress event.
      synth.SpeakProgress += new EventHandler<SpeakProgressEventArgs>(synth_SpeakProgress);

      // Write the state of the SpeechSynthesizer to the console.
      Console.WriteLine("Current Synthesizer state: " + synth.State + "\n");

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

      // Write the state of the SpeechSynthesizer to the console while it is speaking.
      Thread.Sleep(1000);
      Console.WriteLine("\n - Current Synthesizer state: " + synth.State + " - \n");

      // Write the state of the SpeechSynthesizer to the console after it is done speaking.
      Thread.Sleep(2000);
      Console.WriteLine("\nCurrent Synthesizer state: " + synth.State);

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

    static void synth_SpeakProgress(object sender, SpeakProgressEventArgs e)
    {
      Console.WriteLine(e.Text);
    }
  }
}

Remarks

To get the new state of the SpeechSynthesizer after it changes, use the State property of the StateChangedEventArgs class.