BASS.NET API for the Un4seen BASS Audio LibraryDSP_Pan ClassBASS.NET API for the Un4seen BASS Audio Library
Stereo Panning DSP (balance).
Inheritance Hierarchy


Namespace: Un4seen.Bass.Misc
Assembly: Bass.Net (in Bass.Net.dll) Version:

public sealed class DSP_Pan : BaseDSP

The DSP_Pan type exposes the following members.


Public methodDSP_Pan
Creates a new instance of the Panning DSP, not assigning the DSP yet.
Public methodDSP_Pan(Int32, Int32)
Creates a new instance of the Panning DSP, which already assigns the DSP (Start will be called automatically).

Public propertyChannelBitwidth
This property returns the actual bitwidth of the sample data of the channel (e.g. 8, 16, 32).
(Inherited from BaseDSP.)
Public propertyChannelHandle
Gets or Sets the channel that the DSP is being applied to.
(Inherited from BaseDSP.)
Public propertyChannelInfo
Gets the BASS_CHANNELINFO of the assigned ChannelHandle.
(Inherited from BaseDSP.)
Public propertyChannelNumChans
This property returns the actual number of channles of the sample data BASS is using with the channel (e.g. 1=mono, 2=stereo, etc.).
(Inherited from BaseDSP.)
Public propertyChannelSampleRate
This property returns the actual sample rate in Hz of the sample data BASS is using with the channel (e.g. 44100).
(Inherited from BaseDSP.)
Public propertyDitherFactor
Gets or Sets the dithering bitdepth of the triangular probability density function (TPDF) - default is 0.7.
Public propertyDSPHandle
Returns the actual DSP handle (or 0, if the DSP has not been assigned to the channel).
(Inherited from BaseDSP.)
Public propertyDSPPriority
Sets or reassigns the priority of the DSP, which determines it's position in the DSP chain - DSPs with higher priority are called before those with lower.
(Inherited from BaseDSP.)
Public propertyDSPProc
Returns the actual DSPPROC (callback delegate) which is used by the DSP.
(Inherited from BaseDSP.)
Public propertyIsAssigned
Is the DSP assigned to an active channel? (=assigned, =not assigned).
(Inherited from BaseDSP.)
Public propertyIsBypassed
Returns if the DSP is currently bypassed (=bypass).
(Inherited from BaseDSP.)
Public propertyPan
Defines the panning factor between -1.0 (pan left) and 1.0 (pan right), center is at 0.0 (default).
Public propertyUseDithering
Gets or Sets, if Dithering should be used (default is ).
Public propertyUser
Gets or Sets the value of the user instance data to pass to the callback function (see DSPCallback(Int32, Int32, IntPtr, Int32, IntPtr)).
(Inherited from BaseDSP.)

Public methodDispose
Implement IDisposable.
(Inherited from BaseDSP.)
Public methodDSPCallback
User defined DSP callback function which does the panning. Not for direct use in your application!
(Overrides BaseDSPDSPCallback(Int32, Int32, IntPtr, Int32, IntPtr).)
Protected methodFinalize
Finalization code.
(Inherited from BaseDSP.)
Public methodOnBypassChanged
This method will be called every time the SetBypass(Boolean) method had been called.
(Inherited from BaseDSP.)
Public methodOnChannelChanged
This method will be called every time the ChannelHandle changed.
(Inherited from BaseDSP.)
Public methodOnStarted
This method will be called every time the Start method had been called.
(Inherited from BaseDSP.)
Public methodOnStopped
This method will be called every time the Stop method had been called.
(Inherited from BaseDSP.)
Public methodRaiseNotification
Fires the Notification event.
(Inherited from BaseDSP.)
Public methodSetBypass
Sets the Bypass mode.
(Inherited from BaseDSP.)
Public methodStart
Assigns the DSP to the channel (actually starts using the DSP).
(Inherited from BaseDSP.)
Public methodStop
Stops (removes) the DSP from the channel.
(Inherited from BaseDSP.)
Public methodToString
Returns the name of the DSP.
(Overrides BaseDSPToString.)

Public eventNotification
Event handler used to notify that the DSP has processed some data.
(Inherited from BaseDSP.)

A stereo Panning DSP. Panning is controlled via the Pan property.

Note: This DSP only works on streams with a multiple of 2 channels (e.g. stereo, quadro, etc.).

The DSP automatically handles 8-, 16- or 32-bit sample data accordingly. 8- and 16-bit sample data will be clipped if needed, 32-bit floating-point values will not be clipped.

Use Start to assign the DSP to the channel. Use Stop to remove the DSP (you can (re)assign the DSP at any time again by calling Start). Changing the DSPPriority when the DSP is already assigned will automatically reassign the DSP.

Use the ChannelHandle property to change the channel assignment at any time. If the DSP has already been assigned, the DSP will immediately be reassigned to the new channel.

NOTE: This DSP does NOT support the Notification event!

See Also