|
Wave
|
Represents a waveform audio format file (WAV).
Inheritance Hierarchy
Namespace: GSF.Media
Assembly: GSF.Media (in GSF.Media.dll) Version: 2.4.181-beta
SyntaxThe WaveFile type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WaveFile | Creates a new empty in-memory wave file using standard CD quality settings. |
| WaveFile(Int32, Int16, Int16) | Creates a new empty in-memory wave file in Pulse Code Modulation (PCM) audio format. |
| WaveFile(SampleRate, BitsPerSample, DataChannels) | Creates a new empty in-memory wave file in Pulse Code Modulation (PCM) audio format. |
| WaveFile(Int32, Int16, Int16, UInt16) | Creates a new empty in-memory wave file in specified audio format. |
| WaveFile(RiffHeaderChunk, WaveFormatChunk, WaveDataChunk, ListInfoChunk) | Creates a new empty in-memory wave file using existing constituent chunks. |
| WaveFile(SampleRate, BitsPerSample, DataChannels, WaveFormat) | Creates a new empty in-memory wave file in specified audio format. |
Properties| Name | Description | |
|---|---|---|
 | AmplitudeScalar | Returns the amplitude scalar for the given bits per sample of the WaveFile (i.e., maximum value for given BitsPerSample). |
| AudioFormat | Gets or sets audio format used by the WaveFile. |
| AudioLength | Gets calculated audio length. |
| BitsPerSample | Gets or sets number of bits-per-sample in the WaveFile. |
| BlockAlignment | Gets or sets the block size of a complete sample of data (i.e., samples for all channels of data at one instant in time). |
| ByteRate | Gets or sets the byte rate used for buffer estimation. |
| Channels | Gets or sets number of audio channels in the WaveFile. |
| DataChunk | Gets or sets the WaveDataChunk of this WaveFile. |
| ExtraParameters | Gets or sets any extra parameters defined in the format header of the WaveFile. |
| ExtraParametersSize | Gets the size of the ExtraParameters buffer, if defined. |
| FormatChunk | Gets or sets the WaveFormatChunk of this WaveFile. |
| HeaderChunk | Gets or sets the RiffHeaderChunk of this WaveFile. |
| InfoChunk | Gets the ListInfoChunk of this WaveFile. |
| InfoStrings | Gets list of info strings available in this WaveFile if any were available during load; otherwise an empty dictionary. |
| SampleBlocks | Accesses each individual block of sample data indexed by time. |
| SampleRate | Gets or sets the sample rate (i.e., the number of samples per second) defined in the WaveFile. |
Methods| Name | Description | |
|---|---|---|
| AddSample | Add the sample to the wave file. |
| AddSampleBlock | Adds a block of samples in native format to the wave file (e.g., if BitsPerSample = 16, parameters need to be Int16 values). Note that LittleBinaryValue parameter type is implicitly castable to common native types, including floating points. |
| AddSamples | Adds a series of samples, one per channel, to the wave file. |
 | Append | Appends wave files together, one after another, into a single file. |
| CastSample | Casts sample value to its equivalent native type based on defined BitsPerSample and AudioFormat. |
| Clone | Creates a deeply cloned copy of the WaveFile. |
| CloneSampleBlock | Performs a deep clone of all the channel samples in a sample block. |
| Combine(WaveFile) | Combines wave files together, all starting at the same time, into a single file. This has the effect of playing two sound tracks simultaneously. |
| Combine(WaveFile, Double) | Combines wave files together, all starting at the same time, into a single file. This has the effect of playing two sound tracks simultaneously. |
| 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) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetSampleTypeCode | Determines sample data type code based on defined BitsPerSample and AudioFormat. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Load(Stream, Boolean) | Creates a new in-memory wave loaded from an existing wave audio stream. |
| Load(String, Boolean) | Creates a new in-memory wave loaded from an existing wave file. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Play | Plays the wave file using SoundPlayer. |
| Reverse | Reverses the data samples in the wave file. |
| Save(Stream) | Saves wave file to the specified stream. |
| Save(String) | Saves wave file to the specified file name. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
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) |
See Also