Skip to main content

PdmTxSlotConfig

Struct PdmTxSlotConfig 

Source
#[non_exhaustive]
pub struct PdmTxSlotConfig { pub slot_mode: PdmSlotMode, pub data_format: PdmDataFormat, pub sd_prescale: u8, pub sd_scale: PdmSigScaling, pub hp_scale: PdmSigScaling, pub lp_scale: PdmSigScaling, pub sinc_scale: PdmSigScaling, pub line_mode: PdmTxLineMode, pub hp_en: bool, pub hp_cut_off_freq_hz: f32, pub sd_dither: u8, pub sd_dither2: u8, }
Expand description

PDM TX slot / filter 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.

§data_format: PdmDataFormat

PCM or raw PDM data format.

§sd_prescale: u8

Sigma-delta prescale value.

§sd_scale: PdmSigScaling

Sigma-delta filter input scaling.

§hp_scale: PdmSigScaling

High-pass filter input scaling.

§lp_scale: PdmSigScaling

Low-pass filter input scaling.

§sinc_scale: PdmSigScaling

Sinc filter input scaling.

§line_mode: PdmTxLineMode

Output line routing mode.

§hp_en: bool

Enable the TX high-pass filter.

§hp_cut_off_freq_hz: f32

High-pass filter cut-off frequency in Hz.

§sd_dither: u8

Sigma-delta dither bit 0.

§sd_dither2: u8

Sigma-delta dither bit 1.

Implementations§

Source§

impl PdmTxSlotConfig

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_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_sd_prescale(self, sd_prescale: u8) -> Self

Assign the given value to the sd_prescale field.

Source

pub fn sd_prescale(&self) -> u8

Sigma-delta prescale value.

Source

pub fn with_sd_scale(self, sd_scale: PdmSigScaling) -> Self

Assign the given value to the sd_scale field.

Source

pub fn sd_scale(&self) -> PdmSigScaling

Sigma-delta filter input scaling.

Source

pub fn with_hp_scale(self, hp_scale: PdmSigScaling) -> Self

Assign the given value to the hp_scale field.

Source

pub fn hp_scale(&self) -> PdmSigScaling

High-pass filter input scaling.

Source

pub fn with_lp_scale(self, lp_scale: PdmSigScaling) -> Self

Assign the given value to the lp_scale field.

Source

pub fn lp_scale(&self) -> PdmSigScaling

Low-pass filter input scaling.

Source

pub fn with_sinc_scale(self, sinc_scale: PdmSigScaling) -> Self

Assign the given value to the sinc_scale field.

Source

pub fn sinc_scale(&self) -> PdmSigScaling

Sinc filter input scaling.

Source

pub fn with_line_mode(self, line_mode: PdmTxLineMode) -> Self

Assign the given value to the line_mode field.

Source

pub fn line_mode(&self) -> PdmTxLineMode

Output line routing mode.

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 TX 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_sd_dither(self, sd_dither: u8) -> Self

Assign the given value to the sd_dither field.

Source

pub fn sd_dither(&self) -> u8

Sigma-delta dither bit 0.

Source

pub fn with_sd_dither2(self, sd_dither2: u8) -> Self

Assign the given value to the sd_dither2 field.

Source

pub fn sd_dither2(&self) -> u8

Sigma-delta dither bit 1.

Trait Implementations§

Source§

impl Clone for PdmTxSlotConfig

Available on crate feature unstable only.
Source§

fn clone(&self) -> PdmTxSlotConfig

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 Debug for PdmTxSlotConfig

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 PdmTxSlotConfig

Available on crate feature unstable only.
Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable)§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for PdmTxSlotConfig

Available on crate feature unstable only.
Source§

impl StructuralPartialEq for PdmTxSlotConfig

Available on crate feature unstable only.

Auto Trait Implementations§

§

impl Freeze for PdmTxSlotConfig

§

impl RefUnwindSafe for PdmTxSlotConfig

§

impl Send for PdmTxSlotConfig

§

impl Sync for PdmTxSlotConfig

§

impl Unpin for PdmTxSlotConfig

§

impl UnsafeUnpin for PdmTxSlotConfig

§

impl UnwindSafe for PdmTxSlotConfig

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.