Struct Samples 

pub struct Samples { /* private fields */ }

A sound made at run time: 16-bit samples, interleaved (left first in stereo), at a rate. Any rate from 1 to Self::MAX_RATE: a backend plays it at its own.

Implementations

impl Samples

pub const MAX_RATE: u32 = 192_000

The highest rate, in samples a second.

pub fn new( rate: u32, channels: u32, samples: Vec<i16>, ) -> Result<Self, SamplesError>

samples, interleaved, at rate with channels (1 or 2), if they are whole frames.

pub fn from_u8( rate: u32, channels: u32, bytes: &[u8], ) -> Result<Self, SamplesError>

bytes of 8-bit unsigned samples (128 is silence), as old formats keep them, interleaved, at rate with channels: each becomes (b − 128) × 256.

pub const fn rate(&self) -> u32

Its rate, in frames a second.

pub const fn channels(&self) -> u16

How many channels it has: 1 or 2.

pub fn samples(&self) -> &[i16]

Its samples, interleaved.

pub fn into_samples(self) -> Vec<i16>

Its samples, handed over.

pub fn frames(&self) -> u64

How many frames it has.

pub fn millis(&self) -> u64

How long it plays, in whole milliseconds rounded down.

pub fn bytes(&self) -> u64

The bytes its samples hold: two a sample.

pub fn to_wav(&self) -> Vec<u8>

It as a WAV file of 16-bit integer samples, at its rate and channels: for a device that loads a sound from a file’s bytes.

Trait Implementations

impl Clone for Samples

fn clone(&self) -> Samples

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Samples

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

Formats the value using the given formatter.

impl Eq for Samples

impl PartialEq for Samples

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Samples