SoundBufferRecorder.h File Reference

#include <SFML/Config.h>
#include <SFML/Audio/Types.h>

Go to the source code of this file.


Functions

CSFML_API sfSoundBufferRecordersfSoundBufferRecorder_Create ()
 Construct a new sound buffer recorder.
CSFML_API void sfSoundBufferRecorder_Destroy (sfSoundBufferRecorder *SoundBufferRecorder)
 Destroy an existing sound buffer recorder.
CSFML_API void sfSoundBufferRecorder_Start (sfSoundBufferRecorder *SoundBufferRecorder, unsigned int SampleRate)
 Start the capture.
CSFML_API void sfSoundBufferRecorder_Stop (sfSoundBufferRecorder *SoundBufferRecorder)
 Stop the capture.
CSFML_API unsigned int sfSoundBufferRecorder_GetSampleRate (sfSoundBufferRecorder *SoundBufferRecorder)
 Get the sample rate of a sound buffer recorder.
CSFML_API sfSoundBuffersfSoundBufferRecorder_GetBuffer (sfSoundBufferRecorder *SoundBufferRecorder)
 Get the sound buffer containing the captured audio data of a sound buffer recorder.

Function Documentation

CSFML_API sfSoundBufferRecorder* sfSoundBufferRecorder_Create (  ) 

Construct a new sound buffer recorder.

Returns:
A new sfSoundBufferRecorder object (NULL if failed)

CSFML_API void sfSoundBufferRecorder_Destroy ( sfSoundBufferRecorder SoundBufferRecorder  ) 

Destroy an existing sound buffer recorder.

Parameters:
SoundBufferRecorder : Sound buffer recorder to delete

CSFML_API sfSoundBuffer* sfSoundBufferRecorder_GetBuffer ( sfSoundBufferRecorder SoundBufferRecorder  ) 

Get the sound buffer containing the captured audio data of a sound buffer recorder.

Parameters:
SoundBufferRecorder : Sound buffer recorder to get the sound buffer from
Returns:
Pointer to the sound buffer (you don't need to destroy it after use)

CSFML_API unsigned int sfSoundBufferRecorder_GetSampleRate ( sfSoundBufferRecorder SoundBufferRecorder  ) 

Get the sample rate of a sound buffer recorder.

Parameters:
SoundBufferRecorder : Sound buffer recorder to get sample rate from
Returns:
Frequency, in samples per second

CSFML_API void sfSoundBufferRecorder_Start ( sfSoundBufferRecorder SoundBufferRecorder,
unsigned int  SampleRate 
)

Start the capture.

Warning : only one capture can happen at the same time

Parameters:
SoundBufferRecorder : Sound bufferrecorder to start
SampleRate : Sound frequency (the more samples, the higher the quality)

CSFML_API void sfSoundBufferRecorder_Stop ( sfSoundBufferRecorder SoundBufferRecorder  ) 

Stop the capture.

Parameters:
SoundBufferRecorder : Sound buffer recorder to stop