Share via

SpeechSynthesizerOptions Class

  • Reference

Definition

Namespace:
Windows.Media.SpeechSynthesis
Edit

Provides access to various speech synthesizer options.

public ref class SpeechSynthesizerOptions sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class SpeechSynthesizerOptions final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class SpeechSynthesizerOptions
Public NotInheritable Class SpeechSynthesizerOptions
Inheritance
Object Platform::Object IInspectable SpeechSynthesizerOptions
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family
Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v4.0)

Remarks

Version history

Windows version SDK version Value added
1709 16299 AudioPitch
1709 16299 AudioVolume
1709 16299 SpeakingRate
1803 17134 AppendedSilence
1803 17134 PunctuationSilence

Properties

AppendedSilence

Gets or sets the amount of silence added to the end of the speech synthesis utterance (before another utterance begins).
AudioPitch

Gets or sets the tone (relative highness or lowness) of the speech synthesis utterance.
AudioVolume

Gets or sets the loudness of the speech synthesis utterance.
IncludeSentenceBoundaryMetadata

Gets or sets whether sentence boundary metadata is added to a SpeechSynthesisStream object.
IncludeWordBoundaryMetadata

Gets or sets whether word boundary metadata is added to a SpeechSynthesisStream object.
PunctuationSilence

Gets or sets the amount of silence added after punctuation in the speech synthesis utterance (before another utterance begins).
SpeakingRate

Gets or sets the tempo (including pauses and hesitations) of the speech synthesis utterance.

Applies to

See also