Struct kira::arrangement::LoopArrangementSettings

pub struct LoopArrangementSettings {
    pub id: Option<ArrangementId>,
    pub default_track: TrackIndex,
    pub cooldown: Option<f64>,
    pub semantic_duration: Option<f64>,
    pub groups: GroupSet,
}

Settings for a looping Arrangement.

Fields

id: Option<ArrangementId>

The unique identifier for this arrangement.

default_track: TrackIndex

The track instances of this arrangement will play on by default.

cooldown: Option<f64>

Whether the arrangement should have a “cool off” period after playing before it can be played again, and if so, the duration of that cool off period.

This is useful to avoid situations where the same arrangement is played multiple times at the exact same point in time, resulting in the arrangement being louder than normal.

semantic_duration: Option<f64>

How long the arrangement is musically.

For example, a recording of a 2-bar drum fill in an echoey cathedral may have 5 seconds of actual drumming and then 10 seconds of reverberations from the building. So even though the audio is 15 seconds long, you might say the music only lasts for 5 seconds.

If set, the semantic duration of the arrangement will be used as the default end point when looping the arrangement.

groups: GroupSet

The groups this arrangement belongs to.

Implementations

impl LoopArrangementSettings

pub fn new() -> Self

Creates a new LoopArrangementSettings with the default settings.

pub fn id(self, id: impl Into<ArrangementId>) -> Self

Sets the unique identifier for the arrangement.

pub fn default_track<T: Into<TrackIndex>>(self, track: T) -> Self

Sets the track instances of this arrangement will play on by default.

pub fn cooldown(self, cooldown: f64) -> Self

Sets the cooldown time of the arrangement.

pub fn semantic_duration(self, semantic_duration: f64) -> Self

Sets the semantic duration of the arrangement.

pub fn groups(self, groups: impl Into<GroupSet>) -> Self

Sets the group this arrangement belongs to.

Trait Implementations

impl Clone for LoopArrangementSettings

fn clone(&self) -> LoopArrangementSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoopArrangementSettings

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

Formats the value using the given formatter.

impl Default for LoopArrangementSettings

fn default() -> Self

Returns the “default value” for a type.