NAudio.Wave.AdpcmWaveFormat Class Reference

Microsoft ADPCM See http://icculus.org/SDL_sound/downloads/external_documentation/wavecomp.htm. More...

Inheritance diagram for NAudio.Wave.AdpcmWaveFormat:

Collaboration diagram for NAudio.Wave.AdpcmWaveFormat:

Public Member Functions
	AdpcmWaveFormat (int sampleRate, int channels)
	Microsoft ADPCM
override void	Serialize (System.IO.BinaryWriter writer)
	Serializes the object to a binary writer.
override string	ToString ()
	Returns a formatted string representing the Microsoft ADPCM format with specific details.
Public Member Functions inherited from NAudio.Wave.WaveFormat
	WaveFormat ()
	Creates a new PCM 44.1Khz stereo 16 bit format.
	WaveFormat (int sampleRate, int channels)
	Creates a new 16 bit wave format with the specified sample rate and channel count.
int	ConvertLatencyToByteSize (int milliseconds)
	Converts the given latency in milliseconds to the corresponding byte size based on the average bytes per second.
	WaveFormat (int rate, int bits, int channels)
	Creates a new PCM format with the specified sample rate, bit depth and channels.
	WaveFormat (BinaryReader br)
	Reads a new WaveFormat object from a stream.
override string	ToString ()
	Returns a string representation of the WaveFormat object.
override bool	Equals (object obj)
	Determines whether the current WaveFormat object is equal to another object.
override int	GetHashCode ()
	Computes the hash code for the WaveFormat instance.
virtual void	Serialize (BinaryWriter writer)
	Serializes the wave format data and writes it to the specified BinaryWriter.

Properties
int	SamplesPerBlock [get]
	Samples per block.
int	NumCoefficients [get]
	Number of coefficients.
short[]	Coefficients [get]
	Coefficients.
Properties inherited from NAudio.Wave.WaveFormat
WaveFormatEncoding	Encoding [get]
	Returns the encoding type used.
int	Channels [get]
	Returns the number of channels (1=mono,2=stereo etc)
int	SampleRate [get]
	Returns the sample rate (samples per second)
int	AverageBytesPerSecond [get]
	Returns the average number of bytes used per second.
virtual int	BlockAlign [get]
	Returns the block alignment.
int	BitsPerSample [get]
	Returns the number of bits per sample (usually 16 or 32, sometimes 24 or 8) Can be 0 for some codecs.
int	ExtraSize [get]
	Returns the number of extra bytes used by this waveformat. Often 0, except for compressed formats which store extra data after the WAVEFORMATEX header.

Private Member Functions
	AdpcmWaveFormat ()
	Empty constructor needed for marshalling from a pointer.

Private Attributes
short	samplesPerBlock
short	numCoeff
short[]	coefficients

Additional Inherited Members
Static Public Member Functions inherited from NAudio.Wave.WaveFormat
static WaveFormat	CreateCustomFormat (WaveFormatEncoding tag, int sampleRate, int channels, int averageBytesPerSecond, int blockAlign, int bitsPerSample)
	Creates a custom WaveFormat with the specified parameters.
static WaveFormat	CreateALawFormat (int sampleRate, int channels)
	Creates a new WaveFormat with A-Law encoding.
static WaveFormat	CreateMuLawFormat (int sampleRate, int channels)
	Creates a new WaveFormat with MuLaw encoding.
static WaveFormat	CreateIeeeFloatWaveFormat (int sampleRate, int channels)
	Creates a new IEEE float wave format with the specified sample rate and number of channels.
static WaveFormat	MarshalFromPtr (IntPtr pointer)
	Marshals a WaveFormat structure from the specified pointer.
static IntPtr	MarshalToPtr (WaveFormat format)
	Marshals the WaveFormat structure to a pointer.
static WaveFormat	FromFormatChunk (BinaryReader br, int formatChunkLength)
	Reads the wave format and extra data from the specified binary reader and returns the WaveFormatExtraData.
Protected Attributes inherited from NAudio.Wave.WaveFormat
WaveFormatEncoding	waveFormatTag
	format type
short	channels
	number of channels
int	sampleRate
	sample rate
int	averageBytesPerSecond
	for buffer estimation
short	blockAlign
	block size of data
short	bitsPerSample
	number of bits per sample of mono data
short	extraSize
	number of following bytes

Detailed Description

Microsoft ADPCM See http://icculus.org/SDL_sound/downloads/external_documentation/wavecomp.htm.

Constructor & Destructor Documentation

AdpcmWaveFormat() [1/2]

NAudio.Wave.AdpcmWaveFormat.AdpcmWaveFormat ( )

inlineprivate

Empty constructor needed for marshalling from a pointer.

AdpcmWaveFormat() [2/2]

NAudio.Wave.AdpcmWaveFormat.AdpcmWaveFormat ( int sampleRate, int channels )

inline

Microsoft ADPCM

Parameters

sampleRate	Sample Rate
channels	Channels

Member Function Documentation

Serialize()

override void NAudio.Wave.AdpcmWaveFormat.Serialize ( System::IO::BinaryWriter writer )

inline

Serializes the object to a binary writer.

Parameters

writer

The binary writer to which the object is serialized.

Exceptions

System.IO.IOException

An I/O error occurs.

This method serializes the object to the specified binary writer by writing the samples per block, number of coefficients, and the coefficients themselves.

ToString()

override string NAudio.Wave.AdpcmWaveFormat.ToString ( )

inline

Returns a formatted string representing the Microsoft ADPCM format with specific details.

Returns

A string containing the Microsoft ADPCM format details including sample rate, channels, bits per sample, and samples per block.

Member Data Documentation

coefficients

short [] NAudio.Wave.AdpcmWaveFormat.coefficients

private

numCoeff

short NAudio.Wave.AdpcmWaveFormat.numCoeff

private

samplesPerBlock

short NAudio.Wave.AdpcmWaveFormat.samplesPerBlock

private

Property Documentation

Coefficients

short [] NAudio.Wave.AdpcmWaveFormat.Coefficients

get

Coefficients.

NumCoefficients

int NAudio.Wave.AdpcmWaveFormat.NumCoefficients

get

Number of coefficients.

SamplesPerBlock

int NAudio.Wave.AdpcmWaveFormat.SamplesPerBlock

get

Samples per block.

---

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

• /Users/sumansaurabh/Documents/my-startup/xeno-rat/Plugins/LiveMicrophone/lib/NAudio.Core/Wave/WaveFormats/AdpcmWaveFormat.cs