Struct tetra::audio::Sound [−][src]
pub struct Sound { /* fields omitted */ }
Expand description
Sound data that can be played back.
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.
Supported Formats
Various file formats are supported, and can be enabled or disabled via Cargo features:
Format | Cargo feature | Enabled by default? |
---|---|---|
WAV | audio_wav | Yes |
OGG Vorbis | audio_vorbis | Yes |
MP3 | audio_mp3 | Yes |
FLAC | audio_flac | No |
Performance
When you create an instance of Sound
, the audio data is loaded into memory. It is not
decoded until playback begins.
You can clone a sound cheaply, as it is reference-counted
internally. The underlying data will be shared by all of the clones (and, by extension,
all of the SoundInstance
s created from them).
Examples
The audio
example demonstrates how to play several different kinds of sound.
Implementations
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.
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.
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.
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.
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.
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.
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.
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
Auto Trait Implementations
impl RefUnwindSafe for Sound
impl UnwindSafe for Sound
Blanket Implementations
Mutably borrows from an owned value. Read more