NAudio.Wave.AcmMp3FrameDecompressor Class Reference

MP3 Frame Decompressor using ACM. More...

Inheritance diagram for NAudio.Wave.AcmMp3FrameDecompressor:

Collaboration diagram for NAudio.Wave.AcmMp3FrameDecompressor:

Public Member Functions
	AcmMp3FrameDecompressor (WaveFormat sourceFormat)
	Creates a new ACM frame decompressor.
int	DecompressFrame (Mp3Frame frame, byte[] dest, int destOffset)
	Decompresses the provided Mp3Frame and copies the decompressed data to the destination array starting at the specified offset.
void	Reset ()
	Resets the position of the conversion stream to the beginning.
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Properties
WaveFormat	OutputFormat [get]
	Output format (PCM)
Properties inherited from NAudio.Wave.IMp3FrameDecompressor

Private Member Functions
	~AcmMp3FrameDecompressor ()
	Finalizer ensuring that resources get released properly.

Private Attributes
readonly AcmStream	conversionStream
readonly WaveFormat	pcmFormat
bool	disposed

Detailed Description

MP3 Frame Decompressor using ACM.

Constructor & Destructor Documentation

AcmMp3FrameDecompressor()

NAudio.Wave.AcmMp3FrameDecompressor.AcmMp3FrameDecompressor ( WaveFormat sourceFormat )

inline

Creates a new ACM frame decompressor.

Parameters

sourceFormat

The MP3 source format

Here is the call graph for this function:

~AcmMp3FrameDecompressor()

NAudio.Wave.AcmMp3FrameDecompressor.~AcmMp3FrameDecompressor ( )

inlineprivate

Finalizer ensuring that resources get released properly.

Here is the call graph for this function:

Member Function Documentation

DecompressFrame()

int NAudio.Wave.AcmMp3FrameDecompressor.DecompressFrame ( Mp3Frame frame, byte[] dest, int destOffset )

inline

Decompresses the provided Mp3Frame and copies the decompressed data to the destination array starting at the specified offset.

Parameters

frame	The Mp3Frame to be decompressed.
dest	The destination array where the decompressed data will be copied.
destOffset	The offset in the destination array where the decompressed data will be copied.

Exceptions

ArgumentNullException	Thrown when the provided Mp3Frame is null.
InvalidOperationException	Thrown when the whole MP3 frame cannot be converted.

Returns

The number of bytes copied to the destination array.

This method decompresses the provided Mp3Frame and copies the decompressed data to the destination array starting at the specified offset. It also handles exceptions if the provided Mp3Frame is null or if the whole MP3 frame cannot be converted.

Implements NAudio.Wave.IMp3FrameDecompressor.

Here is the call graph for this function:

Dispose()

void NAudio.Wave.AcmMp3FrameDecompressor.Dispose ( )

inline

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This method checks if the object has been disposed and disposes the conversionStream if it is not null. It then suppresses the finalization of the object by the garbage collector.

Here is the call graph for this function:

Here is the caller graph for this function:

Reset()

void NAudio.Wave.AcmMp3FrameDecompressor.Reset ( )

inline

Resets the position of the conversion stream to the beginning.

Implements NAudio.Wave.IMp3FrameDecompressor.

Here is the call graph for this function:

Member Data Documentation

conversionStream

readonly AcmStream NAudio.Wave.AcmMp3FrameDecompressor.conversionStream

private

disposed

bool NAudio.Wave.AcmMp3FrameDecompressor.disposed

private

pcmFormat

readonly WaveFormat NAudio.Wave.AcmMp3FrameDecompressor.pcmFormat

private

Property Documentation

OutputFormat

WaveFormat NAudio.Wave.AcmMp3FrameDecompressor.OutputFormat

get

Output format (PCM)

Implements NAudio.Wave.IMp3FrameDecompressor.

---

The documentation for this class was generated from the following file:

• /Users/sumansaurabh/Documents/my-startup/xeno-rat/Plugins/LiveMicrophone/lib/NAudio.WinMM/Mp3FrameDecompressor.cs