PhonemeReachedEventArgs Class

 
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.

Returns data from the PhonemeReached event.

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

System.Object
  System.EventArgs
    System.ComponentModel.AsyncCompletedEventArgs
      System.Speech.Synthesis.PromptEventArgs
        System.Speech.Synthesis.PhonemeReachedEventArgs

public class PhonemeReachedEventArgs : PromptEventArgs

NameDescription
System_CAPS_pubpropertyAudioPosition

Gets the audio position of the phoneme.

System_CAPS_pubpropertyCancelled

Gets a value indicating whether an asynchronous operation has been canceled.(Inherited from AsyncCompletedEventArgs.)

System_CAPS_pubpropertyDuration

Gets the duration of the phoneme.

System_CAPS_pubpropertyEmphasis

Gets the emphasis of the phoneme.

System_CAPS_pubpropertyError

Gets a value indicating which error occurred during an asynchronous operation.(Inherited from AsyncCompletedEventArgs.)

System_CAPS_pubpropertyNextPhoneme

Gets the phoneme following the phoneme associated with the PhonemeReached event.

System_CAPS_pubpropertyPhoneme

The phoneme associated with the PhonemeReached event.

System_CAPS_pubpropertyPrompt

Gets the prompt associated with the event.(Inherited from PromptEventArgs.)

System_CAPS_pubpropertyUserState

Gets the unique identifier for the asynchronous task.(Inherited from AsyncCompletedEventArgs.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodRaiseExceptionIfNecessary()

Raises a user-supplied exception if an asynchronous operation failed.(Inherited from AsyncCompletedEventArgs.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

A phoneme is a basic component of written language. For more information about phonemes, see PhonemeReached.

The following example is part of a Windows Forms application that writes the information returned by the PhonemeReached event to a text box. The phonemes are characters from the International Phonetic Alphabet (IPA).

System_CAPS_noteNote

The first and last characters returned by PhonemeReachedEventArgs are opening and closing characters that enclose but do not represent phonemes that constitute a word or phrase. This example returns five characters, but only the middle three characters are phonemes that represent the word "theme": one for the "th" sound, one for the "e" sound, and one for the "m" sound .

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Speech.Synthesis;

namespace PhonemeReached
{
  public partial class Form1 : Form
  {

    public Form1()
    {
      InitializeComponent();
      textBox1.Text = "";
    }

    public void button1_Click(object sender, EventArgs e)
    {
      // Initialize a new instance of the SpeechSynthesizer.
      SpeechSynthesizer synth = new SpeechSynthesizer();

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

      // Register for the PhonemeReached event.
      synth.PhonemeReached += new EventHandler<PhonemeReachedEventArgs>(synth_PhonemeReached);

      // Speak the contents of a string.
      synth.Speak("Theme");
    }

    // Write information about each phoneme as it is reached.
    private void synth_PhonemeReached(object sender, PhonemeReachedEventArgs e)
    {textBox1.AppendText(string.Format(

        "  Phoneme reached summary:" + Environment.NewLine +
        "    Phoneme:                 {0}" + Environment.NewLine +  
        "    Audio Position:         {1} mSec" + Environment.NewLine +
        "    Duration:                  {2} mSec" + Environment.NewLine +
        "    Emphasis:                {3}" + Environment.NewLine +
        "    Next Phoneme:         {4}" + Environment.NewLine + Environment.NewLine, 
        e.Phoneme,
        e.AudioPosition,
        e.Duration,
        e.Emphasis,
        e.NextPhoneme));
    }
  }
}

.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: