.. index:: pair: class; EE::Audio::SoundBufferRecorder
.. _doxid-class_e_e_1_1_audio_1_1_sound_buffer_recorder:

class EE::Audio::SoundBufferRecorder
====================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Specialized :ref:`SoundRecorder <doxid-class_e_e_1_1_audio_1_1_sound_recorder>` which stores the captured audio data into a sound buffer. :ref:`More...<details-class_e_e_1_1_audio_1_1_sound_buffer_recorder>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <soundbufferrecorder.hpp>
	
	class SoundBufferRecorder: public :ref:`EE::Audio::SoundRecorder<doxid-class_e_e_1_1_audio_1_1_sound_recorder>` {
	public:
		// construction
	
		:target:`~SoundBufferRecorder<doxid-class_e_e_1_1_audio_1_1_sound_buffer_recorder_1ab06888dac04028b07f2a56781c8fabce>`();

		// methods
	
		const :ref:`SoundBuffer<doxid-class_e_e_1_1_audio_1_1_sound_buffer>`& :ref:`getBuffer<doxid-class_e_e_1_1_audio_1_1_sound_buffer_recorder_1ab5b51366b72a653ae60416686af239ea>`() const;
	};

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// methods
	
		bool :ref:`start<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1aa66957284ecc845dfd90aedbbebd4d74>`(unsigned int sampleRate = 44100);
		void :ref:`stop<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1a8f03d4de40b629b7e7d140c4dff55e6a>`();
		unsigned int :ref:`getSampleRate<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1a13131a3158fed6aecc0caccef68da496>`() const;
		bool :ref:`setDevice<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1a3b7dc2a49853f0c5fefd0d8aea13921b>`(const std::string& name);
		const std::string& :ref:`getDevice<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1a09cf53751c3933d6aa9d81b2d60a6cea>`() const;
		void :ref:`setChannelCount<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1a49a3f76da40f1fa6289562de2969494f>`(unsigned int channelCount);
		unsigned int :ref:`getChannelCount<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1a83dd93647fce8f253f47078bb1cb1c99>`() const;
		bool :ref:`isCapturing<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1aa0d579e9d6116be7ecbc1fe0a122f629>`();
		static std::vector<std::string> :ref:`getAvailableDevices<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1a9650b8cf3919f5555b1e96d0a41e2042>`();
		static std::string :ref:`getDefaultDevice<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1addd5b0224f47faf63adf7bc99a672574>`();
		static bool :ref:`isAvailable<doxid-class_e_e_1_1_audio_1_1_sound_recorder_1a5ac9b9116b1935a0273e509348d3818c>`();

.. _details-class_e_e_1_1_audio_1_1_sound_buffer_recorder:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Specialized :ref:`SoundRecorder <doxid-class_e_e_1_1_audio_1_1_sound_recorder>` which stores the captured audio data into a sound buffer.

:ref:`SoundBufferRecorder <doxid-class_e_e_1_1_audio_1_1_sound_buffer_recorder>` allows to access a recorded sound through a :ref:`SoundBuffer <doxid-class_e_e_1_1_audio_1_1_sound_buffer>`, so that it can be played, saved to a file, etc.

It has the same simple interface as its base class (:ref:`start() <doxid-class_e_e_1_1_audio_1_1_sound_recorder_1aa66957284ecc845dfd90aedbbebd4d74>`, :ref:`stop() <doxid-class_e_e_1_1_audio_1_1_sound_recorder_1a8f03d4de40b629b7e7d140c4dff55e6a>`) and adds a function to retrieve the recorded sound buffer (:ref:`getBuffer() <doxid-class_e_e_1_1_audio_1_1_sound_buffer_recorder_1ab5b51366b72a653ae60416686af239ea>`).

As usual, don't forget to call the :ref:`isAvailable() <doxid-class_e_e_1_1_audio_1_1_sound_recorder_1a5ac9b9116b1935a0273e509348d3818c>` function before using this class (see :ref:`SoundRecorder <doxid-class_e_e_1_1_audio_1_1_sound_recorder>` for more details about this).

Usage example:

.. ref-code-block:: cpp

	if (SoundBufferRecorder::isAvailable())
	{
	 // Record some audio data
	 SoundBufferRecorder recorder;
	 recorder.start();
	 ...
	 recorder.stop();
	
	 // Get the buffer containing the captured audio data
	 const SoundBuffer& buffer = recorder.getBuffer();
	
	 // Save it to a file (for example...)
	 buffer.saveToFile("my_record.ogg");
	}



.. rubric:: See also:

:ref:`SoundRecorder <doxid-class_e_e_1_1_audio_1_1_sound_recorder>`

Methods
-------

.. index:: pair: function; getBuffer
.. _doxid-class_e_e_1_1_audio_1_1_sound_buffer_recorder_1ab5b51366b72a653ae60416686af239ea:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`SoundBuffer<doxid-class_e_e_1_1_audio_1_1_sound_buffer>`& 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.



.. rubric:: Returns:

Read-only access to the sound buffer