Struct ears::ReverbEffect

pub struct ReverbEffect { /* fields omitted */ }

Create and configure reverb effects.

A Sound can optionally be connected to a ReverbEffect, which can modify how the user hears the Sound (through reverb, echo, frequency shift, etc)

This can be used to model the environment that the listener is in, for example a cave.

Internally it creates an OpenAL Effect Object with an Auxiliary Effect Slot Object pair.

Note: the effects API may change as it's implemented fully, but I'll try not to make the changes too drastic.

Examples

extern crate ears;
use ears::{ReverbEffect, ReverbPreset, Sound, AudioController};

fn main() -> () {
   // Create an effect (in this case, using a preset)
   let effect = ReverbEffect::preset(ReverbPreset::Cave.properties()).ok();

   // Create a Sound with the path of the sound file.
   let mut sound = Sound::new("path/to/my/sound.ogg").unwrap();

   // Connect the sound to the effect
   sound.connect(&effect);

   // Play it
   sound.play();

   // Wait until the sound stopped playing
   while sound.is_playing() {}

   // If you want to disconnect an Effect, just pass None
   sound.connect(&None);
}

Methods

impl ReverbEffect

pub fn new() -> Result<ReverbEffect, String>

pub fn preset(
    reverb_properties: ReverbProperties
) -> Result<ReverbEffect, String>

pub fn slot(&self) -> u32

Trait Implementations

impl Drop for ReverbEffect

fn drop(&mut self)

Executes the destructor for this type.