Enum DataFormat 

pub enum DataFormat {
    Data32Channel32,
    Data24Channel24,
    Data16Channel16,
    Data8Channel8,
}

Supported I2S data formats.

Each format defines the on-wire slot width (Data{X}) and the in-memory sample width (Channel{Y}). On the ESP32-S2, each slot on the wire matches the sample data width in memory (X == Y).

• Data{X} (on-wire slot width): The number of bit-clock (BCLK) cycles allocated to each channel slot on the physical line (Self::data_bits).
• Channel{Y} (in-memory sample width): The number of audio data bits per sample transferred to or from memory via DMA (Self::channel_bits).

In the DMA memory buffer, samples occupy:

• 32-bit (Data32Channel32): 4 bytes per sample.
• 24-bit (Data24Channel24): 3 bytes per sample.
• 16-bit (Data16Channel16): 2 bytes per sample.
• 8-bit (Data8Channel8): 1 byte per sample.

Variants

Data32Channel32

32-bit on-wire slot width (32 BCLK cycles) and 32-bit in-memory sample width (4 bytes per sample).

Data24Channel24

24-bit on-wire slot width (24 BCLK cycles) and 24-bit in-memory sample width (3 bytes packed per sample).

Data16Channel16

16-bit on-wire slot width (16 BCLK cycles) and 16-bit in-memory sample width (2 bytes per sample).

Data8Channel8

8-bit on-wire slot width (8 BCLK cycles) and 8-bit in-memory sample width (1 byte per sample).

Implementations

impl DataFormat

pub fn data_bits(&self) -> u8

Returns the on-wire slot width in bits (number of BCLK cycles per channel slot).

pub fn channel_bits(&self) -> u8

Returns the in-memory sample width in bits (active audio data bits per sample transferred via DMA).

Trait Implementations

impl Clone for DataFormat

Available on crate feature unstable only.

fn clone(&self) -> DataFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DataFormat

Available on crate feature unstable only.

impl Debug for DataFormat

Available on crate feature unstable only.

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

Formats the value using the given formatter.

impl Eq for DataFormat

Available on crate feature unstable only.

impl Hash for DataFormat

Available on crate feature unstable only.

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, Self: Sized,

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

impl PartialEq for DataFormat

Available on crate feature unstable only.

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DataFormat

Available on crate feature unstable only.