Struct kira::arrangement::handle::ArrangementHandle

pub struct ArrangementHandle { /* fields omitted */ }

Allows you to control an arrangement.

Implementations

impl ArrangementHandle

pub fn id(&self) -> ArrangementId

Returns the ID of the arrangement.

pub fn duration(&self) -> f64

Returns the duration of the arrangement (in seconds).

pub fn default_track(&self) -> TrackIndex

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

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

Returns the “musical length” of this 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.

pub fn play(
    &mut self,
    settings: InstanceSettings
) -> Result<InstanceHandle, CommandError>

Plays the arrangement.

pub fn pause(
    &mut self,
    settings: PauseInstanceSettings
) -> Result<(), CommandError>

Pauses all instances of this arrangement.

pub fn resume(
    &mut self,
    settings: ResumeInstanceSettings
) -> Result<(), CommandError>

Resumes all instances of this arrangement.

pub fn stop(
    &mut self,
    settings: StopInstanceSettings
) -> Result<(), CommandError>

Stops all instances of this arrangement.

Trait Implementations

impl Clone for ArrangementHandle

fn clone(&self) -> ArrangementHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArrangementHandle

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

Formats the value using the given formatter.

impl From<&'_ ArrangementHandle> for ArrangementId

fn from(handle: &ArrangementHandle) -> Self

Performs the conversion.

impl From<&'_ ArrangementHandle> for PlayableId

fn from(handle: &ArrangementHandle) -> Self

Performs the conversion.