Skip to main content

SampleFormat

Struct SampleFormat 

Source
pub struct SampleFormat { /* private fields */ }
Expand description

Audio sample format: rate, bit depth, and channel count.

Implementations§

Source§

impl SampleFormat

Source

pub const fn new(rate: u32, bits: u16, channels: u16) -> SampleFormat

Create a new sample format.

Source

pub fn rate(&self) -> u32

Sample rate in Hz.

Source

pub fn bits(&self) -> u16

Bit depth per sample.

Source

pub fn channels(&self) -> u16

Number of audio channels.

Source

pub fn sample_size(&self) -> u16

Size in bytes of a single mono sample.

Note: 24-bit samples are padded to 4 bytes (matching C++ behavior).

Source

pub fn frame_size(&self) -> u16

Size in bytes of one frame (all channels combined).

Source

pub fn ms_rate(&self) -> f64

Sample rate in frames per millisecond.

Source

pub fn frames_to_ms(&self, frames: usize) -> f64

Convert a frame count to duration in milliseconds.

Source

pub fn is_initialized(&self) -> bool

Whether any field has been set (non-zero).

Trait Implementations§

Source§

impl Clone for SampleFormat

Source§

fn clone(&self) -> SampleFormat

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 SampleFormat

Source§

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

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

impl Default for SampleFormat

Source§

fn default() -> SampleFormat

Returns the “default value” for a type. Read more
Source§

impl Display for SampleFormat

Source§

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

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

impl FromStr for SampleFormat

Source§

fn from_str(s: &str) -> Result<SampleFormat, <SampleFormat as FromStr>::Err>

Parse from "rate:bits:channels" string. * means 0 (unspecified).

Source§

type Err = SampleFormatError

The associated error which can be returned from parsing.
Source§

impl PartialEq for SampleFormat

Source§

fn eq(&self, other: &SampleFormat) -> 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 Copy for SampleFormat

Source§

impl Eq for SampleFormat

Source§

impl StructuralPartialEq for SampleFormat

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more