Struct WaveFormat 

pub struct WaveFormat {
    pub wave_fmt: WAVEFORMATEXTENSIBLE,
}

Struct wrapping a WAVEFORMATEXTENSIBLE format descriptor.

Fields

wave_fmt: WAVEFORMATEXTENSIBLE

Implementations

impl WaveFormat

pub fn parse(waveformatex: &WAVEFORMATEX) -> Result<Self, WasapiError>

Parse a WAVEFORMATEX structure and return a WaveFormat instance. If the underlying structure is a WAVEFORMATEXTENSIBLE, as specified by wFormatTag, then use as-is. If not, assume it is only a WAVEFORMATEX structure.

pub fn new( storebits: usize, validbits: usize, sample_type: &SampleType, samplerate: usize, channels: usize, channel_mask: Option<u32>, ) -> Self

Build a WAVEFORMATEXTENSIBLE struct for the given parameters. channel_mask is optional. If a mask is provided, it will be used. If not, a default mask will be created. This can be used to work around quirks for some device drivers. If the default is not accepted, try again using a zero mask, Some(0).

pub fn from_waveformatex(wavefmt: WAVEFORMATEX) -> Result<Self, WasapiError>

Create from a WAVEFORMATEX structure

pub fn to_waveformatex(&self) -> Result<Self, WasapiError>

Return a copy in the simpler WAVEFORMATEX format.

pub fn as_waveformatex_ref(&self) -> &WAVEFORMATEX

get a reference of type &WAVEFORMATEX, used internally

pub fn get_blockalign(&self) -> u32

Read nBlockAlign.

pub fn get_avgbytespersec(&self) -> u32

Read nAvgBytesPerSec.

pub fn get_bitspersample(&self) -> u16

Read wBitsPerSample.

pub fn get_validbitspersample(&self) -> u16

Read wValidBitsPerSample.

pub fn get_samplespersec(&self) -> u32

Read nSamplesPerSec.

pub fn get_nchannels(&self) -> u16

Read nChannels.

pub fn get_dwchannelmask(&self) -> u32

Read dwChannelMask.

pub fn get_subformat(&self) -> Result<SampleType, WasapiError>

Read SubFormat.

Trait Implementations

impl Clone for WaveFormat

fn clone(&self) -> WaveFormat

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WaveFormat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<WAVEFORMATEXTENSIBLE> for WaveFormat

fn from(wave_fmt: WAVEFORMATEXTENSIBLE) -> Self

Converts to this type from the input type.