FragmentState Structure

.NET Framework (current version)

Provides detailed information about a TextFragment.

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

Syntax

public value struct FragmentState : IEquatable<FragmentState>

Constructors

	Name	Description
	FragmentState(TtsEngineAction, Int32, Int32, Int32, SayAs^, Prosody^, array<Char>^)	Constructs a new instance of FragmentState.

Properties

	Name	Description
	Action	Returns the requested speech synthesizer action.
	Duration	Returns the desired time for rendering a TextFragment
	Emphasis	Returns instructions on how to emphasize a TextFragment.
	LangId	Returns the language supported by the current FragmentState.
	Phoneme	Returns phonetic information for a TextFragment
	Prosody	Returns detailed information about the pitch, speaking rate, and volume of speech output.
	SayAs	Returns information about the context for the generation of speech from text..

Methods

	Name	Description
	Equals(FragmentState)	Determines if a given instance of FragmentState is equal to the current instance of FragmentState.
	Equals(Object^)	Determines if a given object is an instance FragmentState equal to the current instance of FragmentState.(Overrides ValueType::Equals(Object^).)
	GetHashCode()	Returns the hash code for this instance.(Overrides ValueType::GetHashCode().)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	ToString()	Returns the fully qualified type name of this instance.(Inherited from ValueType.)

Operators

	Name	Description
	Equality(FragmentState, FragmentState)	Determines if two instances of FragmentState describes the same TextFragment state.
	Inequality(FragmentState, FragmentState)	Determines if two instances of FragmentState describes the different TextFragment state.

Remarks

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.

Version Information

.NET Framework
Available since 3.0

Thread Safety

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