DSP_SoftSaturation Class

[SerializableAttribute]
public sealed class DSP_SoftSaturation : BaseDSP

<SerializableAttribute>
Public NotInheritable Class DSP_SoftSaturation
	Inherits BaseDSP

The DSP_SoftSaturation type exposes the following members.

	Name	Description
	DSP_SoftSaturation	Creates a new instance of the Soft Saturation DSP, not assigning the DSP yet.
	DSP_SoftSaturation(Int32, Int32)	Creates a new instance of the Soft Saturation DSP, which already assigns the DSP (Start will be called automatically).

	Name	Description
	ChannelBitwidth	This property returns the actual bitwidth of the sample data of the channel (e.g. 8, 16, 32). (Inherited from BaseDSP.)
	ChannelHandle	Gets or Sets the channel that the DSP is being applied to. (Inherited from BaseDSP.)
	ChannelInfo	Gets the BASS_CHANNELINFO of the assigned ChannelHandle. (Inherited from BaseDSP.)
	ChannelNumChans	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.)
	ChannelSampleRate	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.)
	Depth	Gets or Sets the Depth between 0.0 and 1.0 (default is 0.5, 0.0=off).
	DitherFactor	Gets or Sets the dithering bitdepth of the triangular probability density function (TPDF) - default is 0.7.
	DSPHandle	Returns the actual DSP handle (or 0, if the DSP has not been assigned to the channel). (Inherited from BaseDSP.)
	DSPPriority	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.)
	DSPProc	Returns the actual DSPPROC (callback delegate) which is used by the DSP. (Inherited from BaseDSP.)
	Factor	Gets or Sets the Soft Saturation factor between 0.0 and 0.99998848714 (default is 0.5).
	Factor_dBV	Gets or Sets the Soft Saturation factor in dBV between NegativeInfinity and -0.0001 (default is -6 dB).
	IsAssigned	Is the DSP assigned to an active channel? (=assigned, =not assigned). (Inherited from BaseDSP.)
	IsBypassed	Returns if the DSP is currently bypassed (=bypass). (Inherited from BaseDSP.)
	UseDithering	Gets or Sets, if Dithering should be used (default is ).
	User	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.)

	Name	Description
	Dispose	Implement IDisposable. (Inherited from BaseDSP.)
	DSPCallback	User defined DSP callback function which does the soft saturation wave sharping. Not for direct use in your application! (Overrides BaseDSPDSPCallback(Int32, Int32, IntPtr, Int32, IntPtr).)
	Finalize	Finalization code. (Inherited from BaseDSP.)
	OnBypassChanged	This method will be called every time the SetBypass(Boolean) method had been called. (Inherited from BaseDSP.)
	OnChannelChanged	This method will be called every time the ChannelHandle changed. (Inherited from BaseDSP.)
	OnStarted	This method will be called every time the Start method had been called. (Inherited from BaseDSP.)
	OnStopped	This method will be called every time the Stop method had been called. (Inherited from BaseDSP.)
	RaiseNotification	Fires the Notification event. (Inherited from BaseDSP.)
	SetBypass	Sets the Bypass mode. (Inherited from BaseDSP.)
	Start	Assigns the DSP to the channel (actually starts using the DSP). (Inherited from BaseDSP.)
	Stop	Stops (removes) the DSP from the channel. (Inherited from BaseDSP.)
	ToString	Returns the name of the DSP. (Overrides BaseDSPToString.)

	Name	Description
	Notification	Event handler used to notify that the DSP has processed some data. (Inherited from BaseDSP.)

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!

Reference