Struct AudioMix 

#[non_exhaustive]
pub struct AudioMix { /* private fields */ }

Represents an audio source.

Audio is defined by layers, each subsequent layer applies to the computed result of the previous layer.

Implementations

impl AudioMix

pub fn new() -> Self

New empty.

pub fn with_delay(self, duration: Duration) -> Self

Plays silence for the duration before starting layers mix.

pub fn with_total_duration(self, duration: Duration) -> Self

Set the total duration.

If not set audio plays until all audio and mix layers end. If set audio plays for the duration, if layers end before the duration plays silent at the end, if layers exceed the duration they are clipped.

Note that the duration must account for the initial delay, the initial silence is included in the the total duration.

pub fn with_audio(self, audio: &AudioTrack) -> Self

Add layer that plays the cached audio.

The audio samples are adapted to the output format and each sample added to the under layers result.

pub fn with_audio_clip( self, audio: &AudioTrack, skip: Duration, take: Duration, ) -> Self

Add layer that clips and plays the cached audio.

This is similar to with_audio, but only the range skip..skip + take is played.

pub fn with_mix(self, mix: impl Into<AudioMix>) -> Self

Add layer that plays another mix.

The inner mix is sampled as computed audio, that is, samples are computed first and added to the under layers result.

pub fn with_mix_clip( self, mix: impl Into<AudioMix>, skip: Duration, take: Duration, ) -> Self

Add layer that clips and plays another mix.

This is similar to with_mix, but only the range skip..skip + take is played.

pub fn with_sine_wave(self, frequency: f32, duration: Duration) -> Self

Add layer that generates a sine wave sound.

The generated sound samples are added to the under layers result.

pub fn with_volume_linear( self, start: Duration, duration: Duration, start_volume: Factor, end_volume: Factor, ) -> Self

Add effect layer that applies a linear volume transition.

When the playback is in range the computed sample of under layers is multiplied by the linear interpolation between start_volume and end_volume.

Note that outside the volume range is not affected, before and after.

pub fn with_fade_in(self, transition_duration: Duration) -> Self

Add an effect layer that fades in from the start over a transition duration.

A linear volume transition at the start raises the volume of under layers from zero to normal over the transition_duration.

pub fn with_fade_out( self, start: Duration, transition_duration: Duration, ) -> Self

Add an effect layer that fades out the audio after start.

A linear volume transition lowers the volume of under layers after start to zero over transition_duration, the volume remains zeroed until audio end.

Note that this does not affect the total duration, you must also call with_total_duration to fade out and stop.

Trait Implementations

impl Clone for AudioMix

fn clone(&self) -> AudioMix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioMix

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

Formats the value using the given formatter.

impl Default for AudioMix

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AudioMix

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&AudioTrack> for AudioMix

fn from(audio: &AudioTrack) -> Self

Converts to this type from the input type.

impl From<AudioMix> for AudioMix

fn from(mix: AudioMix) -> Self

Converts to this type from the input type.

impl From<AudioTrack> for AudioMix

fn from(audio: AudioTrack) -> Self

Converts to this type from the input type.

impl IntoVar<AudioMix> for AudioMix

fn into_var(self) -> Var<ViewAudioMix>

impl IntoVar<AudioMix> for AudioTrack

fn into_var(self) -> Var<AudioMix>

impl PartialEq for AudioMix

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl IntoValue<AudioMix> for AudioMix

impl IntoValue<AudioMix> for AudioTrack

impl StructuralPartialEq for AudioMix