MPfm: Music Player for Musicians - Developer Documentation - 0.6.0.0
CheckForDistortion Method (waveDataLeft, waveDataRight, convertNegativeToPositive, distortionThreshold)
NamespacesMPfm.SoundAudioToolsCheckForDistortion(array<Single>[]()[][], array<Single>[]()[][], Boolean, Single)
Takes a block of wave data from both channels and detects if the volume level reaches or goes past the distortion threshold passed in parameter. The distortion threshold is measured in decibels (ex: 0.0f for 0dB)
Declaration Syntax
C#Visual Basic
public static bool CheckForDistortion(
	float[] waveDataLeft,
	float[] waveDataRight,
	bool convertNegativeToPositive,
	float distortionThreshold
)
Public Shared Function CheckForDistortion ( _
	waveDataLeft As Single(), _
	waveDataRight As Single(), _
	convertNegativeToPositive As Boolean, _
	distortionThreshold As Single _
) As Boolean
Parameters
waveDataLeft (array<Single>[]()[][])
Raw wave data (left channel)
waveDataRight (array<Single>[]()[][])
Raw wave data (right channel)
convertNegativeToPositive (Boolean)
Convert negative values to positive values (ex: true when used for output meters, false when used with wave form display controls (since the negative value is used to draw the bottom end of the waveform).
distortionThreshold (Single)
If the volume level reaches or goes past this threshold, the method retuns true.
Return Value

[Missing <returns> documentation for "M:MPfm.Sound.AudioTools.CheckForDistortion(System.Single[],System.Single[],System.Boolean,System.Single)"]

Assembly: MPfm.Sound (Module: MPfm.Sound) Version: 0.5.3.0 (0.5.3.0)