Version

menu_open
Wwise SDK 2023.1.4

Emitter-listener pair: Positioning data pertaining to a single pair of emitter and listener. More...

#include <AkTypes.h>

Public Member Functions

 AkEmitterListenerPair ()
 Constructor. More...
 
 ~AkEmitterListenerPair ()
 Destructor. More...
 
AkReal32 Distance () const
 Get distance. More...
 
AkReal32 EmitterAngle () const
 
AkReal32 ListenerAngle () const
 
AkReal32 Occlusion () const
 Get the occlusion factor for this emitter-listener pair. More...
 
AkReal32 Obstruction () const
 Get the obstruction factor for this emitter-listener pair. More...
 
AkReal32 Diffraction () const
 Get the diffraction factor for this emitter-listener pair. More...
 
AkReal32 TransmissionLoss () const
 Get the transmission loss factor for this emitter-listener pair. More...
 
AkReal32 PathGain () const
 Get the overall path-contribution gain, used to scale the dry + gamedef + userdef gains. More...
 
AkReal32 GetGainForConnectionType (AkConnectionType in_eType) const
 Get the emitter-listener-pair-specific gain (due to distance and cone attenuation), linear [0,1], for a given connection type. More...
 
AkRayID ID () const
 Get the emitter-listener pair's ID. More...
 
AkGameObjectID ListenerID () const
 Get listener ID associated with the emitter-listener pair. More...
 

Public Attributes

AkWorldTransform emitter
 Emitter position. More...
 
AkReal32 fDistance
 Distance between emitter and listener. More...
 
AkReal32 fEmitterAngle
 Angle between position vector and emitter orientation. More...
 
AkReal32 fListenerAngle
 Angle between position vector and listener orientation. More...
 
AkReal32 fDryMixGain
 Emitter-listener-pair-specific gain (due to distance and cone attenuation) for direct connections. More...
 
AkReal32 fGameDefAuxMixGain
 Emitter-listener-pair-specific gain (due to distance and cone attenuation) for game-defined send connections. More...
 
AkReal32 fUserDefAuxMixGain
 Emitter-listener-pair-specific gain (due to distance and cone attenuation) for user-defined send connections. More...
 
AkReal32 fOcclusion
 Emitter-listener-pair-specific occlusion factor. More...
 
AkReal32 fObstruction
 Emitter-listener-pair-specific obstruction factor. More...
 
AkReal32 fDiffraction
 Emitter-listener-pair-specific diffraction coefficient. More...
 
AkReal32 fTransmissionLoss
 Emitter-listener-pair-specific transmission occlusion. More...
 
AkReal32 fSpread
 Emitter-listener-pair-specific spread. More...
 
AkReal32 fAperture
 Emitter-listener-pair-specific aperture. More...
 
AkReal32 fScalingFactor
 Combined scaling factor due to both emitter and listener. More...
 
AkReal32 fPathGain
 Emitter-listener-pair-specific overall gain that scales fDryMixGain, fGameDefAuxMixGain and fUserDefAuxMixGain. More...
 
AkChannelMask uEmitterChannelMask
 Channels of the emitter that apply to this ray. More...
 

Protected Attributes

AkRayID id
 ID of this emitter-listener pair, unique for a given emitter. More...
 
AkGameObjectID m_uListenerID
 Listener game object ID. More...
 

Detailed Description

Emitter-listener pair: Positioning data pertaining to a single pair of emitter and listener.

Definition at line 733 of file AkTypes.h.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise