SpeechSynthesizerOptions.AudioPitch Property

Reference

Definition

Namespace:: Windows.Media.SpeechSynthesis

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

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

public:
 property double AudioPitch { double get(); void set(double value); };

double AudioPitch();

void AudioPitch(double value);

public double AudioPitch { get; set; }

var double = speechSynthesizerOptions.audioPitch;
speechSynthesizerOptions.audioPitch = double;

Public Property AudioPitch As Double

Property Value

Double

double

The tone of the selected speech synthesis engine (voice).

This value can range from 0.0 (lowest pitch) to 2.0 (highest pitch), inclusive. The default value is 1.0.

Some voices have a minimum speaking pitch higher than 0.0 and a maximum speaking pitch lower than 2.0.

Windows requirements

Device family	Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v5.0)

Remarks

If Speech Synthesis Markup Language (SSML) is used, AudioPitch is combined with any prosody tags in the markup.

Note

Prosody are properties of syllables and larger units of speech, not individual phonetic segments (vowels and consonants).

Applies to