Struct StaticSoundData

pub struct StaticSoundData {
    pub sample_rate: u32,
    pub frames: Arc<[Frame]>,
    pub settings: StaticSoundSettings,
}

A piece of audio loaded into memory all at once.

These can be cheaply cloned, as the audio data is shared among all clones.

Fields

sample_rate: u32

The sample rate of the audio (in Hz).

frames: Arc<[Frame]>

The raw samples that make up the audio.

settings: StaticSoundSettings

Settings for the sound.

Implementations

impl StaticSoundData

pub fn from_file( path: impl AsRef<Path>, settings: StaticSoundSettings, ) -> Result<StaticSoundData, FromFileError>

Loads an audio file into a StaticSoundData.

pub fn from_cursor<T>( cursor: Cursor<T>, settings: StaticSoundSettings, ) -> Result<StaticSoundData, FromFileError>

where T: AsRef<[u8]> + Send + Sync + 'static,

Loads a cursor wrapping audio file data into a StaticSoundData.

pub fn from_media_source( media_source: impl MediaSource + 'static, settings: StaticSoundSettings, ) -> Result<StaticSoundData, FromFileError>

Loads an audio file from a type that implements Symphonia’s MediaSource trait.

impl StaticSoundData

pub fn duration(&self) -> Duration

Returns the duration of the audio.

pub fn with_settings(&self, settings: StaticSoundSettings) -> StaticSoundData

Returns a clone of the StaticSoundData with the specified settings.

pub fn with_modified_settings( &self, f: impl FnOnce(StaticSoundSettings) -> StaticSoundSettings, ) -> StaticSoundData

Returns a clone of the StaticSoundData with the modified settings from the given function.

Trait Implementations

impl Clone for StaticSoundData

fn clone(&self) -> StaticSoundData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StaticSoundData

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

Formats the value using the given formatter.

impl PartialEq for StaticSoundData

fn eq(&self, other: &StaticSoundData) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SoundData for StaticSoundData

type Error = ()

Errors that can occur when starting the sound.

type Handle = StaticSoundHandle

The type that can be used to control the sound once it has started.

fn into_sound( self, ) -> Result<(Box<dyn Sound>, <StaticSoundData as SoundData>::Handle), <StaticSoundData as SoundData>::Error>

Converts the loaded sound into a live, playing sound and a handle to control it.

impl StructuralPartialEq for StaticSoundData