Struct kira::sequence::Sequence [−][src]
Expand description
A series of steps to execute at certain times.
Implementations
impl<CustomEvent: Clone + Eq + Hash> Sequence<CustomEvent>
[src]
impl<CustomEvent: Clone + Eq + Hash> Sequence<CustomEvent>
[src]pub fn new(settings: SequenceSettings) -> Self
[src]
pub fn new(settings: SequenceSettings) -> Self
[src]Creates a new sequence.
pub fn wait(&mut self, duration: Duration)
[src]
pub fn wait(&mut self, duration: Duration)
[src]Adds a step to wait for a certain length of time before moving to the next step.
pub fn wait_for_interval(&mut self, interval: f64)
[src]
pub fn wait_for_interval(&mut self, interval: f64)
[src]Adds a step to wait for a certain metronome interval (in beats) to be passed before moving to the next step.
pub fn start_loop(&mut self)
[src]
pub fn start_loop(&mut self)
[src]Marks the point the sequence will loop back to after it finishes the last step.
pub fn play<P: Into<PlayableId>>(
&mut self,
playable: P,
settings: InstanceSettings
) -> InstanceId
[src]
pub fn play<P: Into<PlayableId>>(
&mut self,
playable: P,
settings: InstanceSettings
) -> InstanceId
[src]Adds a step to play a sound or arrangement.
pub fn play_random(
&mut self,
choices: Vec<PlayableId>,
settings: InstanceSettings
) -> InstanceId
[src]
pub fn play_random(
&mut self,
choices: Vec<PlayableId>,
settings: InstanceSettings
) -> InstanceId
[src]Adds a step to play a random sound or arrangement from a list of choices.
pub fn set_instance_volume(
&mut self,
id: impl Into<InstanceId>,
volume: Value<f64>
)
[src]
pub fn set_instance_volume(
&mut self,
id: impl Into<InstanceId>,
volume: Value<f64>
)
[src]Adds a step to set the volume of an instance.
pub fn set_instance_playback_rate(
&mut self,
id: impl Into<InstanceId>,
playback_rate: Value<f64>
)
[src]
pub fn set_instance_playback_rate(
&mut self,
id: impl Into<InstanceId>,
playback_rate: Value<f64>
)
[src]Adds a step to set the playback rate of an instance.
pub fn set_instance_panning(
&mut self,
id: impl Into<InstanceId>,
panning: Value<f64>
)
[src]
pub fn set_instance_panning(
&mut self,
id: impl Into<InstanceId>,
panning: Value<f64>
)
[src]Adds a step to set the panning of an instance.
pub fn pause_instance(
&mut self,
id: impl Into<InstanceId>,
settings: PauseInstanceSettings
)
[src]
pub fn pause_instance(
&mut self,
id: impl Into<InstanceId>,
settings: PauseInstanceSettings
)
[src]Adds a step to pause an instance.
pub fn resume_instance(
&mut self,
id: impl Into<InstanceId>,
settings: ResumeInstanceSettings
)
[src]
pub fn resume_instance(
&mut self,
id: impl Into<InstanceId>,
settings: ResumeInstanceSettings
)
[src]Adds a step to resume an instance.
pub fn stop_instance(
&mut self,
id: impl Into<InstanceId>,
settings: StopInstanceSettings
)
[src]
pub fn stop_instance(
&mut self,
id: impl Into<InstanceId>,
settings: StopInstanceSettings
)
[src]Adds a step to stop an instance.
pub fn pause_instances_of(
&mut self,
playable: impl Into<PlayableId>,
settings: PauseInstanceSettings
)
[src]
pub fn pause_instances_of(
&mut self,
playable: impl Into<PlayableId>,
settings: PauseInstanceSettings
)
[src]Adds a step to pause all instances of a sound or arrangement.
pub fn resume_instances_of(
&mut self,
playable: impl Into<PlayableId>,
settings: ResumeInstanceSettings
)
[src]
pub fn resume_instances_of(
&mut self,
playable: impl Into<PlayableId>,
settings: ResumeInstanceSettings
)
[src]Adds a step to resume all instances of a sound or arrangement.
pub fn stop_instances_of(
&mut self,
playable: impl Into<PlayableId>,
settings: StopInstanceSettings
)
[src]
pub fn stop_instances_of(
&mut self,
playable: impl Into<PlayableId>,
settings: StopInstanceSettings
)
[src]Adds a step to stop all instances of a sound or arrangement.
pub fn pause_sequence(&mut self, id: impl Into<SequenceInstanceId>)
[src]
pub fn pause_sequence(&mut self, id: impl Into<SequenceInstanceId>)
[src]Adds a step to pause a sequence.
pub fn resume_sequence(&mut self, id: impl Into<SequenceInstanceId>)
[src]
pub fn resume_sequence(&mut self, id: impl Into<SequenceInstanceId>)
[src]Adds a step to resume a sequence.
pub fn stop_sequence(&mut self, id: impl Into<SequenceInstanceId>)
[src]
pub fn stop_sequence(&mut self, id: impl Into<SequenceInstanceId>)
[src]Adds a step to stop a sequence.
pub fn pause_sequence_and_instances(
&mut self,
id: impl Into<SequenceInstanceId>,
settings: PauseInstanceSettings
)
[src]
pub fn pause_sequence_and_instances(
&mut self,
id: impl Into<SequenceInstanceId>,
settings: PauseInstanceSettings
)
[src]Adds a step to pause a sequence and all instances played by it.
pub fn resume_sequence_and_instances(
&mut self,
id: impl Into<SequenceInstanceId>,
settings: ResumeInstanceSettings
)
[src]
pub fn resume_sequence_and_instances(
&mut self,
id: impl Into<SequenceInstanceId>,
settings: ResumeInstanceSettings
)
[src]Adds a step to resume a sequence and all instances played by it.
pub fn stop_sequence_and_instances(
&mut self,
id: impl Into<SequenceInstanceId>,
settings: StopInstanceSettings
)
[src]
pub fn stop_sequence_and_instances(
&mut self,
id: impl Into<SequenceInstanceId>,
settings: StopInstanceSettings
)
[src]Adds a step to stop a sequence and all instances played by it.
pub fn set_metronome_tempo(
&mut self,
id: impl Into<MetronomeId>,
tempo: impl Into<Value<Tempo>>
)
[src]
pub fn set_metronome_tempo(
&mut self,
id: impl Into<MetronomeId>,
tempo: impl Into<Value<Tempo>>
)
[src]Adds a step to set the tempo of the metronome.
pub fn start_metronome(&mut self, id: impl Into<MetronomeId>)
[src]
pub fn start_metronome(&mut self, id: impl Into<MetronomeId>)
[src]Adds a step to start the metronome.
pub fn pause_metronome(&mut self, id: impl Into<MetronomeId>)
[src]
pub fn pause_metronome(&mut self, id: impl Into<MetronomeId>)
[src]Adds a step to pause the metronome.
pub fn stop_metronome(&mut self, id: impl Into<MetronomeId>)
[src]
pub fn stop_metronome(&mut self, id: impl Into<MetronomeId>)
[src]Adds a step to stop the metronome.
pub fn set_parameter(
&mut self,
id: impl Into<ParameterId>,
target: f64,
tween: Option<Tween>
)
[src]
pub fn set_parameter(
&mut self,
id: impl Into<ParameterId>,
target: f64,
tween: Option<Tween>
)
[src]Adds a step to set a parameter.
Trait Implementations
Auto Trait Implementations
impl<CustomEvent> RefUnwindSafe for Sequence<CustomEvent> where
CustomEvent: RefUnwindSafe,
CustomEvent: RefUnwindSafe,
impl<CustomEvent> Send for Sequence<CustomEvent> where
CustomEvent: Send,
CustomEvent: Send,
impl<CustomEvent> Sync for Sequence<CustomEvent> where
CustomEvent: Sync,
CustomEvent: Sync,
impl<CustomEvent> Unpin for Sequence<CustomEvent> where
CustomEvent: Unpin,
CustomEvent: Unpin,
impl<CustomEvent> UnwindSafe for Sequence<CustomEvent> where
CustomEvent: UnwindSafe,
CustomEvent: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,