Struct Soniton

pub struct Soniton {
    pub bits: u8,
    pub be: bool,
    pub packed: bool,
    pub planar: bool,
    pub float: bool,
    pub signed: bool,
}

Audio format definition.

Fields

bits: u8

Bits per sample.

be: bool

Tells if audio format is big-endian.

packed: bool

Audio samples are packed (e.g. 20-bit audio samples) and not padded.

planar: bool

Audio data is stored in planar format (channels in sequence i.e. C1 C1 C1… C2 C2 C2) instead of interleaving samples (i.e. C1 C2 C1 C2) for different channels.

float: bool

Audio data is in floating point format.

signed: bool

Audio data is signed (usually only 8-bit audio is unsigned).

Implementations

impl Soniton

pub fn new( bits: u8, be: bool, packed: bool, planar: bool, float: bool, signed: bool, ) -> Self

Constructs a new audio format definition.

pub fn get_audio_size(self, length: usize, alignment: usize) -> usize

Returns the amount of bytes needed to store the audio of requested length (in samples).

Trait Implementations

impl Clone for Soniton

fn clone(&self) -> Soniton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Soniton

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

Formats the value using the given formatter.

impl Display for Soniton

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

Formats the value using the given formatter.

impl Hash for Soniton

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Soniton

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Soniton

impl Eq for Soniton

impl StructuralPartialEq for Soniton