PolyTone.CurrentVolume Property

Gets or sets the volume for the entire sequence of tones in a PolyTone instance. CurrentVolume does not change the volume of tones set to Tone.VOLUME.OFF, maintaining the integrity of Tones intended to be played as pauses.

Syntax

[C#]
public VOLUME CurrentVolume { get; set; }

Property Values

Tone.VOLUME.OFF
Tone.VOLUME.LOW
Tone.VOLUME.NORMAL
Tone.VOLUME.LOUD
Tone.VOLUME.VERY_LOUD
Tone.VOLUME.MUTE
Tone.VOLUME.UNMUTE
Tone.VOLUME.CURRENT_CFG_VOL

For more information on these values, see Range Constants in the Tone Class documentation.

Notes

The entire sequence can temporarily be silenced by setting the CurrentVolume to Tone.VOLUME.MUTE, and can be restored to its former volume with Tone.VOLUME.UNMUTE.

For complex sequences that contain tones with varying volumes, only use the values Tone.VOLUME.MUTE and Tone.VOLUME.UNMUTE when setting CurrentVolume. This maintains the sequence's original volume variances.

More Information

PolyTone Class