Struct kittyaudio::Frame

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

Represents an audio sample. Stores a left and right channel.

Fields

left: f32

Left channel value. Float.

right: f32

Right channel value. Float.

Implementations

impl Frame

pub const ZERO: Self = _

A frame with all channels set to 0.0.

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

Create a new audio frame from left and right values.

pub const fn from_mono(value: f32) -> Self

Create a new audio frame from a single value.

Examples found in repository

examples/custom_renderer.rs (line 15)

    fn next_frame(&mut self, sample_rate: u32) -> Frame {
        self.frame += 1;
        let time = self.frame as f64 / sample_rate as f64;
        let value = (time.sin() * 1200.0).sin() * 0.5;
        Frame::from_mono(value as f32)
    }

Trait Implementations

impl Add for Frame

type Output = Frame

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Frame

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy 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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Frame

Returns the “default value” for a type.

impl Div<f32> for Frame

type Output = Frame

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self::Output

Performs the / operation.

impl DivAssign<f32> for Frame

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl From<[f32; 2]> for Frame

fn from(lr: [f32; 2]) -> Self

Converts to this type from the input type.

impl From<(f32, f32)> for Frame

fn from(lr: (f32, f32)) -> Self

Converts to this type from the input type.

impl From<f32> for Frame

fn from(value: f32) -> Self

Converts to this type from the input type.

impl Mul<f32> for Frame

type Output = Frame

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::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) -> Self::Output

Performs the unary - operation.

impl PartialEq for Frame

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Frame

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Frame

impl StructuralPartialEq for Frame