.. index:: pair: class; EE::Audio::OutputSoundFile
.. _doxid-class_e_e_1_1_audio_1_1_output_sound_file:

class EE::Audio::OutputSoundFile
================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Provide write access to sound files. :ref:`More...<details-class_e_e_1_1_audio_1_1_output_sound_file>`


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

	#include <outputsoundfile.hpp>
	
	class OutputSoundFile: private :ref:`EE::NonCopyable<doxid-class_e_e_1_1_non_copyable>` {
	public:
		// construction
	
		:target:`~OutputSoundFile<doxid-class_e_e_1_1_audio_1_1_output_sound_file_1ad6b1079cabfab07cc51df0b5d700b92b>`();

		// methods
	
		bool :ref:`openFromFile<doxid-class_e_e_1_1_audio_1_1_output_sound_file_1a310b970dd2b442afef479e77053c43f8>`(const std::string& filename, unsigned int sampleRate, unsigned int channelCount);
		void :ref:`write<doxid-class_e_e_1_1_audio_1_1_output_sound_file_1a6dcf3de2ff0c3e72043dd57f471d8719>`(const :ref:`Int16<doxid-namespace_e_e_1a73642650c4b4c754551791873b930462>`* samples, :ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` count);
	};
.. _details-class_e_e_1_1_audio_1_1_output_sound_file:

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

Provide write access to sound files.

This class encodes audio samples to a sound file. It is used internally by higher-level classes such as :ref:`SoundBuffer <doxid-class_e_e_1_1_audio_1_1_sound_buffer>`, but can also be useful if you want to create audio files from custom data sources, like generated audio samples.

Usage example:

.. ref-code-block:: cpp

	// Create a sound file, ogg/vorbis format, 44100 Hz, stereo
	OutputSoundFile file;
	if (!file.openFromFile("music.ogg", 44100, 2))
	 /* error */;
	
	while (...)
	{
	 // Read or generate audio samples from your custom source
	 std::vector<Int16> samples = ...;
	
	 // Write them to the file
	 file.write(samples.data(), samples.size());
	}



.. rubric:: See also:

:ref:`SoundFileWriter <doxid-class_e_e_1_1_audio_1_1_sound_file_writer>`, :ref:`InputSoundFile <doxid-class_e_e_1_1_audio_1_1_input_sound_file>`

Methods
-------

.. index:: pair: function; openFromFile
.. _doxid-class_e_e_1_1_audio_1_1_output_sound_file_1a310b970dd2b442afef479e77053c43f8:

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

	bool openFromFile(const std::string& filename, unsigned int sampleRate, unsigned int channelCount)

Open the sound file from the disk for writing.

The supported audio formats are: WAV, OGG/Vorbis, FLAC.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- filename

		- Path of the sound file to write

	*
		- sampleRate

		- Sample rate of the sound

	*
		- channelCount

		- Number of channels in the sound



.. rubric:: Returns:

True if the file was successfully opened

.. index:: pair: function; write
.. _doxid-class_e_e_1_1_audio_1_1_output_sound_file_1a6dcf3de2ff0c3e72043dd57f471d8719:

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

	void write(const :ref:`Int16<doxid-namespace_e_e_1a73642650c4b4c754551791873b930462>`* samples, :ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` count)

Write audio samples to the file.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- samples

		- Pointer to the sample array to write

	*
		- count

		- Number of samples to write