SFXVoice Class Reference

#include <sfxVoice.h>

Inheritance diagram for SFXVoice:

Inheritance graph
[legend]
List of all members.

Detailed Description

The voice interface provides for playback of sound buffers and positioning of 3D sounds.


Public Member Functions

virtual ~SFXVoice ()
 The destructor.
virtual void setPosition (U32 pos)=0
 Sets the playback sample position.
virtual SFXStatus getStatus () const =0
virtual void play (bool looping)=0
 Starts playback from the current position.
virtual void stop ()=0
 Stops playback and moves the position to the start.
virtual void pause ()=0
 Pauses playback.
virtual void setTransform (const MatrixF &transform)=0
 Sets the position and orientation for a 3d voice.
virtual void setVelocity (const VectorF &velocity)=0
 Sets the velocity for a 3d voice.
virtual void setMinMaxDistance (F32 min, F32 max)=0
 Sets the minimum and maximum distances for 3d falloff.
virtual void setVolume (F32 volume)=0
 Sets the volume.
virtual void setPitch (F32 pitch)=0
 Sets the pitch scale.
virtual void setCone (F32 innerAngle, F32 outerAngle, F32 outerVolume)=0
 Set sound cone of a 3D sound.

Protected Member Functions

 SFXVoice ()


Constructor & Destructor Documentation

SFXVoice::SFXVoice (  )  [inline, explicit, protected]

virtual SFXVoice::~SFXVoice (  )  [inline, virtual]

The destructor.


Member Function Documentation

virtual void SFXVoice::setPosition ( U32  pos  )  [pure virtual]

Sets the playback sample position.

Implemented in SFXDSVoice, SFXFMODVoice, SFXNullVoice, SFXALVoice, and SFXXAudioVoice.

virtual SFXStatus SFXVoice::getStatus (  )  const [pure virtual]

virtual void SFXVoice::play ( bool  looping  )  [pure virtual]

Starts playback from the current position.

Implemented in SFXDSVoice, SFXFMODVoice, SFXNullVoice, SFXALVoice, and SFXXAudioVoice.

virtual void SFXVoice::stop (  )  [pure virtual]

Stops playback and moves the position to the start.

Implemented in SFXDSVoice, SFXFMODVoice, SFXNullVoice, SFXALVoice, and SFXXAudioVoice.

virtual void SFXVoice::pause (  )  [pure virtual]

Pauses playback.

Implemented in SFXDSVoice, SFXFMODVoice, SFXNullVoice, SFXALVoice, and SFXXAudioVoice.

virtual void SFXVoice::setTransform ( const MatrixF transform  )  [pure virtual]

Sets the position and orientation for a 3d voice.

Implemented in SFXDSVoice, SFXFMODVoice, SFXNullVoice, SFXALVoice, and SFXXAudioVoice.

virtual void SFXVoice::setVelocity ( const VectorF velocity  )  [pure virtual]

Sets the velocity for a 3d voice.

Implemented in SFXDSVoice, SFXFMODVoice, SFXNullVoice, SFXALVoice, and SFXXAudioVoice.

virtual void SFXVoice::setMinMaxDistance ( F32  min,
F32  max 
) [pure virtual]

Sets the minimum and maximum distances for 3d falloff.

Implemented in SFXDSVoice, SFXFMODVoice, SFXNullVoice, SFXALVoice, and SFXXAudioVoice.

virtual void SFXVoice::setVolume ( F32  volume  )  [pure virtual]

Sets the volume.

Implemented in SFXDSVoice, SFXFMODVoice, SFXNullVoice, SFXALVoice, and SFXXAudioVoice.

virtual void SFXVoice::setPitch ( F32  pitch  )  [pure virtual]

Sets the pitch scale.

Implemented in SFXDSVoice, SFXFMODVoice, SFXNullVoice, SFXALVoice, and SFXXAudioVoice.

virtual void SFXVoice::setCone ( F32  innerAngle,
F32  outerAngle,
F32  outerVolume 
) [pure virtual]

Set sound cone of a 3D sound.

Implemented in SFXDSVoice, SFXFMODVoice, SFXNullVoice, SFXALVoice, and SFXXAudioVoice.