Struct kira::instance::handle::InstanceHandle[−][src]

pub struct InstanceHandle { /* fields omitted */ }
Expand description

Allows you to control an instance of a sound or arrangement.

Implementations

impl InstanceHandle[src]

pub fn id(&self) -> InstanceId[src]

Returns the ID of the instance.

pub fn state(&self) -> InstanceState[src]

Returns the playback state of the instance.

pub fn position(&self) -> f64[src]

Returns the playback position of the instance.

pub fn set_volume(
    &mut self,
    volume: impl Into<Value<f64>>
) -> Result<(), CommandError>[src]

Sets the volume of the instance.

pub fn set_playback_rate(
    &mut self,
    playback_rate: impl Into<Value<f64>>
) -> Result<(), CommandError>[src]

Sets the playback rate of the instance.

pub fn set_panning(
    &mut self,
    panning: impl Into<Value<f64>>
) -> Result<(), CommandError>[src]

Sets the panning of the instance.

pub fn seek(&mut self, offset: f64) -> Result<(), CommandError>[src]

Offsets the playback position of the instance by the specified amount (in seconds).

pub fn seek_to(&mut self, position: f64) -> Result<(), CommandError>[src]

Sets the playback position of the instance to the specified time (in seconds).

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

Pauses the instance.

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

Resumes the instance.

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

Stops the instance.

Trait Implementations

impl Clone for InstanceHandle[src]

fn clone(&self) -> InstanceHandle[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for InstanceHandle[src]

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

Formats the value using the given formatter. Read more

impl From<&'_ InstanceHandle> for InstanceId[src]

fn from(handle: &InstanceHandle) -> Self[src]

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

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]

🔬 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<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V