SoundRecorder.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_SOUNDRECORDER_H
26 #define SFML_SOUNDRECORDER_H
27 
29 // Headers
31 #include <SFML/Audio/Export.h>
32 #include <SFML/Audio/Types.h>
33 #include <SFML/System/Time.h>
34 #include <stddef.h>
35 
36 
38 typedef sfBool (*sfSoundRecorderProcessCallback)(const sfInt16*, size_t, void*);
39 typedef void (*sfSoundRecorderStopCallback)(void*);
40 
41 
56  void* userData);
57 
65 
82 CSFML_AUDIO_API sfBool sfSoundRecorder_start(sfSoundRecorder* soundRecorder, unsigned int sampleRate);
83 
91 
104 CSFML_AUDIO_API unsigned int sfSoundRecorder_getSampleRate(const sfSoundRecorder* soundRecorder);
105 
117 
136 
149 CSFML_AUDIO_API const char** sfSoundRecorder_getAvailableDevices(size_t* count);
150 
161 
176 CSFML_AUDIO_API sfBool sfSoundRecorder_setDevice(sfSoundRecorder* soundRecorder, const char* name);
177 
186 CSFML_AUDIO_API const char* sfSoundRecorder_getDevice(sfSoundRecorder* soundRecorder);
187 
201 CSFML_AUDIO_API void sfSoundRecorder_setChannelCount(sfSoundRecorder* soundRecorder, unsigned int channelCount);
202 
214 CSFML_AUDIO_API unsigned int sfSoundRecorder_getChannelCount(const sfSoundRecorder* soundRecorder);
215 
216 
217 #endif // SFML_SOUNDRECORDER_H
CSFML_AUDIO_API const char * sfSoundRecorder_getDevice(sfSoundRecorder *soundRecorder)
Get the name of the current audio capture device.
CSFML_AUDIO_API const char * sfSoundRecorder_getDefaultDevice()
Get the name of the default audio capture device.
CSFML_AUDIO_API sfBool sfSoundRecorder_start(sfSoundRecorder *soundRecorder, unsigned int sampleRate)
Start the capture of a sound recorder.
CSFML_AUDIO_API const char ** sfSoundRecorder_getAvailableDevices(size_t *count)
Get a list of the names of all availabe audio capture devices.
sfBool(* sfSoundRecorderStartCallback)(void *)
Type of the callback used when starting a capture.
Definition: SoundRecorder.h:37
CSFML_AUDIO_API void sfSoundRecorder_setChannelCount(sfSoundRecorder *soundRecorder, unsigned int channelCount)
Set the channel count of the audio capture device.
CSFML_AUDIO_API void sfSoundRecorder_destroy(sfSoundRecorder *soundRecorder)
Destroy a sound recorder.
signed short sfInt16
Definition: Config.h:171
#define CSFML_AUDIO_API
Definition: Audio/Export.h:43
int sfBool
Definition: Config.h:153
CSFML_AUDIO_API sfBool sfSoundRecorder_isAvailable(void)
Check if the system supports audio capture.
CSFML_AUDIO_API void sfSoundRecorder_setProcessingInterval(sfSoundRecorder *soundRecorder, sfTime interval)
Set the processing interval.
Represents a time value.
Definition: Time.h:38
CSFML_AUDIO_API sfSoundRecorder * sfSoundRecorder_create(sfSoundRecorderStartCallback onStart, sfSoundRecorderProcessCallback onProcess, sfSoundRecorderStopCallback onStop, void *userData)
Construct a new sound recorder from callback functions.
void(* sfSoundRecorderStopCallback)(void *)
Type of the callback used when stopping a capture.
Definition: SoundRecorder.h:39
struct sfSoundRecorder sfSoundRecorder
Definition: Audio/Types.h:33
CSFML_AUDIO_API sfBool sfSoundRecorder_setDevice(sfSoundRecorder *soundRecorder, const char *name)
Set the audio capture device.
sfBool(* sfSoundRecorderProcessCallback)(const sfInt16 *, size_t, void *)
Type of the callback used to process audio data.
Definition: SoundRecorder.h:38
CSFML_AUDIO_API void sfSoundRecorder_stop(sfSoundRecorder *soundRecorder)
Stop the capture of a sound recorder.
CSFML_AUDIO_API unsigned int sfSoundRecorder_getChannelCount(const sfSoundRecorder *soundRecorder)
Get the number of channels used by this recorder.
CSFML_AUDIO_API unsigned int sfSoundRecorder_getSampleRate(const sfSoundRecorder *soundRecorder)
Get the sample rate of a sound recorder.