Microsoft DirectX 9.0 SDK Update (October 2004)

Buffer.Volume Property

Language:

Note: This documentation is preliminary and is subject to change.

Retrieves or sets the attenuation of the sound.

Definition

Visual Basic .NET Public Property Volume As Integer
C# public int Volume { get; set; }
Managed C++ public: __property int get_Volume();
public: __property void set_Volume(int);
JScript .NET public function get Volume() : int
public function set Volume(int);

Property Value

System.Int32 . Value that represents the attenuation, in hundredths of a decibel (dB).

This property is read/write. 

Remarks

The return value is between Volume.Min and Volume.Max. These values are defined as 0 and -10,000, respectively. The value Volume.Max represents the original, unadjusted volume of the sound. The value Volume.Min indicates an audio volume attenuated by 100 dB, which, for practical purposes, is silence.

Exceptions
ArgumentException Leave Site An invalid parameter was passed to the called method.
ControlUnavailableException The buffer control (volume, pan, and so on) requested by the caller is not available. Controls must be specified when the buffer is created.
PriorityLevelNeededException A cooperative level of Priority or higher is required.

Applies To

SecondaryBuffer

© 2004 Microsoft Corporation. All rights reserved. Terms of use.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center