.. index:: pair: class; EE::Audio::Sound
.. _doxid-class_e_e_1_1_audio_1_1_sound:

class EE::Audio::Sound
======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Regular sound that can be played in the audio environment. :ref:`More...<details-class_e_e_1_1_audio_1_1_sound>`


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

	#include <sound.hpp>
	
	class Sound: public :ref:`EE::Audio::SoundSource<doxid-class_e_e_1_1_audio_1_1_sound_source>` {
	public:
		// construction
	
		:target:`Sound<doxid-class_e_e_1_1_audio_1_1_sound_1aad7ca02e18407f927a5753a9fedae47d>`();
		:ref:`Sound<doxid-class_e_e_1_1_audio_1_1_sound_1af29695cf0ad32e8e1c36d7222f659205>`(const :ref:`SoundBuffer<doxid-class_e_e_1_1_audio_1_1_sound_buffer>`& buffer);
		:ref:`Sound<doxid-class_e_e_1_1_audio_1_1_sound_1af66fb90be9cacdbde250eda911804a20>`(const Sound& copy);
		:target:`~Sound<doxid-class_e_e_1_1_audio_1_1_sound_1a649ff02f025214d2424c18b5c75c95d8>`();

		// methods
	
		virtual void :ref:`play<doxid-class_e_e_1_1_audio_1_1_sound_1a1af57556b8f8d70659616cdbfcc33f98>`();
		virtual void :ref:`pause<doxid-class_e_e_1_1_audio_1_1_sound_1a20565c559e77aa551240c33208a1e888>`();
		virtual void :ref:`stop<doxid-class_e_e_1_1_audio_1_1_sound_1a37473426c02a2a40aea482b627483da0>`();
		void :ref:`setBuffer<doxid-class_e_e_1_1_audio_1_1_sound_1aef046d995252bb0f9f06045fae1a667d>`(const :ref:`SoundBuffer<doxid-class_e_e_1_1_audio_1_1_sound_buffer>`& buffer);
		void :ref:`setLoop<doxid-class_e_e_1_1_audio_1_1_sound_1ac68f88d1c3c6b565cc6570dd4e34f010>`(bool loop);
		void :ref:`setPlayingOffset<doxid-class_e_e_1_1_audio_1_1_sound_1ace4cae883a487e02d3943460d1ee101b>`(:ref:`Time<doxid-class_e_e_1_1_system_1_1_time>` timeOffset);
		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_1ac6bb54ebad4c8bc6c82197580ed30abe>`() const;
		bool :ref:`getLoop<doxid-class_e_e_1_1_audio_1_1_sound_1acaf4550c701cf1b97a232a20d683303c>`() const;
		:ref:`Time<doxid-class_e_e_1_1_system_1_1_time>` :ref:`getPlayingOffset<doxid-class_e_e_1_1_audio_1_1_sound_1ac680797e54ecebd52c6af9ac1e81cef8>`() const;
		virtual :ref:`Status<doxid-class_e_e_1_1_audio_1_1_sound_source_1a09293754fddc60363b39e83a71874111>` :ref:`getStatus<doxid-class_e_e_1_1_audio_1_1_sound_1a3fc95be5b1e1a76b21314463a29d1f73>`() const;
		Sound& :ref:`operator=<doxid-class_e_e_1_1_audio_1_1_sound_1a5d5942920584b9cf2ceeb0d06ac8ce9d>`(const Sound& right);
		void :ref:`resetBuffer<doxid-class_e_e_1_1_audio_1_1_sound_1aa18c9e657954e4cb0cdf580865ae47ac>`();
	};

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

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

	public:
		// enums
	
		enum :ref:`Status<doxid-class_e_e_1_1_audio_1_1_sound_source_1a09293754fddc60363b39e83a71874111>`;

		// methods
	
		void :ref:`setPitch<doxid-class_e_e_1_1_audio_1_1_sound_source_1a6ebc9019d048be4be32b2ea3a20c0a34>`(float pitch);
		void :ref:`setVolume<doxid-class_e_e_1_1_audio_1_1_sound_source_1a3a2e0cf6ff2ee726a12450e91369ab2f>`(float volume);
		void :ref:`setPosition<doxid-class_e_e_1_1_audio_1_1_sound_source_1a8b1f39cca03ad22284344d58f0fb4dec>`(float x, float y, float z);
		void :ref:`setPosition<doxid-class_e_e_1_1_audio_1_1_sound_source_1a4850d9621033aeccf39ef9a83041165a>`(const :ref:`Vector3f<doxid-namespace_e_e_1_1_math_1a65f51d609aa1cb43626e6301465375db>`& position);
		void :ref:`setRelativeToListener<doxid-class_e_e_1_1_audio_1_1_sound_source_1a81ee0bc1c3e4b4348e6a7a791f31fb4b>`(bool relative);
		void :ref:`setMinDistance<doxid-class_e_e_1_1_audio_1_1_sound_source_1acf61df2388f55cbc759d112c389e84af>`(float distance);
		void :ref:`setAttenuation<doxid-class_e_e_1_1_audio_1_1_sound_source_1a90d1941023ac569193b269065d73de00>`(float attenuation);
		float :ref:`getPitch<doxid-class_e_e_1_1_audio_1_1_sound_source_1a6cd19d074c46b26801948c8d90cfb9f3>`() const;
		float :ref:`getVolume<doxid-class_e_e_1_1_audio_1_1_sound_source_1aca9cd53b4aa90f98fc5061ab7e57c93d>`() const;
		:ref:`Vector3f<doxid-namespace_e_e_1_1_math_1a65f51d609aa1cb43626e6301465375db>` :ref:`getPosition<doxid-class_e_e_1_1_audio_1_1_sound_source_1a3e36d949b0a5cb869d3f02dde2651c32>`() const;
		bool :ref:`isRelativeToListener<doxid-class_e_e_1_1_audio_1_1_sound_source_1ad7a78ac0d348c767a0ee6f4058f95bc3>`() const;
		float :ref:`getMinDistance<doxid-class_e_e_1_1_audio_1_1_sound_source_1a14d801b275c0fd45998fd249db937276>`() const;
		float :ref:`getAttenuation<doxid-class_e_e_1_1_audio_1_1_sound_source_1a23012b8face222ffac3500715de69e20>`() const;
		:ref:`SoundSource<doxid-class_e_e_1_1_audio_1_1_sound_source>`& :ref:`operator=<doxid-class_e_e_1_1_audio_1_1_sound_source_1aa4e8e5e469eca903896981c09242a1fa>`(const :ref:`SoundSource<doxid-class_e_e_1_1_audio_1_1_sound_source>`& right);
		virtual void :ref:`play<doxid-class_e_e_1_1_audio_1_1_sound_source_1aa944f65970d35222ea1a99229f09ea34>`() = 0;
		virtual void :ref:`pause<doxid-class_e_e_1_1_audio_1_1_sound_source_1a4c2bb65671291cc419b6f2cea28f3216>`() = 0;
		virtual void :ref:`stop<doxid-class_e_e_1_1_audio_1_1_sound_source_1a176f14707c5af0641bb167b01acffb16>`() = 0;
		virtual :ref:`Status<doxid-class_e_e_1_1_audio_1_1_sound_source_1a09293754fddc60363b39e83a71874111>` :ref:`getStatus<doxid-class_e_e_1_1_audio_1_1_sound_source_1a748100b271fae1d64514922c5c5b8abc>`() const;

.. _details-class_e_e_1_1_audio_1_1_sound:

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

Regular sound that can be played in the audio environment.

:ref:`Sound <doxid-class_e_e_1_1_audio_1_1_sound>` is the class to use to play sounds. It provides:

* Control (play, pause, stop)

* Ability to modify output parameters in real-time (pitch, volume, ...)

* 3D spatial features (position, attenuation, ...).

:ref:`Sound <doxid-class_e_e_1_1_audio_1_1_sound>` is perfect for playing short sounds that can fit in memory and require no latency, like foot steps or gun shots. For longer sounds, like background musics or long speeches, rather see :ref:`Music <doxid-class_e_e_1_1_audio_1_1_music>` (which is based on streaming).

In order to work, a sound must be given a buffer of audio data to play. :ref:`Audio <doxid-namespace_e_e_1_1_audio>` data (samples) is stored in :ref:`SoundBuffer <doxid-class_e_e_1_1_audio_1_1_sound_buffer>`, and attached to a sound with the :ref:`setBuffer() <doxid-class_e_e_1_1_audio_1_1_sound_1aef046d995252bb0f9f06045fae1a667d>` function. The buffer object attached to a sound must remain alive as long as the sound uses it. Note that multiple sounds can use the same sound buffer at the same time.

Usage example:

.. ref-code-block:: cpp

	SoundBuffer buffer;
	buffer.loadFromFile("sound.wav");
	
	Sound sound;
	sound.setBuffer(buffer);
	sound.play();



.. rubric:: See also:

:ref:`SoundBuffer <doxid-class_e_e_1_1_audio_1_1_sound_buffer>`, :ref:`Music <doxid-class_e_e_1_1_audio_1_1_music>`

Construction
------------

.. index:: pair: function; Sound
.. _doxid-class_e_e_1_1_audio_1_1_sound_1af29695cf0ad32e8e1c36d7222f659205:

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

	Sound(const :ref:`SoundBuffer<doxid-class_e_e_1_1_audio_1_1_sound_buffer>`& buffer)

Construct the sound with a buffer.



.. rubric:: Parameters:

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

	*
		- buffer

		- :ref:`Sound <doxid-class_e_e_1_1_audio_1_1_sound>` buffer containing the audio data to play with the sound

.. index:: pair: function; Sound
.. _doxid-class_e_e_1_1_audio_1_1_sound_1af66fb90be9cacdbde250eda911804a20:

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

	Sound(const Sound& copy)

Copy constructor.



.. rubric:: Parameters:

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

	*
		- copy

		- Instance to copy

Methods
-------

.. index:: pair: function; play
.. _doxid-class_e_e_1_1_audio_1_1_sound_1a1af57556b8f8d70659616cdbfcc33f98:

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

	virtual void play()

Start or resume playing the sound.

This function starts the stream if it was stopped, resumes it if it was paused, and restarts it from beginning if it was it already playing. This function uses its own thread so that it doesn't block the rest of the program while the sound is played.



.. rubric:: See also:

:ref:`pause <doxid-class_e_e_1_1_audio_1_1_sound_1a20565c559e77aa551240c33208a1e888>`, :ref:`stop <doxid-class_e_e_1_1_audio_1_1_sound_1a37473426c02a2a40aea482b627483da0>`

.. index:: pair: function; pause
.. _doxid-class_e_e_1_1_audio_1_1_sound_1a20565c559e77aa551240c33208a1e888:

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

	virtual void pause()

Pause the sound.

This function pauses the sound if it was playing, otherwise (sound already paused or stopped) it has no effect.



.. rubric:: See also:

:ref:`play <doxid-class_e_e_1_1_audio_1_1_sound_1a1af57556b8f8d70659616cdbfcc33f98>`, :ref:`stop <doxid-class_e_e_1_1_audio_1_1_sound_1a37473426c02a2a40aea482b627483da0>`

.. index:: pair: function; stop
.. _doxid-class_e_e_1_1_audio_1_1_sound_1a37473426c02a2a40aea482b627483da0:

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

	virtual void stop()

stop playing the sound

This function stops the sound if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike :ref:`pause() <doxid-class_e_e_1_1_audio_1_1_sound_1a20565c559e77aa551240c33208a1e888>`).



.. rubric:: See also:

:ref:`play <doxid-class_e_e_1_1_audio_1_1_sound_1a1af57556b8f8d70659616cdbfcc33f98>`, :ref:`pause <doxid-class_e_e_1_1_audio_1_1_sound_1a20565c559e77aa551240c33208a1e888>`

.. index:: pair: function; setBuffer
.. _doxid-class_e_e_1_1_audio_1_1_sound_1aef046d995252bb0f9f06045fae1a667d:

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

	void setBuffer(const :ref:`SoundBuffer<doxid-class_e_e_1_1_audio_1_1_sound_buffer>`& buffer)

Set the source buffer containing the audio data to play.

It is important to note that the sound buffer is not copied, thus the :ref:`SoundBuffer <doxid-class_e_e_1_1_audio_1_1_sound_buffer>` instance must remain alive as long as it is attached to the sound.



.. rubric:: Parameters:

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

	*
		- buffer

		- :ref:`Sound <doxid-class_e_e_1_1_audio_1_1_sound>` buffer to attach to the sound



.. rubric:: See also:

:ref:`getBuffer <doxid-class_e_e_1_1_audio_1_1_sound_1ac6bb54ebad4c8bc6c82197580ed30abe>`

.. index:: pair: function; setLoop
.. _doxid-class_e_e_1_1_audio_1_1_sound_1ac68f88d1c3c6b565cc6570dd4e34f010:

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

	void setLoop(bool loop)

Set whether or not the sound should loop after reaching the end.

If set, the sound will restart from beginning after reaching the end and so on, until it is stopped or setLoop(false) is called. The default looping state for sound is false.



.. rubric:: Parameters:

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

	*
		- loop

		- True to play in loop, false to play once



.. rubric:: See also:

:ref:`getLoop <doxid-class_e_e_1_1_audio_1_1_sound_1acaf4550c701cf1b97a232a20d683303c>`

.. index:: pair: function; setPlayingOffset
.. _doxid-class_e_e_1_1_audio_1_1_sound_1ace4cae883a487e02d3943460d1ee101b:

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

	void setPlayingOffset(:ref:`Time<doxid-class_e_e_1_1_system_1_1_time>` timeOffset)

Change the current playing position of the sound.

The playing position can be changed when the sound is either paused or playing. Changing the playing position when the sound is stopped has no effect, since playing the sound will reset its position.



.. rubric:: Parameters:

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

	*
		- timeOffset

		- New playing position, from the beginning of the sound



.. rubric:: See also:

:ref:`getPlayingOffset <doxid-class_e_e_1_1_audio_1_1_sound_1ac680797e54ecebd52c6af9ac1e81cef8>`

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

.. 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 audio buffer attached to the sound.



.. rubric:: Returns:

:ref:`Sound <doxid-class_e_e_1_1_audio_1_1_sound>` buffer attached to the sound (can be NULL)

.. index:: pair: function; getLoop
.. _doxid-class_e_e_1_1_audio_1_1_sound_1acaf4550c701cf1b97a232a20d683303c:

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

	bool getLoop() const

Tell whether or not the sound is in loop mode.



.. rubric:: Returns:

True if the sound is looping, false otherwise



.. rubric:: See also:

:ref:`setLoop <doxid-class_e_e_1_1_audio_1_1_sound_1ac68f88d1c3c6b565cc6570dd4e34f010>`

.. index:: pair: function; getPlayingOffset
.. _doxid-class_e_e_1_1_audio_1_1_sound_1ac680797e54ecebd52c6af9ac1e81cef8:

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

	:ref:`Time<doxid-class_e_e_1_1_system_1_1_time>` getPlayingOffset() const

Get the current playing position of the sound.



.. rubric:: Returns:

Current playing position, from the beginning of the sound



.. rubric:: See also:

:ref:`setPlayingOffset <doxid-class_e_e_1_1_audio_1_1_sound_1ace4cae883a487e02d3943460d1ee101b>`

.. index:: pair: function; getStatus
.. _doxid-class_e_e_1_1_audio_1_1_sound_1a3fc95be5b1e1a76b21314463a29d1f73:

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

	virtual :ref:`Status<doxid-class_e_e_1_1_audio_1_1_sound_source_1a09293754fddc60363b39e83a71874111>` getStatus() const

Get the current status of the sound (stopped, paused, playing)



.. rubric:: Returns:

Current status of the sound

.. index:: pair: function; operator=
.. _doxid-class_e_e_1_1_audio_1_1_sound_1a5d5942920584b9cf2ceeb0d06ac8ce9d:

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

	Sound& operator=(const Sound& right)

Overload of assignment operator.



.. rubric:: Parameters:

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

	*
		- right

		- Instance to assign



.. rubric:: Returns:

Reference to self

.. index:: pair: function; resetBuffer
.. _doxid-class_e_e_1_1_audio_1_1_sound_1aa18c9e657954e4cb0cdf580865ae47ac:

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

	void resetBuffer()

Reset the internal buffer of the sound.

This function is for internal use only, you don't have to use it. It is called by the :ref:`SoundBuffer <doxid-class_e_e_1_1_audio_1_1_sound_buffer>` that this sound uses, when it is destroyed in order to prevent the sound from using a dead buffer.