Struct kira::sound::Sound

pub struct Sound { /* fields omitted */ }

A piece of audio that can be played by an AudioManager.

Implementations

impl Sound

pub fn from_frames(
    sample_rate: u32,
    frames: Vec<Frame>,
    settings: SoundSettings
) -> Self

Creates a new sound from raw sample data.

pub fn from_mp3_file<P>(
    path: P,
    settings: SoundSettings
) -> Result<Self, SoundFromFileError> where
    P: AsRef<Path>, 

Decodes a sound from an mp3 file.

pub fn from_ogg_file<P>(
    path: P,
    settings: SoundSettings
) -> Result<Self, SoundFromFileError> where
    P: AsRef<Path>, 

Decodes a sound from an ogg file.

pub fn from_flac_file<P>(
    path: P,
    settings: SoundSettings
) -> Result<Self, SoundFromFileError> where
    P: AsRef<Path>, 

Decodes a sound from a flac file.

pub fn from_wav_file<P>(
    path: P,
    settings: SoundSettings
) -> Result<Self, SoundFromFileError> where
    P: AsRef<Path>, 

Decodes a sound from a wav file.

pub fn from_file<P>(
    path: P,
    settings: SoundSettings
) -> Result<Self, SoundFromFileError> where
    P: AsRef<Path>, 

Decodes a sound from a file.

The audio format will be automatically determined from the file extension.

pub fn id(&self) -> SoundId

Gets the unique identifier for this sound.

pub fn default_track(&self) -> TrackIndex

Gets the default track instances of this sound will play on.

pub fn groups(&self) -> &GroupSet

Gets the groups this sound belongs to.

pub fn duration(&self) -> f64

Gets the duration of the sound (in seconds).

pub fn semantic_duration(&self) -> Option<f64>

Gets the “musical length” of the sound (if there is one).

pub fn default_loop_start(&self) -> Option<f64>

Returns the default time (in seconds) instances of this sound will loop back to when they reach the end.

pub fn get_frame_at_position(&self, position: f64) -> Frame

Gets the frame of this sound at an arbitrary time in seconds, interpolating between samples if necessary.

Trait Implementations

impl Clone for Sound

fn clone(&self) -> Sound

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Sound

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

Formats the value using the given formatter.