Struct bevy_retrograde::audio::kira::arrangement::Arrangement [−]
pub struct Arrangement { /* fields omitted */ }
Expand description
An arrangement of sound clips to play at specific times.
Implementations
impl Arrangement
impl Arrangement
pub fn new(settings: ArrangementSettings) -> Arrangement
pub fn new(settings: ArrangementSettings) -> Arrangement
Creates a new, empty arrangement.
pub fn new_loop(
sound_handle: &SoundHandle,
settings: LoopArrangementSettings
) -> Arrangement
pub fn new_loop(
sound_handle: &SoundHandle,
settings: LoopArrangementSettings
) -> Arrangement
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
) -> Arrangement
pub fn new_loop_with_intro(
intro_sound_handle: &SoundHandle,
loop_sound_handle: &SoundHandle,
settings: LoopArrangementSettings
) -> Arrangement
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 Arrangement
pub fn add_clip(&mut self, clip: SoundClip) -> &mut Arrangement
Adds a sound clip to the arrangement.
pub fn id(&self) -> ArrangementId
pub fn id(&self) -> ArrangementId
Gets the unique identifier for this arrangement.
Gets the duration of the arrangement.
The duration is always the end of the last playing sound clip.
pub fn default_track(&self) -> TrackIndex
pub fn default_track(&self) -> TrackIndex
Gets the default track instances of this arrangement will play on.
pub fn semantic_duration(&self) -> Option<f64>
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>
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
impl Clone for Arrangement
pub fn clone(&self) -> Arrangement
pub fn clone(&self) -> Arrangement
Returns a copy of the value. Read more
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl RefUnwindSafe for Arrangement
impl Send for Arrangement
impl Sync for Arrangement
impl Unpin for Arrangement
impl UnwindSafe for Arrangement
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
pub fn vzip(self) -> V