Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

IEAXListener Class Reference

Public EAX listener interface extension. More...

#include <IAudioExt.h>

List of all members.

Public Methods

virtual void SetRoom (int32 iRoom)=0
virtual void SetRoomHF (int32 iRoomHF)=0
virtual void SetRoomRolloffFactor (float fRoomRolloffFactor)=0
virtual void SetDecayTime (float fDecayTime)=0
virtual void SetDecayHFRatio (float fDecayHFRatio)=0
virtual void SetReflections (int32 iReflections)=0
virtual void SetReflectionsDelay (float fReflectionsDelay)=0
virtual void SetReverb (int32 iReverb)=0
virtual void SetReverbDelay (float fReverbDelay)=0
virtual void SetEnvironment (uint32 nEnvironment)=0
virtual void SetEnvironmentSize (float fEnvironmentSize)=0
virtual void SetEnvironmentDiffusion (float fEnvironmentDiffusion)=0
virtual void SetAirAbsorptionHF (float fAirAbsorption)=0
virtual void SetFlags (uint32 nFlags)=0
virtual void SetProperties (const EAXListenerProps &props)=0
virtual void GetProperties (EAXListenerProps &props)=0


Detailed Description

Public EAX listener interface extension.

IEAXListener is a public interface class designed to provide an easy-to-use interface to a listener's EAX properties. The interface is obtained through the function Listener::EAX(), and it always guaranteed to return a valid interface, even if EAX is disabled. The specialized interface is much easier to use than a generic property set interface. IEAXListener and any related structures and interfaces are based on the EAX 2.0 specifications.

See also:
IEAXBuffer, IListener, IListener::EAX()


Member Function Documentation

void IEAXListener::GetProperties ( EAXListenerProps & props ) [pure virtual]
 

Gets all current EAX listener parameters

Parameters:
props   all EAX listener properties

void IEAXListener::SetAirAbsorptionHF ( float fAirAbsorption ) [pure virtual]
 

Sets the air absorption factor

Parameters:
fAirAbsorption   Valid range from -100.0 to 0.0. Defaults to -5.0

void IEAXListener::SetDecayHFRatio ( float fDecayHFRatio ) [pure virtual]
 

Sets the decay high-frequency ratio.

Parameters:
fDecayHFRatio   Valid range from 0.1 to 2.0. Defaults to 0.83

void IEAXListener::SetDecayTime ( float fDecayTime ) [pure virtual]
 

Sets the reverberation decay time in seconds.

Parameters:
fRoomRolloffFactor   Valid range from 0.1 to 20.0. Defaults to 1.49

void IEAXListener::SetEnvironment ( uint32 nEnvironment ) [pure virtual]
 

Sets a preset environment (see eax documentation for listing)

Parameters:
nEnvironment   preset environment enumeration

void IEAXListener::SetEnvironmentDiffusion ( float fEnvironmentDiffusion ) [pure virtual]
 

Sets the level of environment diffusion

Parameters:
fEnvironmentDiffusion   Valid range from 0.0 to 1.0. Defaults to 1.0

void IEAXListener::SetEnvironmentSize ( float fEnvironmentSize ) [pure virtual]
 

Sets the approximate environment size in meters

Parameters:
fEnvironmentSize   Valid range from 1.0 to 100.0. Defaults to 7.5

void IEAXListener::SetFlags ( uint32 nFlags ) [pure virtual]
 

Sets all EAX listener flags - see EAX documentation for details

Parameters:
fEnvironmentDiffusion   all EAX listener flags

void IEAXListener::SetProperties ( const EAXListenerProps & props ) [pure virtual]
 

Sets all current EAX listener parameters

Parameters:
props   all EAX listener properties

void IEAXListener::SetReflections ( int32 iReflections ) [pure virtual]
 

Sets the early reflections level relative to room effect.

Parameters:
iReflections   Valid range from -10000 to 1000. Defaults to -2602

void IEAXListener::SetReflectionsDelay ( float fReflectionsDelay ) [pure virtual]
 

Sets the initial early reflections delay time.

Parameters:
fReflectionsDelay   Valid range from 0.0 to 0.3. Defaults to .007

void IEAXListener::SetReverb ( int32 iReverb ) [pure virtual]
 

Sets the reverberation level.

Parameters:
iReverb   Valid range from -10000 to 2000. Defaults to 200

void IEAXListener::SetReverbDelay ( float fReverbDelay ) [pure virtual]
 

Sets the late reverberation delay time relative to the early reflections delay time.

Parameters:
fReverbDelay   Valid range from 0.0 to 0.1. Defaults to 0.011

void IEAXListener::SetRoom ( int32 iRoom ) [pure virtual]
 

Sets the room effect level.

Parameters:
iRoom   Valid range from -10000 to 0. Defaults to -1000

void IEAXListener::SetRoomHF ( int32 iRoomHF ) [pure virtual]
 

Sets the room effect level at high frequencies.

Parameters:
iRoomHF   Valid range from -10000 to 0. Defaults to -1000

void IEAXListener::SetRoomRolloffFactor ( float fRoomRolloffFactor ) [pure virtual]
 

Sets the room effect rolloff factor.

Parameters:
fRoomRolloffFactor   Valid range from 0.0 to 10.0. Defaults to 0.0


The documentation for this class was generated from the following file:
Generated at Sun Jul 28 23:17:42 2002 for GAP Audio System by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001