Pronunciation Property

Microsoft Speech Platform SDK 11

Collapse imageExpand ImageCopy imageCopyHover image

Gets the phonetic spelling of a recognized word.

Namespace:  Microsoft.Speech.Recognition
Assembly:  Microsoft.Speech (in Microsoft.Speech.dll)

Syntax

Visual Basic (Declaration)
Public ReadOnly Property Pronunciation As String
	Get
Visual Basic (Usage)
Dim instance As RecognizedWordUnit
Dim value As String

value = instance.Pronunciation
C#
public string Pronunciation { get; }

Property Value

Type: System..::..String

A string of characters from a supported phonetic alphabet, such as the International Phonetic Alphabet (IPA) or the Universal Phone Set (UPS).

Remarks

The contents of Pronunciation indicate which pronunciation the speech recognition engine used to match speech input to one of its loaded Grammar objects. Pronunciations may be defined in the speech recognition engine's internal lexicon, in a lexicon document that is linked from a recognition grammar in a loaded Grammar object, or inline in a recognition grammar in a loaded Grammar object. A speech recognition engine may also create pronunciations for uncommon words whose pronunciations are not defined in a lexicon or grammar to which the speech recognition engine currently has access.

Many Windows-based Unicode fonts, such as Courier New, support the display of IPA strings.

Examples

The following example shows a utility routine that generates a string with one of three possible formats: lexical (using LexicalForm), normalized (using Text), and phonetic (using Pronunciation). The text output is obtained from a ReadOnlyCollection of RecognizedWordUnit objects, which is obtained from the Words property on the RecognizedPhrase object.

C# Copy imageCopy Code
internal enum WordType 
{
  Text,
  Normalized = Text,
  Lexical,
  Pronunciation
}
C# Copy imageCopy Code
internal static string stringFromWordArray(
          ReadOnlyCollection<RecognizedWordUnit> words, 
          WordType type) 
{
  string text = "";
  foreach (RecognizedWordUnit word in words) 
  {
    string wordText = "";
    if (type == WordType.Text || type == WordType.Normalized) 
    {
      wordText = word.Text;
    } 
    else if (type == WordType.Lexical) 
    {
      wordText = word.LexicalForm;
    } 
    else if (type == WordType.Pronunciation) 
    {
      wordText = word.Pronunciation;
    } 
    else 
    {
      throw new InvalidEnumArgumentException(
          String.Format("[0}: is not a valid input", type));
    }
    // Use display attribute

    if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) 
    {
      wordText += " ";
    }
    if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) 
    {
      wordText += "  ";
    }
    if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) 
    {
      wordText = wordText.TrimStart();
    }
    if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) 
    {
      wordText = wordText.TrimEnd();
    }

    text += wordText;
  }
  return text;
}

See Also