lauchmelder/SFML
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improved the API documentation in the audio module

Browse source 
Added sf::SoundSource as a base class of both sf::Sound and sf::SoundStream

git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1253 4e206d99-4929-0410-ac5d-dfc041789085
This commit is contained in:
LaurentGom 2009-10-30 16:14:26 +00:00
parent 3c0d42fdd0
commit 7d5f354850
14 changed files with 682 additions and 386 deletions
Download patch file Download diff file Expand all files Collapse all files

35
include/SFML/Audio/SoundStream.hpp
View file

@ -28,7 +28,7 @@
////////////////////////////////////////////////////////////
// Headers
////////////////////////////////////////////////////////////
#include <SFML/Audio/Sound.hpp>
#include <SFML/Audio/SoundSource.hpp>
#include <SFML/System/Thread.hpp>
#include <cstdlib>
@ -39,28 +39,10 @@ namespace sf
/// \brief Abstract base class for streamed audio sources
///
////////////////////////////////////////////////////////////
class SFML_API SoundStream : private Thread, private Sound
class SFML_API SoundStream : public SoundSource, private Thread
{
public :
using Sound::Status;
using Sound::Stopped;
using Sound::Paused;
using Sound::Playing;
using Sound::Pause;
using Sound::SetPitch;
using Sound::SetVolume;
using Sound::SetPosition;
using Sound::SetRelativeToListener;
using Sound::SetMinDistance;
using Sound::SetAttenuation;
using Sound::GetPitch;
using Sound::GetVolume;
using Sound::GetPosition;
using Sound::IsRelativeToListener;
using Sound::GetMinDistance;
using Sound::GetAttenuation;
////////////////////////////////////////////////////////////
/// \brief Structure defining a chunk of audio data to stream
///
@ -90,6 +72,17 @@ public :
////////////////////////////////////////////////////////////
void Play();
////////////////////////////////////////////////////////////
/// \brief Pause the audio stream
///
/// This function pauses the stream if it was playing,
/// otherwise (stream already paused or stopped) it has no effect.
///
/// \see Play, Stop
///
////////////////////////////////////////////////////////////
void Pause();
////////////////////////////////////////////////////////////
/// \brief Stop playing the audio stream
///
@ -172,7 +165,7 @@ public :
////////////////////////////////////////////////////////////
/// \brief Tell whether or not the stream is in loop mode
///
/// \return True if the music is looping, false otherwise
/// \return True if the stream is looping, false otherwise
///
/// \see SetLoop
///