CSFML

- Main Page
- Data Structures
- Files

- File List
- Globals

SoundRecorder.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com)
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 <stddef.h>
34
35
36 typedef sfBool (*sfSoundRecorderStartCallback)(void*);
37 typedef sfBool (*sfSoundRecorderProcessCallback)(const sfInt16*, size_t, void*);
38 typedef void (*sfSoundRecorderStopCallback)(void*);
39
40
52 CSFML_AUDIO_API sfSoundRecorder* sfSoundRecorder_create(sfSoundRecorderStartCallback onStart,
53 sfSoundRecorderProcessCallback onProcess,
54 sfSoundRecorderStopCallback onStop,
55 void* userData);
56
63 CSFML_AUDIO_API void sfSoundRecorder_destroy(sfSoundRecorder* soundRecorder);
64
79 CSFML_AUDIO_API void sfSoundRecorder_start(sfSoundRecorder* soundRecorder, unsigned int sampleRate);
80
87 CSFML_AUDIO_API void sfSoundRecorder_stop(sfSoundRecorder* soundRecorder);
88
101 CSFML_AUDIO_API unsigned int sfSoundRecorder_getSampleRate(const sfSoundRecorder* soundRecorder);
102
113 CSFML_AUDIO_API sfBool sfSoundRecorder_isAvailable(void);
114
115
116 #endif // SFML_SOUNDRECORDER_H
sfSoundRecorderProcessCallback
sfBool(* sfSoundRecorderProcessCallback)(const sfInt16 *, size_t, void *)
Type of the callback used to process audio data.
Definition: SoundRecorder.h:37
sfSoundRecorderStartCallback
sfBool(* sfSoundRecorderStartCallback)(void *)
Type of the callback used when starting a capture.
Definition: SoundRecorder.h:36
Export.h
Types.h
sfSoundRecorder_start
CSFML_AUDIO_API void sfSoundRecorder_start(sfSoundRecorder *soundRecorder, unsigned int sampleRate)
Start the capture of a sound recorder.
sfSoundRecorder_destroy
CSFML_AUDIO_API void sfSoundRecorder_destroy(sfSoundRecorder *soundRecorder)
Destroy a sound recorder.
sfInt16
signed short sfInt16
Definition: Config.h:124
CSFML_AUDIO_API
#define CSFML_AUDIO_API
Definition: Audio/Export.h:43
sfBool
int sfBool
Definition: Config.h:106
sfSoundRecorder_isAvailable
CSFML_AUDIO_API sfBool sfSoundRecorder_isAvailable(void)
Check if the system supports audio capture.
sfSoundRecorderStopCallback
void(* sfSoundRecorderStopCallback)(void *)
Type of the callback used when stopping a capture.
Definition: SoundRecorder.h:38
sfSoundRecorder_create
CSFML_AUDIO_API sfSoundRecorder * sfSoundRecorder_create(sfSoundRecorderStartCallback onStart, sfSoundRecorderProcessCallback onProcess, sfSoundRecorderStopCallback onStop, void *userData)
Construct a new sound recorder from callback functions.
sfSoundRecorder
struct sfSoundRecorder sfSoundRecorder
Definition: Audio/Types.h:32
sfSoundRecorder_stop
CSFML_AUDIO_API void sfSoundRecorder_stop(sfSoundRecorder *soundRecorder)
Stop the capture of a sound recorder.
sfSoundRecorder_getSampleRate
CSFML_AUDIO_API unsigned int sfSoundRecorder_getSampleRate(const sfSoundRecorder *soundRecorder)
Get the sample rate of a sound recorder.