SoundSource Class Reference

A sound source represents the source of audio output. More...

#include <sound_source.hpp>

Inherited by DummySoundSource, and OpenALSoundSource.

List of all members.

Public Member Functions
virtual	~SoundSource ()
virtual void	play ()=0
virtual void	stop ()=0
virtual bool	playing ()=0
virtual void	set_looping (bool looping)=0
virtual void	set_relative (bool relative)=0
virtual void	set_gain (float gain)=0
	Set volume (0.0 is silent, 1.0 is normal).
virtual void	set_pitch (float pitch)=0
virtual void	set_position (const Vector &position)=0
virtual void	set_velocity (const Vector &velocity)=0
virtual void	set_reference_distance (float distance)=0

---

Detailed Description

A sound source represents the source of audio output.

You can place sources at certain points in your world or set their velocity to produce doppler effects

Definition at line 27 of file sound_source.hpp.

---

Constructor & Destructor Documentation

virtual SoundSource::~SoundSource

(

)

[inline, virtual]

Definition at line 30 of file sound_source.hpp.

  { }

---

Member Function Documentation

virtual void SoundSource::play

(

)

[pure virtual]

Implemented in DummySoundSource, and OpenALSoundSource.

Referenced by AmbientSound::start_playing().

virtual void SoundSource::stop

(

)

[pure virtual]

Implemented in DummySoundSource, and OpenALSoundSource.

virtual bool SoundSource::playing

(

)

[pure virtual]

Implemented in DummySoundSource, and OpenALSoundSource.

virtual void SoundSource::set_looping

(

bool

looping

)

[pure virtual]

Implemented in DummySoundSource, OpenALSoundSource, and StreamSoundSource.

Referenced by AmbientSound::start_playing().

virtual void SoundSource::set_relative

(

bool

relative

)

[pure virtual]

Implemented in DummySoundSource, and OpenALSoundSource.

virtual void SoundSource::set_gain

(

float

gain

)

[pure virtual]

Set volume (0.0 is silent, 1.0 is normal).

Implemented in DummySoundSource, and OpenALSoundSource.

Referenced by AmbientSound::start_playing(), and AmbientSound::update().

virtual void SoundSource::set_pitch

(

float

pitch

)

[pure virtual]

Implemented in DummySoundSource, and OpenALSoundSource.

virtual void SoundSource::set_position

(

const Vector &

position

)

[pure virtual]

Implemented in DummySoundSource, and OpenALSoundSource.

virtual void SoundSource::set_velocity

(

const Vector &

velocity

)

[pure virtual]

Implemented in DummySoundSource, and OpenALSoundSource.

virtual void SoundSource::set_reference_distance

(

float

distance

)

[pure virtual]

Implemented in DummySoundSource, and OpenALSoundSource.

---

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

• src/audio/sound_source.hpp

---