Struct bae_rs::sample_format::stereo::Stereo

pub struct Stereo {
    pub left: SampleT,
    pub right: SampleT,
}

Struct representing a stereophonic audio sample.

Fields

left: SampleT

Left sample value.

right: SampleT

Right sample value.

Methods

impl Stereo

pub fn from_stereo(l: SampleT, r: SampleT) -> Stereo

Returns a new Stereo object created from individual left and right audio samples.

Parameters

• l - the left audio sample.
• r - the right audio sapmle.

pub fn single_stereo(x: SampleT) -> Stereo

Returns a new Stereo object where both left and right channels are copied from the passed sample value.

pub fn from_mono(x: SampleT) -> Stereo

Creates a new Stereo object from a single monophonic sample. This function reduces the power of the given sample by half to reflect human hearing.

Parameters

• x - the input sample.

pub fn as_mono(self) -> SampleT

Converts the given stereophonic sample to a monophonic sample by summing the left and right samples and dividing by half power to get the full power monophonic sample.

Trait Implementations

impl Add<Stereo> for Stereo

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Stereo) -> Self::Output

Performs the + operation.

impl AddAssign<Stereo> for Stereo

fn add_assign(&mut self, rhs: Stereo)

Performs the += operation.

impl Clone for Stereo

fn clone(&self) -> Stereo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Stereo

impl Default for Stereo

fn default() -> Stereo

Returns the "default value" for a type.

impl From<[u8; 2]> for Stereo

fn from(v: [u8; 2]) -> Self

Converts the array of 2 bytes into a Stereo object. It is assumed that the bytes are 8-bit unsigned audio samples.

Parameters

• v - The raw bytes to convert from.

impl From<[u8; 4]> for Stereo

fn from(v: [u8; 4]) -> Self

Converts the array of 4 bytes into a Stereo object. It is assumed that the bytes are 16-bit signed audio samples.

Parameters

• v - The raw bytes to convert from.

impl From<[u8; 6]> for Stereo

fn from(v: [u8; 6]) -> Self

Converts the array of 6 bytes into a Stereo object. It is assumed that the bytes are 24-bit signed audio samples.

Parameters

• v - The raw bytes to convert from.

impl From<f32> for Stereo

fn from(s: SampleT) -> Self

Copies the given sample to the left and right channels. If you want to use the half-power conversion, use Stereo::from_mono.

impl Into<Vec<u8>> for Stereo

fn into(self) -> Vec<u8>

Converts the Stereo into a vector of bytes.

impl Mul<Stereo> for Stereo

type Output = Stereo

The resulting type after applying the * operator.

fn mul(self, rhs: Stereo) -> Self::Output

Performs the * operation.

impl Mul<Stereo> for SampleT

type Output = Stereo

The resulting type after applying the * operator.

fn mul(self, rhs: Stereo) -> Self::Output

Performs the * operation.

impl Mul<Stereo> for MathT

type Output = Stereo

The resulting type after applying the * operator.

fn mul(self, rhs: Stereo) -> Self::Output

Performs the * operation.

impl Mul<f32> for Stereo

type Output = Stereo

The resulting type after applying the * operator.

fn mul(self, rhs: SampleT) -> Self::Output

Performs the * operation.

impl Mul<f64> for Stereo

type Output = Stereo

Output type of the multiplication

fn mul(self, rhs: MathT) -> Self::Output

Multiplies a sample by a value. E.g. scaling the sample by a gain amount.

impl MulAssign<Stereo> for Stereo

fn mul_assign(&mut self, rhs: Stereo)

Performs the *= operation.

impl MulAssign<f32> for Stereo

fn mul_assign(&mut self, rhs: SampleT)

Performs the *= operation.

impl MulAssign<f64> for Stereo

fn mul_assign(&mut self, rhs: MathT)

Performs the *= operation.

impl Neg for Stereo

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Panner<Stereo, f32> for Stereo

fn to_sample_format(s: SampleT, g: f32) -> Stereo

Converts the monophonic sample into a polyphonic sample.

impl Sub<Stereo> for Stereo

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: Stereo) -> Self

Performs the - operation.

impl SubAssign<Stereo> for Stereo

fn sub_assign(&mut self, rhs: Stereo)

Performs the -= operation.