- cpp3ds
- SoundBufferRecorder
Specialized SoundRecorder which stores the captured audio data into a sound buffer. More...
#include <SoundBufferRecorder.hpp>
Public Member Functions | |
| const SoundBuffer & | getBuffer () const |
| Get the sound buffer containing the captured audio data. More... | |
| bool | start (unsigned int sampleRate=44100) |
| Start the capture. More... | |
| void | stop () |
| Stop the capture. More... | |
| unsigned int | getSampleRate () const |
| Get the sample rate. More... | |
| bool | setDevice (const std::string &name) |
| Set the audio capture device. More... | |
| const std::string & | getDevice () const |
| Get the name of the current audio capture device. More... | |
Static Public Member Functions | |
| static std::vector< std::string > | getAvailableDevices () |
| Get a list of the names of all availabe audio capture devices. More... | |
| static std::string | getDefaultDevice () |
| Get the name of the default audio capture device. More... | |
| static bool | isAvailable () |
| Check if the system supports audio capture. More... | |
Protected Member Functions | |
| virtual bool | onStart () |
| Start capturing audio data. More... | |
| virtual bool | onProcessSamples (const Int16 *samples, std::size_t sampleCount) |
| Process a new chunk of recorded samples. More... | |
| virtual void | onStop () |
| Stop capturing audio data. More... | |
| void | setProcessingInterval (cpp3ds::Time interval) |
| Set the processing interval. More... | |
Specialized SoundRecorder which stores the captured audio data into a sound buffer.
cpp3ds::SoundBufferRecorder allows to access a recorded sound through a cpp3ds::SoundBuffer, so that it can be played, saved to a file, etc.
It has the same simple interface as its base class (start(), stop()) and adds a function to retrieve the recorded sound buffer (getBuffer()).
As usual, don't forget to call the isAvailable() function before using this class (see cpp3ds::SoundRecorder for more details about this).
Usage example:
Definition at line 45 of file SoundBufferRecorder.hpp.
|
staticinherited |
Get a list of the names of all availabe audio capture devices.
This function returns a vector of strings, containing the names of all availabe audio capture devices.
| const SoundBuffer& cpp3ds::SoundBufferRecorder::getBuffer | ( | ) | const |
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.
|
staticinherited |
Get the name of the default audio capture device.
This function returns the name of the default audio capture device. If none is available, an empty string is returned.
|
inherited |
Get the name of the current audio capture device.
|
inherited |
Get the sample rate.
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).
|
staticinherited |
Check if the system supports audio capture.
This function should always be called before using the audio capture features. If it returns false, then any attempt to use cpp3ds::SoundRecorder or one of its derived classes will fail.
|
protectedvirtual |
Process a new chunk of recorded samples.
| samples | Pointer to the new chunk of recorded samples |
| sampleCount | Number of samples pointed by samples |
Implements cpp3ds::SoundRecorder.
|
protectedvirtual |
Start capturing audio data.
Reimplemented from cpp3ds::SoundRecorder.
|
protectedvirtual |
Stop capturing audio data.
Reimplemented from cpp3ds::SoundRecorder.
|
inherited |
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.
| name | The name of the audio capture device |
|
protectedinherited |
Set the processing interval.
The processing interval controls the period between calls to the onProcessSamples function. You may want to use a small interval if you want to process the recorded data in real time, for example.
Note: this is only a hint, the actual period may vary. So don't rely on this parameter to implement precise timing.
The default processing interval is 100 ms.
| interval | Processing interval |
|
inherited |
Start the capture.
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. You can select which capture device will be used, by passing the name to the setDevice() method. If none was selected before, the default capture device will be used. You can get a list of the names of all available capture devices by calling getAvailableDevices().
| sampleRate | Desired capture rate, in number of samples per second |
|
inherited |
Stop the capture.