1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

use crate::system::Vector3f;

/// Base trait defining a sound's properties.
pub trait SoundSource {
    /// Set the pitch of the sound.
    ///
    /// The pitch represents the perceived fundamental frequency of a sound;
    /// thus you can make a sound more acute or grave by changing its pitch.
    /// A side effect of changing the pitch is to modify the playing speed of the sound as well.
    /// The default value for the pitch is 1.
    ///
    /// # Parameters
    /// pitch - New pitch to apply to the sound
    fn set_pitch(&mut self, pitch: f32);

    /// Set the volume of the sound.
    ///
    /// The volume is a value between 0 (mute) and 100 (full volume).
    /// The default value for the volume is 100.
    ///
    /// # Parameters
    /// volume - Volume of the sound
    fn set_volume(&mut self, volume: f32);

    /// Set the 3D position of the sound in the audio scene.
    ///
    /// Only sounds with one channel (mono sounds) can be spatialized.
    /// The default position of a sound is (0, 0, 0).
    ///
    /// # Parameters
    /// position - Position of the sound in the scene
    fn set_position<P: Into<Vector3f>>(&mut self, position: P);

    /// Make the sound's position relative to the listener or absolute.
    ///
    /// Making a sound relative to the listener will ensure that it will always be played the
    /// same way regardless of the position of the listener. This can be useful for
    /// non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it.
    /// The default value is false (position is absolute).
    ///
    /// # Parameters
    /// relative - True to set the position relative, false to set it absolute
    fn set_relative_to_listener(&mut self, relative: bool);

    /// Set the minimum distance of the sound.
    ///
    /// The "minimum distance" of a sound is the maximum distance at which it is heard at its
    /// maximum volume. Further than the minimum distance, it will start to fade out according to
    /// its attenuation factor. A value of 0 ("inside the head of the listener") is an invalid
    /// value and is forbidden. The default value of the minimum distance is 1.
    ///
    /// # Parameters
    /// distance - New minimum distance of the sound
    fn set_min_distance(&mut self, distance: f32);

    /// Set the attenuation factor of the sound.
    ///
    /// The attenuation is a multiplicative factor which makes the sound more or less loud
    /// according to its distance from the listener. An attenuation of 0 will produce a
    /// non-attenuated sound, i.e. its volume will always be the same whether it is heard from
    /// near or from far. On the other hand, an attenuation value such as 100 will make the sound
    /// fade out very quickly as it gets further from the listener.
    /// The default value of the attenuation is 1.
    ///
    /// # Parameters
    /// attenuation - New attenuation factor of the sound
    fn set_attenuation(&mut self, attenuation: f32);

    /// Get the pitch of the sound.
    fn pitch(&self) -> f32;

    /// Get the volume of the sound.
    ///
    /// Returns the volume of the sound, in the range [0, 100]
    fn volume(&self) -> f32;

    /// Get the 3D position of the sound in the audio scene.
    fn position(&self) -> Vector3f;

    /// Tell whether the sound's position is relative to the listener or is absolute.
    fn is_relative_to_listener(&self) -> bool;

    /// Get the minimum distance of the sound.
    fn min_distance(&self) -> f32;

    /// Get the attenuation factor of the sound.
    fn attenuation(&self) -> f32;
}