Struct esp_idf_hal::i2s::config::TdmClkConfig

source ·
pub struct TdmClkConfig { /* private fields */ }
Expand description

TDM mode channel clock configuration.

Implementations§

source§

impl TdmClkConfig

source

pub fn new( sample_rate_hz: u32, clk_src: ClockSource, mclk_multiple: MclkMultiple, ) -> Self

Create a TDM clock configuration with the specified rate (in Hz), clock source, and MCLK multiple of the sample rate.

source

pub fn from_sample_rate_hz(rate: u32) -> Self

Create a TDM clock configuration with the specified rate in Hz. This will set the clock source to PLL_F160M, MCLK multiple to 256 times the sample rate, and MCLK to BCLK division to 8.

§Note

Set the mclk_multiple to MclkMultiple::M384 when using 24-bit data width. Otherwise, the sample rate might be imprecise since the BCLK division is not an integer.

source

pub fn clk_src(self, clk_src: ClockSource) -> Self

Set the clock source on this TDM clock configuration.

source

pub fn mclk_multiple(self, mclk_multiple: MclkMultiple) -> Self

Set the MCLK multiple on this TDM clock configuration.

source

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

Set the MCLK to BCLK division on this TDM clock configuration.

Trait Implementations§

source§

impl Clone for TdmClkConfig

source§

fn clone(&self) -> TdmClkConfig

Returns a copy of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
source§

impl Debug for TdmClkConfig

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for TdmClkConfig

source§

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

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

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.
source§

impl Copy for TdmClkConfig

source§

impl Eq for TdmClkConfig

source§

impl StructuralPartialEq for TdmClkConfig

Auto Trait Implementations§

§

impl Freeze for TdmClkConfig

§

impl RefUnwindSafe for TdmClkConfig

§

impl Send for TdmClkConfig

§

impl Sync for TdmClkConfig

§

impl Unpin for TdmClkConfig

§

impl UnwindSafe for TdmClkConfig

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CloneToUninit for T
where T: Copy,

§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.