Struct SpatialSource 

pub struct SpatialSource { /* private fields */ }

See module docs.

Implementations

impl SpatialSource

Property key constants

pub const GENERIC: &'static str = "generic"

pub const RADIUS: &'static str = "radius"

pub const POSITION: &'static str = "position"

pub const MAX_DISTANCE: &'static str = "max_distance"

pub const ROLLOFF_FACTOR: &'static str = "rolloff_factor"

impl SpatialSource

pub fn set_position(&mut self, position: Vector3<f32>) -> &mut Self

Sets position of source in world space.

Examples found in repository

examples/play_spatial_sound.rs (lines 53-57)

fn main() {
    // Initialize sound engine with default output device.
    let engine = SoundEngine::new();

    // Initialize new sound context.
    let context = SoundContext::new();

    engine.lock().unwrap().add_context(context.clone());

    // Load sound buffer.
    let drop_buffer = SoundBufferResource::new_generic(
        block_on(DataSource::from_file("examples/data/drop.wav")).unwrap(),
    )
    .unwrap();

    // Create spatial source - spatial sources can be positioned in space.
    let source = SpatialSourceBuilder::new(
        GenericSourceBuilder::new()
            .with_buffer(drop_buffer)
            .with_looping(true)
            .with_status(Status::Playing)
            .build()
            .unwrap(),
    )
    .build_source();

    // Each sound sound must be added to context, context takes ownership on source
    // and returns pool handle to it by which it can be accessed later on if needed.
    let source_handle: Handle<SoundSource> = context.state().add_source(source);

    // Move sound around listener for some time.
    let start_time = time::Instant::now();
    let mut angle = 0.0f32;
    while (time::Instant::now() - start_time).as_secs() < 11 {
        if let SoundSource::Spatial(spatial) = context.state().source_mut(source_handle) {
            let axis = Vector3::y_axis();
            let rotation_matrix =
                UnitQuaternion::from_axis_angle(&axis, angle.to_radians()).to_homogeneous();
            spatial.set_position(
                rotation_matrix
                    .transform_point(&Point3::new(0.0, 0.0, 3.0))
                    .coords,
            );
        }
        angle += 3.6;

        // Limit rate of updates.
        thread::sleep(Duration::from_millis(100));
    }
}

examples/hrtf.rs (lines 75-79)

fn main() {
    // Initialize sound engine with default output device.
    let engine = SoundEngine::new();

    let hrir_sphere =
        HrirSphere::from_file("examples/data/IRC_1002_C.bin", context::SAMPLE_RATE).unwrap();

    // Initialize new sound context with default output device.
    let context = SoundContext::new();

    engine.lock().unwrap().add_context(context.clone());

    // Set HRTF renderer instead of default.
    context
        .state()
        .set_renderer(Renderer::HrtfRenderer(HrtfRenderer::new(hrir_sphere)));

    // Create some sounds.
    let sound_buffer = SoundBufferResource::new_generic(
        block_on(DataSource::from_file("examples/data/door_open.wav")).unwrap(),
    )
    .unwrap();
    let source = SpatialSourceBuilder::new(
        GenericSourceBuilder::new()
            .with_buffer(sound_buffer)
            .with_status(Status::Playing)
            .build()
            .unwrap(),
    )
    .build_source();
    context.state().add_source(source);

    let sound_buffer = SoundBufferResource::new_generic(
        block_on(DataSource::from_file("examples/data/helicopter.wav")).unwrap(),
    )
    .unwrap();
    let source = SpatialSourceBuilder::new(
        GenericSourceBuilder::new()
            .with_buffer(sound_buffer)
            .with_status(Status::Playing)
            .with_looping(true)
            .build()
            .unwrap(),
    )
    .build_source();
    let source_handle = context.state().add_source(source);

    // Move source sound around listener for some time.
    let start_time = time::Instant::now();
    let mut angle = 0.0f32;
    while (time::Instant::now() - start_time).as_secs() < 360 {
        // Separate scope for update to make sure that mutex lock will be released before
        // thread::sleep will be called so context can actually work in background thread.
        {
            if let SoundSource::Spatial(spatial) = context.state().source_mut(source_handle) {
                let axis = Vector3::y_axis();
                let rotation_matrix =
                    UnitQuaternion::from_axis_angle(&axis, angle.to_radians()).to_homogeneous();
                spatial.set_position(
                    rotation_matrix
                        .transform_point(&Point3::new(0.0, 0.0, 3.0))
                        .coords,
                );
            }

            angle += 1.6;

            println!(
                "Sound render time {:?}",
                context.state().full_render_duration()
            );
        }

        // Limit rate of updates.
        thread::sleep(Duration::from_millis(100));
    }
}

