Docs.rs
  • audio-processor-file-3.3.0
    • audio-processor-file 3.3.0
    • Permalink
    • Docs.rs crate page
    • MIT
    • Links
    • Homepage
    • Repository
    • crates.io
    • Source
    • Owners
    • yamadapc
    • Dependencies
      • audio-garbage-collector ^1.2.0 normal
      • audio-processor-traits ^4.3.0 normal
      • augmented-audio-metrics ^1.9.0 normal
      • augmented-convert-sample-rate ^1.8.0 normal optional
      • cpal ^0.15.2 normal
      • hound ^3.4.0 normal
      • log ^0.4.14 normal
      • rayon ^1.5.1 normal
      • rubato ^0.12.0 normal optional
      • samplerate ^0.2.4 normal optional
      • symphonia ^0.5.1 normal
      • symphonia-bundle-mp3 ^0.5.1 normal
      • symphonia-format-wav ^0.5.1 normal
      • thiserror ^1.0.30 normal
      • audio-processor-testing-helpers ^2.7.0 dev
      • tempdir ^0.3.7 dev
      • wisual-logger ^0.1.4 dev
    • Versions
    • 16.67% of the crate is documented
  • Platform
    • i686-pc-windows-msvc
    • x86_64-pc-windows-msvc
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate audio_processor_file

audio_processor_file3.3.0

  • All Items

Crate Items

  • Modules
  • Structs

Crates

  • audio_processor_file

Crate audio_processor_file

Source
Expand description

audio_processor_traits::AudioProcessor implementations for audio file playback & writing.

Currently two processors are provided:

  • AudioFileProcessor is an input file processor, its prepare method will load the whole file onto memory. Both wav and mp3 are supported via symphonia
    • If streaming is a requirement this won’t work
  • OutputAudioFileProcessor writes wav files

Modules§

file_io

Structs§

AudioFileProcessor
An audio processor which plays a file in loop
AudioFileProcessorHandle
InMemoryAudioFile
OutputAudioFileProcessor
OutputFileSettings

Results

Settings
Help
    struct
    audio_processor_file::AudioFileProcessor
    An audio processor which plays a file in loop
    struct
    audio_processor_file::AudioFileProcessorHandle
    struct
    audio_processor_file::OutputAudioFileProcessor
    method
    audio_processor_file::AudioFileProcessor::play
    &AudioFileProcessor -> ()
    Resume playback
    method
    audio_processor_file::AudioFileProcessor::stop
    &AudioFileProcessor -> ()
    Stop playback and go back to the start of the file
    method
    audio_processor_file::AudioFileProcessor::pause
    &AudioFileProcessor -> ()
    Pause playback
    method
    audio_processor_file::AudioFileProcessor::is_playing
    &AudioFileProcessor -> bool
    Whether the file is being played back
    method
    audio_processor_file::AudioFileProcessor::num_samples
    &AudioFileProcessor -> usize
    Unsafe get buffer for offline rendering
    method
    audio_processor_file::AudioFileProcessor::handle
    &AudioFileProcessor -> &Shared<AudioFileProcessorHandle>
    method
    audio_processor_file::AudioFileProcessor::process_single
    &AudioFileProcessor -> <Iterator<Item=f32>>
    method
    audio_processor_file::AudioFileProcessor::buffer
    &AudioFileProcessor -> &Vec<Vec<f32>>
    Unsafe get buffer for offline rendering
    method
    audio_processor_file::AudioFileProcessor::prepare
    &mut AudioFileProcessor, &mut AudioContext -> ()
    Prepares for playback
    method
    audio_processor_file::AudioFileProcessor::process
    &mut AudioFileProcessor, &mut AudioContext, &mut AudioBuffer<AudioProcessor::SampleType> -> ()
    method
    audio_processor_file::AudioFileProcessor::new
    &Handle, InMemoryAudioFile, AudioProcessorSettings -> AudioFileProcessor
    method
    audio_processor_file::AudioFileProcessor::from_path
    &Handle, AudioProcessorSettings, &str -> Result<AudioFileProcessor, AudioFileError>