Linderdaum Engine: iAudioSource Class Reference
Updated: Mon May 14 2012 05:02:36
iAudioSource Class Reference

Audio source interface, also directly used in silent mode. More...

#include <Audio.h>

List of all members.

Public Member Functions

 iAudioSource ()
virtual void Play ()
virtual void Stop ()
virtual void Pause ()
virtual void LoopSound (const bool Loop)
virtual bool IsPlaying () const
virtual void Update (float DeltaSeconds)
 Dummy sound source.
virtual void SetPosition (const LVector3 &Position)
virtual void SetVelocity (const LVector3 &Velocity)
virtual void SetDirection (const LVector3 &Direction)
virtual vec3 GetPosition () const
virtual vec3 GetVelocity () const
virtual vec3 GetDirection () const
virtual void SetFadeVolume (float Volume)
 Set desired fade volume level.
virtual float GetFadeVolume () const
 Get current desired fade volume level.
virtual void SetVolume (float Volume)
 Set current volume and reset fading effect.
virtual void SetVolumeNoFade (float Volume)
 Set current volume (fade will continue to the desired level)
virtual float GetVolume () const
 Get current volume.
virtual void SetPitch (float Pitch)
virtual float GetPitch () const
virtual void BindWaveform (iWaveform *Waveform)
virtual iWaveDataProviderGetCurrentDataProvider () const
virtual iWaveformGetWaveform () const
 Get current waveform for adjustment.
virtual iAudioFilterGetFilter () const
 Get current filter.
virtual void SetFilter (iAudioFilter *F)
 Set current filter/source listener.

Protected Attributes

iAudioFilterFFilter
 Direct pointer to the audio filter (owned externally)

Private Attributes

vec3 FPosition
 Cached position.
vec3 FVelocity
 Cached velocity.
vec3 FDirection
 Cached direction.
float FPitch
float FVolume
float FFadeVolume

Detailed Description

Audio source interface, also directly used in silent mode.


Constructor & Destructor Documentation

iAudioSource::iAudioSource ( ) [inline]

Member Function Documentation

virtual void iAudioSource::BindWaveform ( iWaveform Waveform) [inline, virtual]

Reimplemented in clAudioSource_FMOD, and clAudioSource_OpenAL.

virtual iWaveDataProvider* iAudioSource::GetCurrentDataProvider ( ) const [inline, virtual]

Reimplemented in clAudioSource_OpenAL.

virtual vec3 iAudioSource::GetDirection ( ) const [inline, virtual]
virtual float iAudioSource::GetFadeVolume ( ) const [inline, virtual]

Get current desired fade volume level.

virtual iAudioFilter* iAudioSource::GetFilter ( ) const [inline, virtual]

Get current filter.

virtual float iAudioSource::GetPitch ( ) const [inline, virtual]
virtual vec3 iAudioSource::GetPosition ( ) const [inline, virtual]
virtual vec3 iAudioSource::GetVelocity ( ) const [inline, virtual]
virtual float iAudioSource::GetVolume ( ) const [inline, virtual]

Get current volume.

virtual iWaveform* iAudioSource::GetWaveform ( ) const [inline, virtual]

Get current waveform for adjustment.

Reimplemented in clAudioSource_OpenAL.

virtual bool iAudioSource::IsPlaying ( ) const [inline, virtual]

Reimplemented in clAudioSource_FMOD, and clAudioSource_OpenAL.

virtual void iAudioSource::LoopSound ( const bool  Loop) [inline, virtual]

Reimplemented in clAudioSource_FMOD, and clAudioSource_OpenAL.

virtual void iAudioSource::Pause ( ) [inline, virtual]

Reimplemented in clAudioSource_FMOD, and clAudioSource_OpenAL.

virtual void iAudioSource::Play ( ) [inline, virtual]

Reimplemented in clAudioSource_FMOD, and clAudioSource_OpenAL.

virtual void iAudioSource::SetDirection ( const LVector3 Direction) [inline, virtual]

Reimplemented in clAudioSource_OpenAL.

virtual void iAudioSource::SetFadeVolume ( float  Volume) [inline, virtual]

Set desired fade volume level.

virtual void iAudioSource::SetFilter ( iAudioFilter F) [inline, virtual]

Set current filter/source listener.

virtual void iAudioSource::SetPitch ( float  Pitch) [inline, virtual]

Reimplemented in clAudioSource_OpenAL.

virtual void iAudioSource::SetPosition ( const LVector3 Position) [inline, virtual]

Reimplemented in clAudioSource_OpenAL.

virtual void iAudioSource::SetVelocity ( const LVector3 Velocity) [inline, virtual]

Reimplemented in clAudioSource_OpenAL.

virtual void iAudioSource::SetVolume ( float  Volume) [inline, virtual]

Set current volume and reset fading effect.

Reimplemented in clAudioSource_OpenAL.

virtual void iAudioSource::SetVolumeNoFade ( float  Volume) [inline, virtual]

Set current volume (fade will continue to the desired level)

Reimplemented in clAudioSource_OpenAL.

virtual void iAudioSource::Stop ( ) [inline, virtual]

Reimplemented in clAudioSource_FMOD, and clAudioSource_OpenAL.

void iAudioSource::Update ( float  DeltaSeconds) [virtual]

Dummy sound source.

Reimplemented in clAudioSource_OpenAL.


Member Data Documentation

Cached direction.

Direct pointer to the audio filter (owned externally)

Cached position.

Cached velocity.


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