examples/reverb.rs (lines 91-95)

fn main() {
    let hrir_sphere =
        HrirSphere::from_file("examples/data/IRC_1002_C.bin", context::SAMPLE_RATE).unwrap();

    // Initialize sound engine with default output device.
    let engine = SoundEngine::new();

    // Initialize new sound context.
    let context = SoundContext::new();

    engine.lock().unwrap().add_context(context.clone());

    // Set HRTF renderer instead of default for binaural sound.
    context
        .state()
        .set_renderer(Renderer::HrtfRenderer(HrtfRenderer::new(hrir_sphere)));

    let base_effect = BaseEffect::default();

    // Create reverb effect and set its decay time.
    let mut reverb = Reverb::new(base_effect);
    reverb.set_decay_time(Duration::from_secs_f32(10.0));
    let reverb_handle = context.state().add_effect(Effect::Reverb(reverb));

    // Create some sounds.
    let sound_buffer = SoundBufferResource::new_generic(
        block_on(DataSource::from_file("examples/data/door_open.wav")).unwrap(),
    )
    .unwrap();
    let source = SpatialSourceBuilder::new(
        GenericSourceBuilder::new()
            .with_buffer(sound_buffer)
            .with_status(Status::Playing)
            .build()
            .unwrap(),
    )
    .build_source();
    let door_sound = context.state().add_source(source);

    // Each sound source must be attached to effect, otherwise sound won't be passed to effect
    // and you'll hear sound without any difference.
    context
        .state()
        .effect_mut(reverb_handle)
        .add_input(EffectInput::direct(door_sound));

    let sound_buffer = SoundBufferResource::new_generic(
        block_on(DataSource::from_file("examples/data/drop.wav")).unwrap(),
    )
    .unwrap();
    let source = SpatialSourceBuilder::new(
        GenericSourceBuilder::new()
            .with_buffer(sound_buffer)
            .with_status(Status::Playing)
            .with_looping(true)
            .build()
            .unwrap(),
    )
    .build_source();
    let drop_sound_handle = context.state().add_source(source);

    context
        .state()
        .effect_mut(reverb_handle)
        .add_input(EffectInput::direct(drop_sound_handle));

    // Move sound around listener for some time.
    let start_time = time::Instant::now();
    let mut angle = 0.0f32;
    while (time::Instant::now() - start_time).as_secs() < 360 {
        if let SoundSource::Spatial(sound) = context.state().source_mut(drop_sound_handle) {
            let axis = Vector3::y_axis();
            let rotation_matrix =
                UnitQuaternion::from_axis_angle(&axis, angle.to_radians()).to_homogeneous();
            sound.set_position(
                rotation_matrix
                    .transform_point(&Point3::new(0.0, 0.0, 1.0))
                    .coords,
            );
        }

        angle += 1.6;

        println!(
            "Sound render time {:?}",
            context.state().full_render_duration()
        );

        // Limit rate of context updates.
        thread::sleep(Duration::from_millis(100));
    }
}

pub fn position(&self) -> Vector3<f32>

Returns positions of source.

pub fn set_radius(&mut self, radius: f32) -> &mut Self

Sets radius of imaginable sphere around source in which no distance attenuation is applied.

pub fn radius(&self) -> f32

Returns radius of source.

pub fn set_rolloff_factor(&mut self, rolloff_factor: f32) -> &mut Self

Sets rolloff factor. Rolloff factor is used in distance attenuation and has different meaning in various distance models. It is applicable only for InverseDistance and ExponentDistance distance models. See DistanceModel docs for formulae.

pub fn rolloff_factor(&self) -> f32

Returns rolloff factor.

pub fn set_max_distance(&mut self, max_distance: f32) -> &mut Self

