NAudio.Wave.DmoEffectWaveProvider< TDmoEffector, TEffectorParam > Class Template Reference

Provide WaveProvider that can apply effects in real time using DMO. More...

Inheritance diagram for NAudio.Wave.DmoEffectWaveProvider< TDmoEffector, TEffectorParam >:

Collaboration diagram for NAudio.Wave.DmoEffectWaveProvider< TDmoEffector, TEffectorParam >:

Public Member Functions
	DmoEffectWaveProvider (IWaveProvider inputProvider)
	Create a new DmoEffectWaveProvider.
int	Read (byte[] buffer, int offset, int count)
	Reads data from the input buffer and processes it using the specified effector, if available.
void	Dispose ()
	Disposes the resources used by the effector.

Properties
WaveFormat	WaveFormat [get]
	Stream Wave Format.
TEffectorParam	EffectParams [get]
	Get Effector Parameters.
Properties inherited from NAudio.Wave.IWaveProvider

Private Attributes
readonly IWaveProvider	inputProvider
readonly IDmoEffector< TEffectorParam >	effector

Detailed Description

Provide WaveProvider that can apply effects in real time using DMO.

If the audio thread is running on the STA thread, please generate and operate from the same thread. If the audio thread is running on the MTA thread, please operate on any MTA thread.

Template Parameters

TDmoEffector	Types of DMO effectors to use
TEffectorParam	Parameters of the effect to be used

Type Constraints

TDmoEffector	:	IDmoEffector<TEffectorParam>
TDmoEffector	:	new()

Constructor & Destructor Documentation

DmoEffectWaveProvider()

NAudio.Wave.DmoEffectWaveProvider< TDmoEffector, TEffectorParam >.DmoEffectWaveProvider ( IWaveProvider inputProvider )

inline

Create a new DmoEffectWaveProvider.

Parameters

inputProvider

Input Stream

Member Function Documentation

Dispose()

void NAudio.Wave.DmoEffectWaveProvider< TDmoEffector, TEffectorParam >.Dispose ( )

inline

Disposes the resources used by the effector.

This method releases the streaming resources used by the effector's media object and disposes the effector itself.

Here is the call graph for this function:

Read()

int NAudio.Wave.DmoEffectWaveProvider< TDmoEffector, TEffectorParam >.Read ( byte[] buffer, int offset, int count )

inline

Reads data from the input buffer and processes it using the specified effector, if available.

Parameters

buffer	The input buffer to read data from.
offset	The zero-based byte offset in buffer at which to begin reading.
count	The maximum number of bytes to read.

Returns

The total number of bytes read into the buffer.

This method reads data from the input buffer using the input provider and processes it using the specified effector, if available. If no effector is provided, the method simply reads the data and returns the total number of bytes read. If an effector is provided, the method processes the read data and returns the total number of bytes read after processing.

Implements NAudio.Wave.IWaveProvider.

Here is the call graph for this function:

Member Data Documentation

effector

readonly IDmoEffector<TEffectorParam> NAudio.Wave.DmoEffectWaveProvider< TDmoEffector, TEffectorParam >.effector

private

inputProvider

readonly IWaveProvider NAudio.Wave.DmoEffectWaveProvider< TDmoEffector, TEffectorParam >.inputProvider

private

Property Documentation

EffectParams

TEffectorParam NAudio.Wave.DmoEffectWaveProvider< TDmoEffector, TEffectorParam >.EffectParams

get

Get Effector Parameters.

WaveFormat

WaveFormat NAudio.Wave.DmoEffectWaveProvider< TDmoEffector, TEffectorParam >.WaveFormat

get

Stream Wave Format.

Implements NAudio.Wave.IWaveProvider.

---

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

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