Struct wav::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 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(af: u16, cc: u16, r: u32, bps: u16) -> Header

Creates a new Header object.

Parameters

• af - Audio format. 1 for uncompressed PCM data.
• cc - Channel count, the number of channels each sample has. Generally 1 (mono) or 2 (stereo).
• r - Sampling rate (e.g. 44.1kHz, 48kHz, 96kHz, etc.).
• bps - Number of bits in each (sub-channel) sample. Generally 8, 16, or 24.

Example

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

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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]> for Header

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

Converts a slice of raw bytes into a Header object.

Panics

This function will panic if the given slice is smaller than 16 bytes.

Parameters

• v - The slice to convert from.

impl From<[u8; 16]> for Header

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

Converts an array of 16 raw bytes into a Header object. Intended for use with bytes read in from wave files.

Parameters

• v - The raw bytes to convert from.

impl Hash for Header

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Into<[u8; 16]> for Header

fn into(self) -> [u8; 16]

Converts the Header object into a vector of its bytes.

Example

let h:[u8;16] = wav::Header::new(1, 2, 48_000, 16).into();

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