Struct esp_idf_hal::i2s::config::Config

pub struct Config { /* private fields */ }

I2S common channel configuration.

To create a custom configuration, use the builder pattern built-in to this struct. For example:

use esp_idf_hal::i2s::config::{ChannelOpen, Config, Role};
let config = Config::default().role(Role::Target).channels(ChannelOpen::Rx);

The default configuration is:

• role: Role::Controller (master)
• dma_buffer_count: 6 (DEFAULT_DMA_BUFFER_COUNT)
• frames_per_buffer: 240 (DEFAULT_FRAMES_PER_DMA_BUFFER)
• auto_clear: false

Implementations

impl Config

pub const fn new() -> Self

Create a new Config with the default settings.

pub fn role(self, role: Role) -> Self

Set the role of this channel: controller (master) or target (slave).

pub fn dma_buffer_count(self, dma_buffer_count: u32) -> Self

Set the number of DMA buffers to use.

pub fn frames_per_buffer(self, frames: u32) -> Self

Set the number of I2S frames in one DMA buffer.

pub fn auto_clear(self, auto_clear: bool) -> Self

Set if the transmit buffer will be automatically cleared upon sending.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Config

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Config

impl Eq for Config

impl StructuralPartialEq for Config