Struct jumpy::prelude::kira::track::TrackBuilder

pub struct TrackBuilder {
    pub(crate) volume: Value<Volume>,
    pub(crate) routes: TrackRoutes,
    pub(crate) effects: Vec<Box<dyn Effect>>,
}

Configures a mixer track.

Fields

volume: Value<Volume>

routes: TrackRoutes

effects: Vec<Box<dyn Effect>>

Implementations

impl TrackBuilder

pub fn new() -> TrackBuilder

Creates a new TrackBuilder with the default settings.

pub fn volume(self, volume: impl Into<Value<Volume>>) -> TrackBuilder

Sets the volume of the track.

Examples

Set the volume as a factor:

let builder = TrackBuilder::new().volume(0.5);

Set the volume as a gain in decibels:

let builder = TrackBuilder::new().volume(kira::Volume::Decibels(-6.0));

Link the volume to a modulator:

use kira::{
	manager::{AudioManager, AudioManagerSettings, backend::DefaultBackend},
	modulator::tweener::TweenerBuilder,
	track::TrackBuilder,
};

let mut manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default())?;
let tweener = manager.add_modulator(TweenerBuilder {
	initial_value: 0.5,
})?;
let builder = TrackBuilder::new().volume(&tweener);

pub fn routes(self, routes: TrackRoutes) -> TrackBuilder

Sets how the output of this track should be routed to other mixer tracks.

pub fn add_effect<B>(&mut self, builder: B) -> <B as EffectBuilder>::Handle

where B: EffectBuilder,

Adds an effect to the track.

Examples

use kira::{track::TrackBuilder, effect::delay::DelayBuilder};

let mut builder = TrackBuilder::new();
let delay_handle = builder.add_effect(DelayBuilder::new());

pub fn with_effect<B>(self, builder: B) -> TrackBuilder

where B: EffectBuilder,

Adds an effect to the track and returns the TrackBuilder.

If you need to modify the effect later, use add_effect, which returns the effect handle.

Examples

use kira::{
	track::TrackBuilder,
	effect::{filter::FilterBuilder, reverb::ReverbBuilder},
};

let mut builder = TrackBuilder::new()
	.with_effect(FilterBuilder::new())
	.with_effect(ReverbBuilder::new());

pub fn add_built_effect(&mut self, effect: Box<dyn Effect>)

Adds an already built effect into this track.

Box<dyn Effect> values are created when calling build on an effect builder, which gives you an effect handle, as well as this boxed effect, which is the actual audio effect.

This is a lower-level method than Self::add_effect, and you should probably use it rather than this method, unless you have a reason to.

Examples

use kira::track::TrackBuilder;
use kira::effect::{EffectBuilder, delay::DelayBuilder};

let mut builder = TrackBuilder::new();
let delay_builder = DelayBuilder::new();
let (effect, delay_handle) = delay_builder.build();
let delay_handle = builder.add_built_effect(effect);

pub fn with_built_effect(self, effect: Box<dyn Effect>) -> TrackBuilder

Add an already-built effect and return the TrackBuilder.

Box<dyn Effect> values are created when calling build on an effect builder, which gives you an effect handle, as well as this boxed effect, which is the actual audio effect.

This is a lower-level method than Self::with_effect, and you should probably use it rather than this method, unless you have a reason to.

Examples

use kira::{
	track::TrackBuilder,
	effect::{filter::FilterBuilder, reverb::ReverbBuilder, EffectBuilder},
};

let (filter_effect, filter_handle) = FilterBuilder::new().build();
let (reverb_effect, reverb_handle) = ReverbBuilder::new().build();
let mut builder = TrackBuilder::new()
	.with_built_effect(filter_effect)
	.with_built_effect(reverb_effect);

Trait Implementations

impl Default for TrackBuilder

fn default() -> TrackBuilder

Returns the “default value” for a type.