Functions
SoundBufferRecorder.h File Reference
#include <SFML/Audio/Export.h>
#include <SFML/Audio/Types.h>

Go to the source code of this file.

Functions

CSFML_AUDIO_API sfSoundBufferRecordersfSoundBufferRecorder_create (void)
 Create a new sound buffer recorder. More...
 
CSFML_AUDIO_API void sfSoundBufferRecorder_destroy (sfSoundBufferRecorder *soundBufferRecorder)
 Destroy a sound buffer recorder. More...
 
CSFML_AUDIO_API sfBool sfSoundBufferRecorder_start (sfSoundBufferRecorder *soundBufferRecorder, unsigned int sampleRate)
 Start the capture of a sound recorder recorder. More...
 
CSFML_AUDIO_API void sfSoundBufferRecorder_stop (sfSoundBufferRecorder *soundBufferRecorder)
 Stop the capture of a sound recorder. More...
 
CSFML_AUDIO_API unsigned int sfSoundBufferRecorder_getSampleRate (const sfSoundBufferRecorder *soundBufferRecorder)
 Get the sample rate of a sound buffer recorder. More...
 
CSFML_AUDIO_API const sfSoundBuffersfSoundBufferRecorder_getBuffer (const sfSoundBufferRecorder *soundBufferRecorder)
 Get the sound buffer containing the captured audio data. More...
 
CSFML_AUDIO_API sfBool sfSoundBufferRecorder_setDevice (sfSoundBufferRecorder *soundBufferRecorder, const char *name)
 Set the audio capture device. More...
 
CSFML_AUDIO_API const char * sfSoundBufferRecorder_getDevice (sfSoundBufferRecorder *soundBufferRecorder)
 Get the name of the current audio capture device. More...
 

Function Documentation

◆ sfSoundBufferRecorder_create()

CSFML_AUDIO_API sfSoundBufferRecorder* sfSoundBufferRecorder_create ( void  )

Create a new sound buffer recorder.

Returns
A new sfSoundBufferRecorder object (NULL if failed)

◆ sfSoundBufferRecorder_destroy()

CSFML_AUDIO_API void sfSoundBufferRecorder_destroy ( sfSoundBufferRecorder soundBufferRecorder)

Destroy a sound buffer recorder.

Parameters
soundBufferRecorderSound buffer recorder to destroy

◆ sfSoundBufferRecorder_getBuffer()

CSFML_AUDIO_API 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
soundBufferRecorderSound buffer recorder object
Returns
Read-only access to the sound buffer

◆ sfSoundBufferRecorder_getDevice()

CSFML_AUDIO_API const char* sfSoundBufferRecorder_getDevice ( sfSoundBufferRecorder soundBufferRecorder)

Get the name of the current audio capture device.

Parameters
soundBufferRecorderSound buffer recorder object
Returns
The name of the current audio capture device

◆ sfSoundBufferRecorder_getSampleRate()

CSFML_AUDIO_API 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
soundBufferRecorderSound buffer recorder object
Returns
Sample rate, in samples per second

◆ sfSoundBufferRecorder_setDevice()

CSFML_AUDIO_API sfBool 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
soundBufferRecorderSound buffer recorder object
nameThe name of the audio capture device
Returns
sfTrue, if it was able to set the requested device

◆ sfSoundBufferRecorder_start()

CSFML_AUDIO_API sfBool 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
soundBufferRecorderSound buffer recorder object
sampleRateDesired capture rate, in number of samples per second
Returns
sfTrue, if it was able to start recording

◆ sfSoundBufferRecorder_stop()

CSFML_AUDIO_API void sfSoundBufferRecorder_stop ( sfSoundBufferRecorder soundBufferRecorder)

Stop the capture of a sound recorder.

Parameters
soundBufferRecorderSound buffer recorder object