MPfm: Music Player for Musicians - Developer Documentation - 0.6.0.0
PeakFile Class
NamespacesMPfm.SoundPeakFile
The PeakFile class can generate peak files asynchronously using multiple threads with Reactive Extensions. It is also cancellable. Use the ProcessData event to get the progress.
Declaration Syntax
C#Visual Basic
public class PeakFile
Public Class PeakFile
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
PeakFile(Int32)
Default constructor for the PeakFile class.

Cancel()()()()
Cancels the peak file generation.

CheckDirectorySize(String)
Returns the total size of all files within a directory. Non-recursive.

DeletePeakFiles(String)
Deletes all the peak files in a directory.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FilePaths
Dictionary defining the audio (key) and peak (value) file paths to process. Can be updated in real-time (insert new items at the end of the list!).

Finalize()()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GeneratePeakFile(String, String)
Generates a peak file.

GeneratePeakFileAsync(String, String, Int32)
Generates a peak file for an audio file. This method returns an IObservable object for use with Reactive Extensions. Note: BASS.NET should be initialized already before calling this method. This uses a decode stream.

GeneratePeakFiles(Dictionary<(Of <<'(String, String>)>>))
Generates a list of peak files

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
IsProcessing
Indicates if the class is currently generating peak files.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
NumberOfThreads
Defines the number of threads used for peak file generation.

NumberOfThreadsRunning
Indicates the number of threads currently running.

OnProcessData
Event called every 20 blocks when generating a peak file.

OnProcessDone
Event called when all the GeneratePeakFiles threads have completed their work.

OnProcessStarted
Event called when a thread starts its work.

ProgressReportBlockInterval
Defines when the OnProgressData event is called; it will be called every x blocks (where x is ProgressReportBlockInterval). The default value is 20.

ReadPeakFile(String)
Reads a peak file and returns a min/max peak list.

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Inheritance Hierarchy
Object
PeakFile

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