SpeechSynthesizerOptions.AudioVolume 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 loudness of the speech synthesis utterance.

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

double AudioVolume();

void AudioVolume(double value);

public double AudioVolume { get; set; }

var double = speechSynthesizerOptions.audioVolume;
speechSynthesizerOptions.audioVolume = double;

Public Property AudioVolume As Double

Property Value

Double

double

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

This value can range from 0.0 (lowest volume) to 1.0 (highest volume), inclusive. The default value is 1.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, AudioVolume is combined with 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