WaveDataReader Class

Represents wave data coming from a stream.

Inheritance Hierarchy

SystemObject
GSF.MediaWaveDataReader

Namespace: GSF.Media
Assembly: GSF.Media (in GSF.Media.dll) Version: 2.4.232-beta

Syntax

C++

JavaScript

Copy

public class WaveDataReader : IDisposable

Public Class WaveDataReader
	Implements IDisposable

public ref class WaveDataReader : IDisposable

type WaveDataReader = 
    class
        interface IDisposable
    end

GSF.Media.WaveDataReader = function();

Type.createClass(
	'GSF.Media.WaveDataReader',
	null,
	IDisposable);

View Source

The WaveDataReader type exposes the following members.

Constructors

	Name	Description
	WaveDataReader(Stream)	Creates a new instance of the WaveDataReader class.
	WaveDataReader(WaveFormatChunk, Stream)	Creates a new instance of the WaveDataReader class.

Top

Properties

	Name	Description
	Format	Gets the format of the wave data.
	WaveStream	Gets the underlying stream providing wave data.

Top

Methods

	Name	Description
	Close	Closes the underlying stream.
	Dispose	Releases all the resources used by the WaveDataReader object.
	Dispose(Boolean)	Releases the unmanaged resources used by the WaveDataReader object and optionally releases the managed resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	FromFile	Creates a WaveDataReader instance created from a WAV file.
	FromStream	Creates a WaveDataReader instance created from a WAV stream.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetNextSample	Reads and returns the next sample from the stream.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

This class is meant to be used when loading the entirety of a wave file into memory is not a viable option. With it, samples can be read directly from the data stream in the order that they appear.

Reference

GSF.Media Namespace