Struct PreloadedFileSource 

pub struct PreloadedFileSource { /* private fields */ }

A buffered, clonable FileSource, which decodes the entire file into a buffer before its played back.

Buffers of preloaded file sources are shared (wrapped in an Arc), so cloning a source is very cheap as this only copies a buffer reference and not the buffer itself. This way a file can be pre-loaded once and can then be cloned and reused as often as necessary.

Implementations

impl PreloadedFileSource

pub fn from_file<P: AsRef<Path>>( path: P, options: FilePlaybackOptions, output_sample_rate: u32, ) -> Result<Self, Error>

Create a new preloaded file source with the given audio file path.

pub fn from_file_buffer( file_buffer: Vec<u8>, file_path: &str, options: FilePlaybackOptions, output_sample_rate: u32, ) -> Result<Self, Error>

Create a new preloaded file source with the given raw encoded file stream buffer.

pub fn from_shared_buffer( file_buffer: Arc<AudioFileBuffer>, file_path: &str, options: FilePlaybackOptions, output_sample_rate: u32, ) -> Result<Self, Error>

Create a new preloaded file source from the given shared, decoded file buffer.

pub fn clone( &self, options: FilePlaybackOptions, output_sample_rate: u32, ) -> Result<Self, Error>

Create a copy of this preloaded source with the given playback options.

pub fn file_buffer(&self) -> Arc<AudioFileBuffer>

Access to the shared file buffer.

pub fn seek(&mut self, position: Duration)

Set a new playback position for this source.

pub fn loop_range(&self) -> Option<Range<u64>>

Returns the active loop range in sample frames: the override if set, else the file’s embedded loop range. Returns None when neither is set.

pub fn set_loop_range(&mut self, range: Option<Range<u64>>)

Override the file’s embedded loop range with a custom one. Pass None to revert to the file’s embedded loop range.

pub fn set_repeat(&mut self, repeat_count: usize)

Override the file’s playback option repeat settings with the given ones. Set to 0 to disable looping, usize::MAX to repeat forever.

pub fn set_speed(&mut self, speed: f64, glide: Option<f32>)

Set the playback speed (pitch) for this source.

pub fn stop(&mut self)

Stop the file source, starting to fade-out, when a fadeout is set, stop immediately.

pub fn reset(&mut self)

Reset the file to start playback from the beginning.

pub fn kill(&mut self)

Abruptly stop the source without applying fade-outs

Trait Implementations

impl FileSource for PreloadedFileSource

fn file_name(&self) -> String

Name or path of the file for display or debugging purposes.

fn playback_id(&self) -> PlaybackId

A unique ID, which can be used to identify sources in PlaybackStatusEvents.

fn playback_options(&self) -> &FilePlaybackOptions

The file source’s playback options

fn playback_message_queue(&self) -> Arc<ArrayQueue<FilePlaybackMessage>>

Message queue to control file playback.

fn playback_status_sender(&self) -> Option<SyncSender<PlaybackStatusEvent>>

Channel to receive playback status from the file.

fn set_playback_status_sender( &mut self, sender: Option<SyncSender<PlaybackStatusEvent>>, )

fn playback_status_context(&self) -> Option<PlaybackStatusContext>

Optional context passed along with the playback status.

fn set_playback_status_context( &mut self, context: Option<PlaybackStatusContext>, )

fn total_frames(&self) -> Option<u64>

Total number of sample frames in the decoded file: may not be known before playback finished.

fn current_frame_position(&self) -> u64

Current playback pos in frames

fn end_of_track(&self) -> bool

True when the source played through the entire file, else false.

impl Source for PreloadedFileSource

fn channel_count(&self) -> usize

The source’s output channel count.

fn sample_rate(&self) -> u32

The source’s output sample rate.

fn is_exhausted(&self) -> bool

Returns whether the source finished playback. Exhausted sources should only return 0 on write and may be removed from a source render graph.

fn weight(&self) -> usize

Return a rough estimate of the processing costs for this source in range ~1..10, where 1 means pretty lightweight and 10 very CPU intensive. This is used in parallel processing to distribute work loads evenly before or without actual CPU measurements.

fn write(&mut self, output: &mut [f32], time: &SourceTime) -> usize

Write at most output.len() samples into the interleaved output The given SourceTime parameter specifies which absolute time this buffer in the final output stream refers to. It can be used to schedule and apply real-time events. Returns the number of written samples (not frames).

fn into_box(self) -> Box<dyn Source>

where Self: Sized,

Convert the Source impl into a boxed dyn Source.