Struct Frame

pub struct Frame {
    pub left: f32,
    pub right: f32,
}

A stereo audio sample.

Fields

left: f32

The sample for the left channel.

right: f32

The sample for the right channel.

Implementations

impl Frame

pub const ZERO: Frame

A Frame with both the left and right samples set to 0.0.

pub fn new(left: f32, right: f32) -> Frame

Creates a frame with the given left and right values.

pub fn from_mono(value: f32) -> Frame

Creates a frame with both the left and right channels set to the same value.

pub fn panned(self, x: f32) -> Frame

Pans a frame to the left or right.

An x of 0 represents a hard left panning, an x of 1 represents a hard right panning.

pub fn as_mono(self) -> Frame

Returns the frame mixed down to mono.

Trait Implementations

impl Add for Frame

type Output = Frame

The resulting type after applying the + operator.

fn add(self, rhs: Frame) -> <Frame as Add>::Output

Performs the + operation.

impl AddAssign for Frame

fn add_assign(&mut self, rhs: Frame)

Performs the += operation.

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Div<f32> for Frame

type Output = Frame

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> <Frame as Div<f32>>::Output

Performs the / operation.

impl DivAssign<f32> for Frame

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl Mul<f32> for Frame

type Output = Frame

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> <Frame as Mul<f32>>::Output

Performs the * operation.

impl MulAssign<f32> for Frame

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Frame

type Output = Frame

The resulting type after applying the - operator.

fn neg(self) -> <Frame as Neg>::Output

Performs the unary - operation.

impl PartialEq for Frame

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

type Output = Frame

The resulting type after applying the - operator.

fn sub(self, rhs: Frame) -> <Frame as Sub>::Output

Performs the - operation.

impl SubAssign for Frame

fn sub_assign(&mut self, rhs: Frame)

Performs the -= operation.

impl Copy for Frame

impl StructuralPartialEq for Frame