Public Member Functions | Friends

sp::audio::OpenALSoundDevice Class Reference

#include <spOpenALSoundDevice.hpp>

Inheritance diagram for sp::audio::OpenALSoundDevice:
sp::audio::SoundDevice

List of all members.

Public Member Functions

 OpenALSoundDevice ()
 ~OpenALSoundDevice ()
io::stringc getInterface () const
 Returns the interface name of the sound system (e.g. "WinMM", "OpenSL|ES" or "OpenAL 1.1").
Sound * createSound ()
SoundEffect * createSoundEffect ()
void updateSounds ()
 Updates all sounds.
void setListenerPosition (const dim::vector3df &Position)
void setListenerVelocity (const dim::vector3df &Velocity)
void setListenerOrientation (const dim::matrix4f &Orientation)
void setListenerSpeed (f32 Speed)
 Sets the global listener speed for all sounds. By default 1.0.
void setEffectSlot (SoundEffect *Sfx)

Friends

class OpenALSound

Constructor & Destructor Documentation

sp::audio::OpenALSoundDevice::OpenALSoundDevice (  ) 
sp::audio::OpenALSoundDevice::~OpenALSoundDevice (  ) 

Member Function Documentation

Sound* sp::audio::OpenALSoundDevice::createSound (  )  [virtual]

Creates a sound where no sound-file will be loaded.

Returns:
Pointer to the new Sound object.

Implements sp::audio::SoundDevice.

SoundEffect* sp::audio::OpenALSoundDevice::createSoundEffect (  )  [virtual]

Creates a new sound effect. You can exchange the effects for each sound dynamically.

Returns:
Pointer to the new SoundEffect object.

Reimplemented from sp::audio::SoundDevice.

io::stringc sp::audio::OpenALSoundDevice::getInterface (  )  const [virtual]

Returns the interface name of the sound system (e.g. "WinMM", "OpenSL|ES" or "OpenAL 1.1").

Implements sp::audio::SoundDevice.

void sp::audio::OpenALSoundDevice::setEffectSlot ( SoundEffect *  Sfx  )  [virtual]

Sets the effect slot. Currently only one sound effect can be used at a time. But each sound can use this effect individually, i.e. a sound can be played (or emitted) with this active sound effect or not.

Reimplemented from sp::audio::SoundDevice.

void sp::audio::OpenALSoundDevice::setListenerOrientation ( const dim::matrix4f &  Orientation  )  [virtual]

Sets the 3D listener orientation.

Parameters:
Orientation,: Transformation matrix which describes the 3D listener's rotation. Use the "getRotationMatrix" function of the active Camera.

Reimplemented from sp::audio::SoundDevice.

void sp::audio::OpenALSoundDevice::setListenerPosition ( const dim::vector3df &  Position  )  [virtual]

Sets the 3D listener position.

Parameters:
Position,: 3D position of the listener. Normally the camera position.

Reimplemented from sp::audio::SoundDevice.

void sp::audio::OpenALSoundDevice::setListenerSpeed ( f32  Speed  )  [virtual]

Sets the global listener speed for all sounds. By default 1.0.

Reimplemented from sp::audio::SoundDevice.

void sp::audio::OpenALSoundDevice::setListenerVelocity ( const dim::vector3df &  Velocity  )  [virtual]

Sets the 3D listener velocity. Used for the doppler effect (not supported yet, implemented for futured sound systems).

Parameters:
Velocity,: Velocity or speed of the movable 3D listener.

Reimplemented from sp::audio::SoundDevice.

void sp::audio::OpenALSoundDevice::updateSounds (  )  [virtual]

Updates all sounds.

Reimplemented from sp::audio::SoundDevice.

Friends And Related Function Documentation

friend class OpenALSound [friend]
The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Apr 4 2013 23:22:54 for SoftPixel Engine by  doxygen 1.7.1