sound_stream 0.6.0

Provides a simple interface to the default audio input and output device streams on a user's system.
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


pub type SampleHz = u32;
pub type Frames = u16;
pub type Channels = u16;

/// Settings required for SoundStream.
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct Settings {
    /// The number of samples per second.
    pub sample_hz: SampleHz,
    /// How many samples per channel requested at a time in the buffer.
    /// The more frames, the less likely to make glitches,
    /// but this gives slower response.
    pub frames: Frames,
    /// Number of channels, for example 2 for stereo sound (left + right speaker).
    pub channels: Channels,
}

impl Settings {

    /// Custom constructor for the Settings.
    pub fn new(sample_hz: SampleHz, frames: Frames, channels: Channels) -> Settings {
        Settings {
            sample_hz: sample_hz,
            frames: frames,
            channels: channels
        }
    }

    /// Default, standard constructor for Settings.
    pub fn cd_quality() -> Settings {
        Settings {
            sample_hz: 44100,
            frames: 256,
            channels: 2
        }
    }

    /// Return the length of a SoundBuffer that would use Settings.
    pub fn buffer_size(&self) -> usize {
        self.frames as usize * self.channels as usize
    }

}

impl ::std::default::Default for Settings {
    fn default() -> Settings { Settings::cd_quality() }
}