Struct kira::arrangement::Arrangement

pub struct Arrangement { /* fields omitted */ }

An arrangement of sound clips to play at specific times.

Implementations

impl Arrangement

pub fn new(settings: ArrangementSettings) -> Self

Creates a new, empty arrangement.

pub fn new_loop(
    sound_handle: &SoundHandle,
    settings: LoopArrangementSettings
) -> Self

Creates a new arrangement that seamlessly loops a sound.

If the sound has a semantic duration, it will be used to set the point where the sound loops. Any audio after the semantic end of the sound will be preserved when the sound loops.

pub fn new_loop_with_intro(
    intro_sound_handle: &SoundHandle,
    loop_sound_handle: &SoundHandle,
    settings: LoopArrangementSettings
) -> Self

Creates a new arrangement that plays an intro sound, then seamlessly loops another sound.

If the intro has a semantic duration, it will be used to determine when the loop sound starts. If the loop sound has a semantic duration, it will be used to set the point where the sound repeats. Any audio after the semantic end of the sound will be preserved when the sound loops.

pub fn add_clip(&mut self, clip: SoundClip) -> &mut Self

Adds a sound clip to the arrangement.

pub fn id(&self) -> ArrangementId

Gets the unique identifier for this arrangement.

pub fn duration(&self) -> f64

Gets the duration of the arrangement.

The duration is always the end of the last playing sound clip.

pub fn default_track(&self) -> TrackIndex

Gets the default track instances of this arrangement will play on.

pub fn groups(&self) -> &GroupSet

Gets the groups this arrangement belongs to.

pub fn semantic_duration(&self) -> Option<f64>

Gets the “musical length” of the arrangement (if there is one).

pub fn default_loop_start(&self) -> Option<f64>

Returns the default time (in seconds) instances of this arrangement will loop back to when they reach the end.

Trait Implementations

impl Clone for Arrangement

fn clone(&self) -> Arrangement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Arrangement

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

Formats the value using the given formatter.