Skip to main content

PdmRxSlotConfig

Struct PdmRxSlotConfig 

Source
#[non_exhaustive]
pub struct PdmRxSlotConfig { pub slot_mode: PdmSlotMode, pub slot_mask: PdmSlotMask, pub data_format: PdmDataFormat, pub hp_en: bool, pub hp_cut_off_freq_hz: f32, pub amplify_num: u32, }
Expand description

PDM RX slot configuration.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§slot_mode: PdmSlotMode

Mono or stereo slot mode.

§slot_mask: PdmSlotMask

Active RX slot mask.

§data_format: PdmDataFormat

PCM or raw PDM data format.

§hp_en: bool

Enable the RX high-pass filter.

§hp_cut_off_freq_hz: f32

High-pass filter cut-off frequency in Hz.

§amplify_num: u32

RX amplification factor (1–15).

Implementations§

Source§

impl PdmRxSlotConfig

Source

pub fn with_slot_mode(self, slot_mode: PdmSlotMode) -> Self

Assign the given value to the slot_mode field.

Source

pub fn slot_mode(&self) -> PdmSlotMode

Mono or stereo slot mode.

Source

pub fn with_slot_mask(self, slot_mask: PdmSlotMask) -> Self

Assign the given value to the slot_mask field.

Source

pub fn slot_mask(&self) -> PdmSlotMask

Active RX slot mask.

Source

pub fn with_data_format(self, data_format: PdmDataFormat) -> Self

Assign the given value to the data_format field.

Source

pub fn data_format(&self) -> PdmDataFormat

PCM or raw PDM data format.

Source

pub fn with_hp_en(self, hp_en: bool) -> Self

Assign the given value to the hp_en field.

Source

pub fn hp_en(&self) -> bool

Enable the RX high-pass filter.

Source

pub fn with_hp_cut_off_freq_hz(self, hp_cut_off_freq_hz: f32) -> Self

Assign the given value to the hp_cut_off_freq_hz field.

Source

pub fn hp_cut_off_freq_hz(&self) -> f32

High-pass filter cut-off frequency in Hz.

Source

pub fn with_amplify_num(self, amplify_num: u32) -> Self

Assign the given value to the amplify_num field.

Source

pub fn amplify_num(&self) -> u32

RX amplification factor (1–15).

Trait Implementations§

Source§

impl Clone for PdmRxSlotConfig

Available on crate feature unstable only.
Source§

fn clone(&self) -> PdmRxSlotConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable)§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PdmRxSlotConfig

Available on crate feature unstable only.
Source§

impl Debug for PdmRxSlotConfig

Available on crate feature unstable only.
Source§

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

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

impl PartialEq for PdmRxSlotConfig

Available on crate feature unstable only.
Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable)§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PdmRxSlotConfig

Available on crate feature unstable only.

Auto Trait Implementations§

§

impl Freeze for PdmRxSlotConfig

§

impl RefUnwindSafe for PdmRxSlotConfig

§

impl Send for PdmRxSlotConfig

§

impl Sync for PdmRxSlotConfig

§

impl Unpin for PdmRxSlotConfig

§

impl UnsafeUnpin for PdmRxSlotConfig

§

impl UnwindSafe for PdmRxSlotConfig

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,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

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.