Class WaveStream

Namespace

NAudio.Wave

Assembly

NAudio.Core.dll

Base class for all WaveStream classes. Derives from stream.

public abstract class WaveStream : Stream, IAsyncDisposable, IDisposable, IWaveProvider

Inheritance

object

MarshalByRefObject

Stream

WaveStream

Implements

IAsyncDisposable

IDisposable

IWaveProvider

Derived

LoopStream

ExtendedAudioFileServicesReader

SoundFileReader

AiffFileReader

AudioFileReader

BlockAlignReductionStream

MediaFoundationReader

Mp3FileReaderBase

RawSourceWaveStream

ResamplerDmoStream

Wave32To16Stream

WaveChannel32

WaveFileReader

WaveFormatConversionStream

WaveMixerStream32

WaveOffsetStream

Inherited Members

Stream.Null

Stream.BeginRead(byte[], int, int, AsyncCallback, object)

Stream.BeginWrite(byte[], int, int, AsyncCallback, object)

Stream.Close()

Stream.CopyTo(Stream)

Stream.CopyTo(Stream, int)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, int, CancellationToken)

Stream.CopyToAsync(Stream, CancellationToken)

Stream.CreateWaitHandle()

Stream.Dispose()

Stream.Dispose(bool)

Stream.DisposeAsync()

Stream.EndRead(IAsyncResult)

Stream.EndWrite(IAsyncResult)

Stream.FlushAsync()

Stream.FlushAsync(CancellationToken)

Stream.ObjectInvariant()

Stream.Read(byte[], int, int)

Stream.Read(Span<byte>)

Stream.ReadAsync(byte[], int, int)

Stream.ReadAsync(byte[], int, int, CancellationToken)

Stream.ReadAsync(Memory<byte>, CancellationToken)

Stream.ReadAtLeast(Span<byte>, int, bool)

Stream.ReadAtLeastAsync(Memory<byte>, int, bool, CancellationToken)

Stream.ReadByte()

Stream.ReadExactly(byte[], int, int)

Stream.ReadExactly(Span<byte>)

Stream.ReadExactlyAsync(byte[], int, int, CancellationToken)

Stream.ReadExactlyAsync(Memory<byte>, CancellationToken)

Stream.Synchronized(Stream)

Stream.ValidateBufferArguments(byte[], int, int)

Stream.ValidateCopyToArguments(Stream, int)

Stream.Write(ReadOnlySpan<byte>)

Stream.WriteAsync(byte[], int, int)

Stream.WriteAsync(byte[], int, int, CancellationToken)

Stream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken)

Stream.WriteByte(byte)

Stream.CanTimeout

Stream.Length

Stream.Position

Stream.ReadTimeout

Stream.WriteTimeout

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

WaveExtensionMethods.ToSampleProvider(IWaveProvider)

Remarks

Implementing a WaveStream — which Read method should I override?

Read(byte[], int, int) is abstract on Stream and must be overridden. Read(Span<byte>) is virtual — its default implementation rents a buffer from Shared, calls the byte[] overload, and copies into the span. This is functionally correct but incurs one pool rent and one extra copy per read.

For best performance, implement your read logic in the Read(Span<byte>) overload and make the byte[] overload forward to it:

public override int Read(Span<byte> buffer) { /* real read logic */ }
public override int Read(byte[] array, int offset, int count)
    => Read(array.AsSpan(offset, count));

All of NAudio's built-in readers follow this pattern. Legacy subclasses that only override the byte[] overload continue to work correctly, but pay the pooled-bridge cost on span-based reads.

Properties

BlockAlign

The block alignment for this wavestream. Do not modify the Position to anything that is not a whole multiple of this value

public virtual int BlockAlign { get; }

Property Value

int

CanRead

We can read from this stream

public override bool CanRead { get; }

Property Value

bool

CanSeek

We can seek within this stream

public override bool CanSeek { get; }

Property Value

bool

CanWrite

We can't write to this stream

public override bool CanWrite { get; }

Property Value

bool

CurrentTime

The current position in the stream in Time format. On set, the resulting byte position is rounded down to a multiple of BlockAlign so the stream stays on a valid block boundary.

public virtual TimeSpan CurrentTime { get; set; }

Property Value

TimeSpan

TotalTime

Total length in real-time of the stream (may be an estimate for compressed files)

public virtual TimeSpan TotalTime { get; }

Property Value

TimeSpan

WaveFormat

Retrieves the WaveFormat for this stream

public abstract WaveFormat WaveFormat { get; }

Property Value

WaveFormat

Methods

Flush()

Flush does not need to do anything See Flush()

public override void Flush()

HasData(int)

Whether the WaveStream has non-zero sample data at the current position for the specified count

public virtual bool HasData(int count)

Parameters

count int

Number of bytes to read

Returns

bool

Seek(long, SeekOrigin)

An alternative way of repositioning. See Seek(long, SeekOrigin)

public override long Seek(long offset, SeekOrigin origin)

Parameters

offset long

origin SeekOrigin

Returns

long

SetLength(long)

Sets the length of the WaveStream. Not Supported.

public override void SetLength(long length)

Parameters

length long

Skip(int)

Moves forward or backwards the specified number of seconds in the stream

public void Skip(int seconds)

Parameters

seconds int

Number of seconds to move, can be negative

Write(byte[], int, int)

Writes to the WaveStream. Not Supported.

public override void Write(byte[] buffer, int offset, int count)

Parameters

buffer byte[]

offset int

count int