Buffer.Pan Property (Microsoft.DirectX.DirectSound)

  • Article

Retrieves or sets the relative volume of the left and right audio channels.

Definition

Visual Basic Public Property Pan As Integer
C# public int Pan { get; set; }
C++ public:
property int Pan {
        int get();
        void set(int value);
}
JScript public function get Pan() : int
public function set Pan(int);

Property Value

System.Int32
Value that represents the relative volume between the left and right channels, to set or retrieve.

This property is read/write. 

Remarks

The value set or retrieved is measured in hundredths of a decibel (dB), in the range of Pan.Left to Pan.Right. These values are defined as -10,000 and 10,000 respectively. The value Pan.Left means the right channel is effectively silent. The value Pan.Right means the left channel is effectively silent. The neutral value is Pan.Center, defined as 0, which means that both channels are at full volume. When one channel is attenuated, the other remains at full volume.

The pan control acts cumulatively with the volume control.

Exceptions

ArgumentExceptionLeave 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