sf::Sound Class Reference

Sound defines the properties of the sound such as position, volume, pitch, etc. More...

#include <Sound.hpp>

Inheritance diagram for sf::Sound:

sf::AudioResource sf::SoundStream sf::Music List of all members.

Public Types

enum  Status {
  Stopped,
  Paused,
  Playing
}
 Enumeration of the sound states. More...

Public Member Functions

 Sound (const SoundBuffer *Buffer=NULL, bool Loop=false, float Pitch=1.f, float Volume=100.f, float X=0.f, float Y=0.f, float Z=0.f)
 Construct the sound from its parameters.
 Sound (const Sound &Copy)
 Copy constructor.
 ~Sound ()
 Destructor.
void Play ()
 Play the sound.
void Pause ()
 Pause the sound.
void Stop ()
 Stop the sound.
void SetBuffer (const SoundBuffer *Buffer)
 Set the source buffer.
void SetLoop (bool Loop)
 Set the sound loop state.
void SetPitch (float Pitch)
 Set the sound pitch.
void SetVolume (float Volume)
 Set the sound volume.
void SetPosition (float X, float Y, float Z)
 Set the sound position.
const SoundBufferGetBuffer () const
 Get the source buffer.
bool GetLoop () const
 Tell whether or not the sound is looping.
float GetPitch () const
 Get the pitch.
float GetVolume () const
 Get the volume.
void GetPosition (float &X, float &Y, float &Z) const
 Get the sound position.
Status GetStatus () const
 Get the status of the sound (stopped, paused, playing).
float GetPlayingOffset () const
 Get the current playing position of the sound.
Soundoperator= (const Sound &Other)
 Assignment operator.

Friends

class SoundStream

Detailed Description

Sound defines the properties of the sound such as position, volume, pitch, etc.

Definition at line 43 of file Sound.hpp.


Member Enumeration Documentation

enum sf::Sound::Status

Enumeration of the sound states.

Enumerator:
Stopped  Sound is not playing.
Paused  Sound is paused.
Playing  Sound is playing.

Definition at line 50 of file Sound.hpp.


Constructor & Destructor Documentation

sf::Sound::Sound ( const SoundBuffer Buffer = NULL,
bool  Loop = false,
float  Pitch = 1.f,
float  Volume = 100.f,
float  X = 0.f,
float  Y = 0.f,
float  Z = 0.f 
)

Construct the sound from its parameters.

Parameters:
Buffer : Sound buffer to play (NULL by default)
Loop : Loop flag (false by default)
Pitch : Value of the pitch (1 by default)
Volume : Volume (100 by default)
X : X position (0 by default)
Y : Y position (0 by default)
Z : Z position (0 by default)

Definition at line 38 of file Sound.cpp.

sf::Sound::Sound ( const Sound Copy  ) 

Copy constructor.

Parameters:
Copy : Instance to copy

Definition at line 58 of file Sound.cpp.

sf::Sound::~Sound (  ) 

Destructor.

Definition at line 82 of file Sound.cpp.


Member Function Documentation

void sf::Sound::Play (  ) 

Play the sound.

Reimplemented in sf::SoundStream.

Definition at line 96 of file Sound.cpp.

void sf::Sound::Pause (  ) 

Pause the sound.

Definition at line 105 of file Sound.cpp.

void sf::Sound::Stop (  ) 

Stop the sound.

Reimplemented in sf::SoundStream.

Definition at line 114 of file Sound.cpp.

void sf::Sound::SetBuffer ( const SoundBuffer Buffer  ) 

Set the source buffer.

Parameters:
Buffer : Pointer to the new sound buffer to bind to the sound

Definition at line 123 of file Sound.cpp.

void sf::Sound::SetLoop ( bool  Loop  ) 

Set the sound loop state.

Parameters:
Loop : True to play in loop, false to play once

Reimplemented in sf::Music.

Definition at line 133 of file Sound.cpp.

void sf::Sound::SetPitch ( float  Pitch  ) 

Set the sound pitch.

Parameters:
Pitch : New pitch

Definition at line 142 of file Sound.cpp.

void sf::Sound::SetVolume ( float  Volume  ) 

Set the sound volume.

Parameters:
Volume : Volume (in range [0, 100])

Definition at line 151 of file Sound.cpp.

void sf::Sound::SetPosition ( float  X,
float  Y,
float  Z 
)

Set the sound position.

Parameters:
X : X position of the sound in the world
Y : Y position of the sound in the world
Z : Z position of the sound in the world

Definition at line 160 of file Sound.cpp.

const SoundBuffer * sf::Sound::GetBuffer (  )  const

Get the source buffer.

Returns:
Sound buffer bound to the sound (can be NULL)

Definition at line 169 of file Sound.cpp.

bool sf::Sound::GetLoop (  )  const

Tell whether or not the sound is looping.

Returns:
True if the sound is looping, false otherwise

Reimplemented in sf::Music.

Definition at line 178 of file Sound.cpp.

float sf::Sound::GetPitch (  )  const

Get the pitch.

Returns:
Pitch value

Definition at line 190 of file Sound.cpp.

float sf::Sound::GetVolume (  )  const

Get the volume.

Returns:
Volume value (in range [1, 100])

Definition at line 202 of file Sound.cpp.

void sf::Sound::GetPosition ( float &  X,
float &  Y,
float &  Z 
) const

Get the sound position.

Parameters:
X : X position of the sound in the world
Y : Y position of the sound in the world
Z : Z position of the sound in the world

Definition at line 214 of file Sound.cpp.

Sound::Status sf::Sound::GetStatus (  )  const

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

Returns:
Current status of the sound

Reimplemented in sf::SoundStream.

Definition at line 223 of file Sound.cpp.

float sf::Sound::GetPlayingOffset (  )  const

Get the current playing position of the sound.

Returns:
Current playing position, expressed in seconds

Definition at line 243 of file Sound.cpp.

Sound & sf::Sound::operator= ( const Sound Other  ) 

Assignment operator.

Parameters:
Other : Instance to assign
Returns:
Reference to the sound

Definition at line 255 of file Sound.cpp.


The documentation for this class was generated from the following files: