Struct sfml::audio::SoundBufferRecorder

pub struct SoundBufferRecorder { /* fields omitted */ }

Specialized SoundRecorder which stores the captured audio data into a sound buffer.

SoundBufferRecorder allows to access a recorded sound through a SoundBuffer, so that it can be played, saved to a file, etc.

As usual, don’t forget to call the is_available function before using this type (see SoundRecorder for more details about this).

Implementations

impl SoundBufferRecorder

#[must_use]pub fn new() -> SoundBufferRecorder

Create a new sound buffer recorder

pub fn start(&mut self, sample_rate: u32) -> bool

Start the capture of a sound buffer recorder

The sampleRate parameter defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality). This function uses its own thread so that it doesn’t block the rest of the program while the capture runs. Please note that only one capture can happen at the same time.

Arguments

• sample_rate - Desired capture rate, in number of samples per second

pub fn stop(&mut self)

Stop the capture of a sound recorder

#[must_use]pub fn sample_rate(&self) -> u32

Get the sample rate of a sound buffer recorder

The sample rate defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality).

Return the sample rate, in samples per second

#[must_use]pub fn buffer(&self) -> &SoundBuffer

Get the sound buffer containing the captured audio data

The sound buffer is valid only after the capture has ended. This function provides a read-only access to the internal sound buffer, but it can be copied if you need to make any modification to it.

Return Read-only access to the sound buffer

#[must_use]pub fn device(&self) -> String

Get the name of the current audio capture device.

pub fn set_device(&mut self, name: &str) -> Result<(), SetDeviceError>

Set the audio capture device.

This function sets the audio capture device to the device with the given name. It can be called on the fly (i.e: while recording). If you do so while recording and opening the device fails, it stops the recording.

Trait Implementations

impl Debug for SoundBufferRecorder

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

Formats the value using the given formatter.

impl Default for SoundBufferRecorder

fn default() -> Self

Returns the “default value” for a type.

impl Drop for SoundBufferRecorder

fn drop(&mut self)

Executes the destructor for this type.