MPfm: Music Player for Musicians - Developer Documentation - 0.6.0.0
AudioTools Class
NamespacesMPfm.SoundAudioTools
This static class contains different methods for manipulating audio.
Declaration Syntax
C#Visual Basic
public static class AudioTools
Public NotInheritable Class AudioTools
Members
All MembersMethods



IconMemberDescription
CheckForDistortion(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)

ConvertRawWaveValueToDecibels(Single)
This method converts a raw wave value (range: -1 to 1) to actual decibels. Decibels are measured using an exponential scale. -100dB is total silence. -60dB is usually the noise floor. When the signal reaches or goes past 0.0dB it is considered distortioning. The decibel range returned is -100dB to 10dB.

EaseInExpo(Single, Single, Single, Single)
This method takes a set of parameters defining time, time variation, value and value target and "eases" in the output value following an exponential . This is the same "easing" used for example in jQuery animations. This method is useful when fed a min and max value from wave data and ease in the output value with time. This creates a "fallout" effect in output meters.

GetMaxdBPeakFromWaveDataMaxHistory(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType)
Returns the maximum peak (in decibels) of a list of min/max peaks. The values range from -1.0f to 1.0f.

GetMaxdBPeakFromWaveDataMaxHistoryWithInfo(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType)
Returns the maximum peak (in decibels) of a list of min/max peaks, including its position in the array. The values range from -1.0f to 1.0f.

GetMaxPeakFromWaveDataMaxHistory(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType)
Returns the maximum peak of a list of min/max peaks. The values range from -1.0f to 1.0f.

GetMaxPeakFromWaveDataMaxHistoryWithInfo(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType)
Returns the maximum peak of a list of min/max peaks, including its position in the array. The values range from -1.0f to 1.0f.

GetMindBPeakFromWaveDataMaxHistory(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType)
Returns the minimum peak (in decibels) of a list of min/max peaks. The values range from -1.0f to 1.0f.

GetMindBPeakFromWaveDataMaxHistory(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType, Int32)
Returns the minimum peak (in decibels) of a list of min/max peaks. The values range from -1.0f to 1.0f.

GetMindBPeakFromWaveDataMaxHistoryWithInfo(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType, Int32)
Returns the minimum peak (in decibels) of a list of min/max peaks, including its position in the array. The values range from -1.0f to 1.0f.

GetMinMaxFromWaveData(array<Single>[]()[][], array<Single>[]()[][], Boolean)
This method takes the left channel and right channel wave raw data and analyses it to get the maximum and minimum values in the float structure. It returns a data structure named WaveDataMinMax (see class description for more information). Negative values can be converted to positive values before min and max comparaison. Set this parameter to true for output meters and false for wave form display controls.

GetMinPeakFromWaveDataMaxHistory(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType)
Returns the minimum peak of a list of min/max peaks. The values range from -1.0f to 1.0f.

GetMinPeakFromWaveDataMaxHistory(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType, Int32)
Returns the minimum peak of a list of min/max peaks. The values range from -1.0f to 1.0f.

GetMinPeakFromWaveDataMaxHistoryWithInfo(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType, Int32)
Returns the minimum peak of a list of min/max peaks, including its position in the array. The values range from -1.0f to 1.0f.

GetVUMeterValue(List<(Of <<'(WaveDataMinMax>)>>), Int32, ChannelType)
This method takes a min/max wave data structure to analyse it and return a value that can be used in output/VU meters. It uses "easing" to create a "fallout" visual effect.

SearchAudioFilesRecursive(String, String)
Searches recursively for audio files in a folder. The file extensions must be specified using the extensions parameter. This method is recursive.

Inheritance Hierarchy
Object
AudioTools

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