Buffer3D.MinDistance Property (Microsoft.DirectX.DirectSound)

  • Article

Retrieves or sets the minimum distance, from the listener, at which sounds in this buffer begin to be attenuated.

Definition

Visual Basic Public Property MinDistance As Single
C# public float MinDistance { get; set; }
C++ public:
property float MinDistance {
        float get();
        void set(float value);
}
JScript public function get MinDistance() : float
public function set MinDistance(float);

Property Value

System.Single
Minimum distance in meters to set or retrieve.

This property is read/write. 

Remarks

The default minimum distance, DSoundHelper.DefaultMinDistance, is defined as 1.0 (corresponding to 1.0 meter at the default distance factor of 1.0 meters per unit).

The default unit of measurement is meters, but this can be changed by using the Listener3D.DistanceFactor property.

Exceptions

ArgumentExceptionLeave Site

An invalid parameter was passed to the called method.

See Also