Struct SoundSource 

pub struct SoundSource { /* private fields */ }

See module info.

Implementations

impl SoundSource

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

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 SPATIAL_BLEND: &'static str = "spatial_blend"

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

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

pub const BUS: &'static str = "bus"

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

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 SoundSource

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_spatial_blend(&mut self, k: f32)

Sets spatial blend factor. It defines how much the source will be 2D and 3D sound at the same time. Set it to 0.0 to make the sound fully 2D and 1.0 to make it fully 3D. Middle values will make sound proportionally 2D and 3D at the same time.

pub fn spatial_blend(&self) -> f32

Returns spatial blend factor.

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 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 76-80)

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

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

    engine.state().add_context(context.clone());

    // Load sound buffer.
    let drop_buffer = SoundBufferResource::new_generic(
        block_on(DataSource::from_file(
            "examples/data/drop.wav",
            // Load from the default resource io (File system)
            &FsResourceIo,
        ))
        .unwrap(),
    )
    .unwrap();

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

    // 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 {
        let axis = Vector3::y_axis();
        let rotation_matrix =
            UnitQuaternion::from_axis_angle(&axis, angle.to_radians()).to_homogeneous();
        context.state().source_mut(source_handle).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 102-106)

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

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

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

    engine.state().add_context(context.clone());

    // Set HRTF renderer instead of default.
    context
        .state()
        .set_renderer(Renderer::HrtfRenderer(HrtfRenderer::new(
            HrirSphereResource::from_hrir_sphere(hrir_sphere, hrir_path.into()),
        )));

    // Create some sounds.
    let sound_buffer = SoundBufferResource::new_generic(
        block_on(DataSource::from_file(
            "examples/data/door_open.wav", // Load from the default resource io (File system)
            &FsResourceIo,
        ))
        .unwrap(),
    )
    .unwrap();
    let source = SoundSourceBuilder::new()
        .with_buffer(sound_buffer)
        .with_status(Status::Playing)
        .build()
        .unwrap();
    context.state().add_source(source);

    let sound_buffer = SoundBufferResource::new_generic(
        block_on(DataSource::from_file(
            "examples/data/helicopter.wav", // Load from the default resource io (File system)
            &FsResourceIo,
        ))
        .unwrap(),
    )
    .unwrap();
    let source = SoundSourceBuilder::new()
        .with_buffer(sound_buffer)
        .with_status(Status::Playing)
        .with_looping(true)
        .build()
        .unwrap();
    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.
        {
            let axis = Vector3::y_axis();
            let rotation_matrix =
                UnitQuaternion::from_axis_angle(&axis, angle.to_radians()).to_homogeneous();
            context.state().source_mut(source_handle).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 115-119)

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

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

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

    engine.state().add_context(context.clone());

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

    {
        // Create reverb effect and set its decay time.
        let mut reverb = Reverb::new();
        reverb.set_decay_time(10.0);

        // Add the reverb to the primary bus.
        let mut state = context.state();
        state
            .bus_graph_mut()
            .primary_bus_mut()
            .add_effect(Effect::Reverb(reverb));
    }

    // Create some sounds.
    let sound_buffer = SoundBufferResource::new_generic(
        block_on(DataSource::from_file(
            "examples/data/door_open.wav", // Load from the default resource io (File system)
            &FsResourceIo,
        ))
        .unwrap(),
    )
    .unwrap();
    let source = SoundSourceBuilder::new()
        // Each sound must specify the bus to which it will output the samples. By default it is "Primary" bus.
        .with_bus("Primary")
        .with_buffer(sound_buffer)
        .with_status(Status::Playing)
        .build()
        .unwrap();
    context.state().add_source(source);

    let sound_buffer = SoundBufferResource::new_generic(
        block_on(DataSource::from_file(
            "examples/data/drop.wav",
            // Load from the default resource io (File system)
            &FsResourceIo,
        ))
        .unwrap(),
    )
    .unwrap();
    let source = SoundSourceBuilder::new()
        .with_buffer(sound_buffer)
        .with_status(Status::Playing)
        .with_looping(true)
        .build()
        .unwrap();
    let drop_sound_handle = 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() < 360 {
        let axis = Vector3::y_axis();
        let rotation_matrix =
            UnitQuaternion::from_axis_angle(&axis, angle.to_radians()).to_homogeneous();
        context.state().source_mut(drop_sound_handle).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 set_bus<S: AsRef<str>>(&mut self, bus: S)

Sets new name of the target audio bus. The name must be valid, otherwise the sound won’t play! Default is AudioBusGraph::PRIMARY_BUS.

pub fn bus(&self) -> &str

Return the name of the target audio bus.

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 SoundSource

fn clone(&self) -> SoundSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundSource

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

Formats the value using the given formatter.

impl Default for SoundSource

fn default() -> Self

Returns the “default value” for a type.

impl Drop for SoundSource

fn drop(&mut self)

Executes the destructor for this type.

impl Reflect for SoundSource

where Self: 'static, String: Reflect, f32: Reflect, f64: Reflect, bool: Reflect, Status: Reflect, Vector3<f32>: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<Self>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn fields(&self, func: &mut dyn FnMut(&[&dyn Reflect]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [&mut dyn Reflect]))

fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>))

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut dyn Reflect>), )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl Visit for SoundSource

where String: Visit, Option<SoundBufferResource>: Visit, f64: Visit, f32: Visit, bool: Visit, Status: Visit, Vector3<f32>: Visit,

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

Read or write this value, depending on whether Visitor::is_reading() is true or false.