This documentation is archived and is not being maintained.

FragmentState Structure

Provides detailed information about a TextFragment.

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

public struct FragmentState : IEquatable<FragmentState>

The FragmentState type exposes the following members.

Public methodFragmentStateConstructs a new instance of FragmentState.

Public propertyActionReturns the requested speech synthesizer action.
Public propertyDurationReturns the desired time for rendering a TextFragment
Public propertyEmphasisReturns instructions on how to emphasize a TextFragment.
Public propertyLangIdReturns the language supported by the current FragmentState.
Public propertyPhonemeReturns phonetic information for a TextFragment
Public propertyProsodyReturns detailed information about the pitch, speaking rate, and volume of speech output.
Public propertySayAsReturns information about the context for the generation of speech from text..

Public methodEquals(FragmentState)Determines if a given instance of FragmentState is equal to the current instance of FragmentState.
Public methodEquals(Object)Determines if a given object is an instance FragmentState equal to the current instance of FragmentState. (Overrides ValueType.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Overrides ValueType.GetHashCode().)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)

Public operatorStatic memberEqualityDetermines if two instances of FragmentState describes the same TextFragment state.
Public operatorStatic memberInequalityDetermines if two instances of FragmentState describes the different TextFragment state.

FragmentState instances are obtained from the State on TextFragment objects.

The information in FragmentState is obtained by parsing the attributes decorating speech text in the Synthesize Speech Markup Language (SSML) used as an input to a synthesis engine.

A FragmentState object can exist for any synthesizer action request as specified by its Action property. However, the meaning of its members may change for different actions. For more information on synthesize actions, see TtsEngineAction for more information about specifying synthesizer actions.

  • Specification and control of the quality of the spoken output is largely handled through the Prosody, Emphasis, and Duration

  • Phonetic, language, and linguist structure information is available through LangId, Phoneme, and SayAs.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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