Sets maximum distance until which distance gain will be applicable. Basically it doing this min(max(distance, radius), max_distance) which clamps distance in radius..max_distance range. From listener’s perspective this will sound like source has stopped decreasing its volume even if distance continue to grow.

pub fn max_distance(&self) -> f32

Returns max distance.

pub fn generic(&self) -> &GenericSource

Returns shared reference to inner generic source.

pub fn generic_mut(&mut self) -> &mut GenericSource

Returns mutable reference to inner generic source.

Methods from Deref<Target = GenericSource>

pub const NAME: &'static str = "name"

pub const BUFFER: &'static str = "buffer"

pub const PANNING: &'static str = "panning"

pub const PITCH: &'static str = "pitch"

pub const GAIN: &'static str = "gain"

pub const LOOPING: &'static str = "looping"

pub const RESAMPLING_MULTIPLIER: &'static str = "resampling_multiplier"

pub const STATUS: &'static str = "status"

pub const PLAY_ONCE: &'static str = "play_once"

pub fn set_name<N: AsRef<str>>(&mut self, name: N)

Sets new name of the sound source.

pub fn name(&self) -> &str

Returns the name of the sound source.

pub fn name_owned(&self) -> String

Returns the name of the sound source.

pub fn set_buffer( &mut self, buffer: Option<SoundBufferResource>, ) -> Result<Option<SoundBufferResource>, SoundError>

Changes buffer of source. Returns old buffer. Source will continue playing from beginning, old position will be discarded.

pub fn buffer(&self) -> Option<SoundBufferResource>

Returns current buffer if any.

pub fn set_play_once(&mut self, play_once: bool)

Marks buffer for single play. It will be automatically destroyed when it will finish playing.

Notes

Make sure you not using handles to “play once” sounds, attempt to get reference of “play once” sound may result in panic if source already deleted. Looping sources will never be automatically deleted because their playback never stops.

pub fn is_play_once(&self) -> bool

Returns true if this source is marked for single play, false - otherwise.

pub fn set_gain(&mut self, gain: f32) -> &mut Self

Sets new gain (volume) of sound. Value should be in 0..1 range, but it is not clamped and larger values can be used to “overdrive” sound.

Notes

Physical volume has non-linear scale (logarithmic) so perception of sound at 0.25 gain will be different if logarithmic scale was used.

pub fn gain(&self) -> f32

Returns current gain (volume) of sound. Value is in 0..1 range.

pub fn set_panning(&mut self, panning: f32) -> &mut Self

Sets panning coefficient. Value must be in -1..+1 range. Where -1 - only left channel will be audible, 0 - both, +1 - only right.

pub fn panning(&self) -> f32

Returns current panning coefficient in -1..+1 range. For more info see set_panning. Default value is 0.

pub fn status(&self) -> Status

Returns status of sound source.

pub fn play(&mut self) -> &mut Self

Changes status to Playing.

pub fn pause(&mut self) -> &mut Self

Changes status to Paused

pub fn set_looping(&mut self, looping: bool) -> &mut Self

Enabled or disables sound looping. Looping sound will never stop by itself, but can be stopped or paused by calling stop or pause methods. Useful for music, ambient sounds, etc.

pub fn is_looping(&self) -> bool

Returns looping status.

pub fn set_pitch(&mut self, pitch: f64) -> &mut Self

Sets sound pitch. Defines “tone” of sounds. Default value is 1.0

pub fn pitch(&self) -> f64

Returns pitch of sound source.

pub fn stop(&mut self) -> Result<(), SoundError>

Stops sound source. Automatically rewinds streaming buffers.

pub fn playback_time(&self) -> Duration

Returns playback duration.

pub fn set_playback_time(&mut self, time: Duration)

Sets playback duration.

Trait Implementations

impl Clone for SpatialSource

fn clone(&self) -> SpatialSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpatialSource

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

Formats the value using the given formatter.

impl Default for SpatialSource

fn default() -> Self

Returns the “default value” for a type.

impl Deref for SpatialSource

type Target = GenericSource

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for SpatialSource

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Inspect for SpatialSource

fn properties(&self) -> Vec<PropertyInfo<'_>>

Returns information about “public” properties.

impl Visit for SpatialSource

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult