The WaveFormat structure defines the format of waveform-audio data.
Only format information common to all waveform-audio data formats is included in this structure.
For formats that require additional information, this structure is included as the first member in another structure, along with the additional information.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class WaveFormat
Public Class WaveFormat
public ref class WaveFormat
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | WaveFormat()()()() |
Creates a new PCM format with the default values (8 kHz, 16 bit, mono)
|
| WaveFormat(Int32, Int32, Int32) |
Creates a new PCM format with the specified sample rate, bits per sample and channels
|
 | AverageBytesPerSec |
Gets or sets the required average data-transfer rate, in bytes per second, for the format tag. (nAvgBytesPerSec)
|
| BitsPerSample |
Gets or sets the bits per sample for the WaveFormatTag format type. (wBitsPerSample)
If WaveFormatTag is PCM, then this should be equal to 8 or 16.
For non-PCM formats, this member must be set according to the manufacturer's specification of the format tag.
If WaveFormatTag is EXTENSIBLE, this value can be any integer multiple of 8 and represents the container size, not necessarily the sample size;
for example, a 20-bit sample size is in a 24-bit container. Some compression schemes cannot define a value for BitsPerSample, so this member can be 0.
|
| BlockAlign |
Gets or sets Block alignment, in bytes. (nBlockAlign)
|
| CbSize |
Gets or sets the size of extra format information appended to the end of the WAVEFORMATEX structure in bytes. (cbSize)
This information can be used by non-PCM formats to store extra attributes for the WaveFormatTag.
If no extra information is required by the WaveFormatTag, this member must be set to 0.
For PCM formats, this member is ignored. When this structure is included in a WAVEFORMATEXTENSIBLE structure, this value must be at least 22.
|
| Channels |
Gets or sets the number of channels in the waveform-audio data. (Mono = 1, Stereo = 2). (nChannels)
|
| Equals(Object) |
Compares with another WaveFormat object
(Overrides Object.Equals(Object).) |
| GetHashCode()()()() |
Provides a Hashcode for this WaveFormat
(Overrides Object.GetHashCode()()()().) |
| SampleRate |
Gets or sets the sample rate, in samples per second (hertz). (nSamplesPerSec)
|
| ToString()()()() |
Returns a string that represents the current object.
(Overrides Object.ToString()()()().) |
| WaveFormatTag |
Gets or sets the Waveform-audio format type. (wFormatTag)
|
Remarks Inheritance Hierarchy| Object | ||
 | WaveFormat | |
| WaveFormatExtensible | |
Assembly: VoIPSDK (Module: VoIPSDK.dll) Version: 11.2.4.290