Struct let_engine::resources::sounds::Sound

source · 
pub struct Sound { /* private fields */ }
Expand description

A playable sound.

You can bind an object to this sound making it directional.

Implementations§

source§

impl Sound

source

pub fn new(data: SoundData, settings: SoundSettings) -> Self

Makes a new sound with the given settings and data.

source

pub fn set_settings(&mut self, settings: SoundSettings)

Sets the settings of this sound.

source

pub fn settings(&self) -> SoundSettings

Returns the settings of this sounds.

source

pub fn set_spatial_settings(&mut self, settings: SpatialSettings)

Sets the spatial settings of this sound.

Spatial settings are applied with the play function.

source

pub fn spatial_settings(&self) -> SpatialSettings

Returns the spatial settings of this sounds.

source

pub fn data(&self) -> &SoundData

Returns the data behind the sound.

source

pub fn state(&self) -> PlaybackState

Returns the current playback state of the sound.

source

pub fn position(&self) -> f64

Returns the playback position in seconds.

source

pub fn set_volume( &mut self, volume: impl Into<Volume>, tween: Tween ) -> Result<()>

Sets the volume of the sound.

Returns an error in case the command queue is full.

source

pub fn set_playback_rate( &mut self, playback_rate: impl Into<PlaybackRate>, tween: Tween ) -> Result<()>

Sets the rate, at which the sound is getting played.

Returns an error in case the command queue is full.

source

pub fn set_panning(&mut self, panning: f64, tween: Tween) -> Result<()>

Sets the panning of the sound, where 0.0 is left and 1.0 is right.

Returns an error in case the command queue is full.

source

pub fn set_playback_region( &mut self, playback_region: impl Into<Region> ) -> Result<()>

Sets the region, where the sound is getting played.

Returns an error in case the command queue is full.

source

pub fn set_loop_region( &mut self, loop_region: impl IntoOptionalRegion ) -> Result<()>

Sets the optional region, where the sound is getting looped.

Returns an error in case the command queue is full.

source

pub fn bind_to_object(&mut self, object: Option<&Object>)

Binds an object to this sound and plays it where this object is located at.

source

pub fn object(&self) -> Option<&Object>

Returns the object bound to this sound.

source

pub fn update(&mut self, tween: Tween) -> Result<()>

Updates the position of the sound.

Returns an error in case the command queue is full.

source

pub fn play(&mut self) -> Result<()>

Plays this sound.

source

pub fn pause(&mut self, tween: Tween) -> Result<()>

Pauses this sound.

Returns an error in case the command queue is full.

source

pub fn resume(&mut self, tween: Tween) -> Result<()>

Resumes the playback of this sound.

Returns an error in case the command queue is full.

source

pub fn stop(&mut self, tween: Tween) -> Result<()>

Stops this sound.

Returns an error in case the command queue is full.

source

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

Sets the playhead to the given position in seconds.

Returns an error in case the command queue is full.

source

pub fn seek_by(&mut self, position: f64) -> Result<()>

Sets the playhead ahead by the given seconds.

Returns an error in case the command queue is full.

Trait Implementations§

source§

impl Clone for Sound

source§

fn clone(&self) -> Sound

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Sound

§

impl Send for Sound

§

impl Sync for Sound

§

impl Unpin for Sound

§

impl !UnwindSafe for Sound

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn 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.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

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.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,