Class ChannelMixerSampleProvider

Namespace

NAudio.Wave.SampleProviders

Assembly

NAudio.Core.dll

Produces an output stream by mixing together the channels of a single source using an arbitrary mixing matrix, where the number of output channels is determined by the number of columns in the matrix.

public class ChannelMixerSampleProvider : ISampleProvider

Inheritance

object

ChannelMixerSampleProvider

Implements

ISampleProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

WaveExtensionMethods.FollowedBy(ISampleProvider, TimeSpan, ISampleProvider)

WaveExtensionMethods.Skip(ISampleProvider, TimeSpan)

WaveExtensionMethods.Take(ISampleProvider, TimeSpan)

WaveExtensionMethods.ToMono(ISampleProvider, float, float)

WaveExtensionMethods.ToStereo(ISampleProvider, float, float)

WaveExtensionMethods.ToWaveProvider(ISampleProvider)

WaveExtensionMethods.ToWaveProvider16(ISampleProvider)

Remarks

See ChannelMixMatrix for some pre-defined matrices.

Constructors

ChannelMixerSampleProvider(ISampleProvider, float[,])

Initializes a new instance of the ChannelMixerSampleProvider class. The number of output channels from the mixer depends on the structure of the provided matrix.

public ChannelMixerSampleProvider(ISampleProvider source, float[,] matrix)

Parameters

source ISampleProvider

The provider to read from.

matrix float[,]

Specifies the matrix that converts input samples to output samples. The number of rows in the matrix must match the number of input channels from source. The number of columns in the matrix determines the number of output channels.

Exceptions

ArgumentNullException

Occurs if any argument is null.

ArgumentException

Occurs if the matrix has no output columns, or if the number of rows in the matrix does not match the number of channels in source.

Properties

WaveFormat

Gets the WaveFormat of the output from the mixer. The encoding is always IeeeFloat. The number of channels present in the WaveFormat depends on the channel mixing matrix in use.

public WaveFormat WaveFormat { get; }

Property Value

WaveFormat

Methods

Read(Span<float>)

Reads samples from the mixer into the provided buffer.

public int Read(Span<float> buffer)

Parameters

buffer Span<float>

A buffer to which to write output samples.

Returns

int

The total number of samples that were obtained.