SoundBufferRecorder¶

Functions

sfSoundBufferRecorder *sfSoundBufferRecorder_create(void)¶

Create a new sound buffer recorder.

Returns:: A new sfSoundBufferRecorder object (NULL if failed)

void sfSoundBufferRecorder_destroy(const sfSoundBufferRecorder *soundBufferRecorder)¶

Destroy a sound buffer recorder.

Parameters:

soundBufferRecorder – Sound buffer recorder to destroy

bool sfSoundBufferRecorder_start(sfSoundBufferRecorder *soundBufferRecorder, unsigned int sampleRate)¶

Start the capture of a sound recorder 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.

Parameters:

soundBufferRecorder – Sound buffer recorder object
sampleRate – Desired capture rate, in number of samples per second

Returns:

true, if it was able to start recording

void sfSoundBufferRecorder_stop(sfSoundBufferRecorder *soundBufferRecorder)¶

Stop the capture of a sound recorder.

Parameters:

soundBufferRecorder – Sound buffer recorder object

unsigned int sfSoundBufferRecorder_getSampleRate(const sfSoundBufferRecorder *soundBufferRecorder)¶

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).

Parameters:

soundBufferRecorder – Sound buffer recorder object

Returns:

Sample rate, in samples per second

const sfSoundBuffer *sfSoundBufferRecorder_getBuffer(const sfSoundBufferRecorder *soundBufferRecorder)¶

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.

Parameters:

soundBufferRecorder – Sound buffer recorder object

Returns:

Read-only access to the sound buffer

bool sfSoundBufferRecorder_setDevice(sfSoundBufferRecorder *soundBufferRecorder, const char *name)¶

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.

Parameters:

soundBufferRecorder – Sound buffer recorder object
name – The name of the audio capture device

Returns:

true, if it was able to set the requested device

const char *sfSoundBufferRecorder_getDevice(sfSoundBufferRecorder *soundBufferRecorder)¶

Get the name of the current audio capture device.

Parameters:

soundBufferRecorder – Sound buffer recorder object

Returns:

The name of the current audio capture device

void sfSoundBufferRecorder_setChannelCount(sfSoundBufferRecorder *soundBufferRecorder, unsigned int channelCount)¶

Set the channel count of the audio capture device.

This method allows you to specify the number of channels used for recording. Currently only 16-bit mono and 16-bit stereo are supported.