Struct wav::header::Header

pub struct Header {
    pub audio_format: u16,
    pub channel_count: u16,
    pub sampling_rate: u32,
    pub bytes_per_second: u32,
    pub bytes_per_sample: u16,
    pub bits_per_sample: u16,
}

Structure for the "fmt " chunk of wave files, specifying key information about the enclosed data.

This struct supports only PCM and IEEE float data, which is to say there is no extra members for compressed format data.

Fields

audio_format: u16

channel_count: u16

sampling_rate: u32

bytes_per_second: u32

bytes_per_sample: u16

bits_per_sample: u16

Implementations

impl Header

pub fn new(
    audio_format: u16,
    channel_count: u16,
    sampling_rate: u32,
    bits_per_sample: u16
) -> Header

Creates a new Header object.

Note

While the crate::read and crate::write functions only support uncompressed PCM/IEEE for the audio format, the option is given here to select any audio format for custom implementations of wave features.

Parameters

• audio_format - Audio format. Only WAV_FORMAT_PCM (0x01) and WAV_FORMAT_IEEE_FLOAT (0x03) are supported.
• channel_count - Channel count, the number of channels each sample has. Generally 1 (mono) or 2 (stereo).
• sampling_rate - Sampling rate (e.g. 44.1kHz, 48kHz, 96kHz, etc.).
• bits_per_sample - Number of bits in each (sub-channel) sample. Generally 8, 16, 24, or 32.

Example

let h = wav::Header::new(wav::header::WAV_FORMAT_PCM, 2, 48_000, 16);

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Header

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Header

Returns the “default value” for a type.

impl Eq for Header

impl From<[u8; 16]> for Header

fn from(v: [u8; 16]) -> Self

Performs the conversion.

impl Hash for Header

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Header> for Header

fn eq(&self, other: &Header) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Header) -> bool

This method tests for !=.

impl StructuralEq for Header

impl StructuralPartialEq for Header

impl TryFrom<&'_ [u8]> for Header

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(v: &[u8]) -> Result<Self, Self::Error>

Errors

This function will return an error if the given slice is smaller than 16 bytes.