This documentation is archived and is not being maintained.

ProsodyVolume Enumeration

Enumerates values for the Volume property of a Prosody object.

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

public enum ProsodyVolume

Member nameDescription
DefaultCurrent default volume value, same as the value returned by the Volume property on the ITtsEngineSite site supplied to that engine.
SilentVolume off
ExtraSoftApproximately 20% of maximum volume.
SoftApproximately 40% of maximum volume.
MediumApproximately 60% of maximum volume.
LoudApproximately 80% of maximum volume.
ExtraLoudMaximum volume.

Typically synthetic speech engine output volume as defined by the members of ProsodyVolume correspond to a percent of the maximum possible output loudness. For instance Loud corresponds to approximately 80% of the maximum volume. However, any specific synthetic speech engine implementations may choose how to render audio output for a given value of ProsodyVolume.

The current base volume setting for a custom synthetic speech engine is obtained as a ProsodyVolume value through the Volume property on the ITtsEngineSite site supplied to that engine. [T:System.Speech.Synthesis.TtsEngine.ProsodyVolume.]

Fine tuning and modulation of output volume is managed on the basis of particular TextFragment objects, using members of ProsodyVolume to set the Volume property on instances of Prosody used in creating or modifying the FragmentState object for the instance of TextFragment.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.