[−][src]Struct tetra::audio::Sound
Sound data that can be played back.
Supports WAV, Ogg Vorbis, MP3 and FLAC (in other words, everything that Rodio provides support for).
All of the playback methods on this type return a SoundInstance
that
can be used to control the sound after it has started. If you just want
to 'fire and forget' a sound, you can discard it - the sound will
continue playing regardless.
This type acts as a lightweight handle to the associated audio data, and so can be cloned with little overhead.
Methods
impl Sound
[src]
pub fn new<P>(path: P) -> Result<Sound> where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
Creates a new sound from the given file.
Note that the data is not decoded until playback begins, so this function will not validate that the data being read is formatted correctly.
Errors
TetraError::FailedToLoadAsset
will be returned if the file could not be loaded.
pub fn from_file_data(data: &[u8]) -> Sound
[src]
Creates a new sound from a slice of binary data, encoded in one of Tetra's supported file formats.
This is useful in combination with include_bytes
, as it allows you to include
your audio data directly in the binary.
Note that the data is not decoded until playback begins, so this function will not validate that the data being read is formatted correctly.
pub fn play(&self, ctx: &Context) -> Result<SoundInstance>
[src]
Plays the sound.
Errors
TetraError::NoAudioDevice
will be returned if no audio device is active.TetraError::InvalidSound
will be returned if the sound data could not be decoded.
pub fn repeat(&self, ctx: &Context) -> Result<SoundInstance>
[src]
Plays the sound repeatedly.
Errors
TetraError::NoAudioDevice
will be returned if no audio device is active.TetraError::InvalidSound
will be returned if the sound data could not be decoded.
pub fn spawn(&self, ctx: &Context) -> Result<SoundInstance>
[src]
Spawns a new instance of the sound that is not playing yet.
Errors
TetraError::NoAudioDevice
will be returned if no audio device is active.TetraError::InvalidSound
will be returned if the sound data could not be decoded.
pub fn play_with(
&self,
ctx: &Context,
volume: f32,
speed: f32
) -> Result<SoundInstance>
[src]
&self,
ctx: &Context,
volume: f32,
speed: f32
) -> Result<SoundInstance>
Plays the sound, with the provided settings.
Errors
TetraError::NoAudioDevice
will be returned if no audio device is active.TetraError::InvalidSound
will be returned if the sound data could not be decoded.
pub fn repeat_with(
&self,
ctx: &Context,
volume: f32,
speed: f32
) -> Result<SoundInstance>
[src]
&self,
ctx: &Context,
volume: f32,
speed: f32
) -> Result<SoundInstance>
Plays the sound repeatedly, with the provided settings.
Errors
TetraError::NoAudioDevice
will be returned if no audio device is active.TetraError::InvalidSound
will be returned if the sound data could not be decoded.
pub fn spawn_with(
&self,
ctx: &Context,
volume: f32,
speed: f32
) -> Result<SoundInstance>
[src]
&self,
ctx: &Context,
volume: f32,
speed: f32
) -> Result<SoundInstance>
Spawns a new instance of the sound that is not playing yet, with the provided settings.
Errors
TetraError::NoAudioDevice
will be returned if no audio device is active.TetraError::InvalidSound
will be returned if the sound data could not be decoded.
Trait Implementations
impl Clone for Sound
[src]
impl Debug for Sound
[src]
impl PartialEq<Sound> for Sound
[src]
impl StructuralPartialEq for Sound
[src]
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SetParameter for T
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,