Skip to main content

AudioParams

Struct AudioParams 

Source
pub struct AudioParams {
    pub sample_rate: u32,
    pub channels: u16,
    pub sample_format: SampleFormat,
    pub bitrate_bps: Option<u64>,
    pub frame_size: Option<u32>,
    pub loudness_lufs: Option<f32>,
}
Expand description

Audio stream encoding / decoding parameters.

Fields§

§sample_rate: u32

Sample rate in Hz (e.g. 48_000 for broadcast audio).

§channels: u16

Number of audio channels (1 = mono, 2 = stereo, 6 = 5.1, …).

§sample_format: SampleFormat

Sample format (default: SampleFormat::F32).

§bitrate_bps: Option<u64>

Target or measured peak bitrate in bits per second, if known.

§frame_size: Option<u32>

Frame size (samples per channel per frame), if fixed by the codec.

For example, Opus uses 20 ms frames at 48 kHz → 960 samples.

§loudness_lufs: Option<f32>

Normalisation loudness target in LUFS, if known (e.g. −23 LUFS for EBU R128).

Implementations§

Source§

impl AudioParams

Source

pub fn new(sample_rate: u32, channels: u16) -> Self

Creates minimal AudioParams with sample_rate and channels.

Defaults: sample_format = SampleFormat::F32, other fields None.

Source

pub fn is_valid(&self) -> bool

Returns true if the parameters are logically valid.

Source

pub fn frame_duration_secs(&self) -> Option<f64>

Returns the duration of a single frame in seconds, or None if no fixed frame size is set.

Source

pub fn with_sample_format(self, fmt: SampleFormat) -> Self

Builder-style setter for sample format.

Source

pub fn with_bitrate(self, bps: u64) -> Self

Builder-style setter for bitrate.

Source

pub fn with_frame_size(self, samples: u32) -> Self

Builder-style setter for frame size.

Source

pub fn with_loudness(self, lufs: f32) -> Self

Builder-style setter for loudness target.

Trait Implementations§

Source§

impl Clone for AudioParams

Source§

fn clone(&self) -> AudioParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AudioParams

Source§

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

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

impl PartialEq for AudioParams

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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 StructuralPartialEq for AudioParams

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.