Share via


FragmentState Struct

Definition

Provides detailed information about a TextFragment.

public value class FragmentState : IEquatable<System::Speech::Synthesis::TtsEngine::FragmentState>
public struct FragmentState : IEquatable<System.Speech.Synthesis.TtsEngine.FragmentState>
type FragmentState = struct
Public Structure FragmentState
Implements IEquatable(Of FragmentState)
Inheritance
FragmentState
Implements

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.

Constructors

FragmentState(TtsEngineAction, Int32, Int32, Int32, SayAs, Prosody, Char[])

Constructs a new instance of FragmentState.

Properties

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

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.

GetHashCode()

Returns the hash code for this instance.

Operators

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.

Applies to