UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FListener Struct Reference

#include <AudioDevice.h>

Public Member Functions

FVector GetUp () const
 
FVector GetFront () const
 
FVector GetRight () const
 
FVector GetPosition (bool bAllowOverride) const
 
float Interpolate (const double EndTime)
 
void UpdateCurrentInteriorSettings ()
 
void ApplyInteriorSettings (uint32 AudioVolumeID, const FInteriorSettings &Settings)
 
 FListener (FAudioDevice *InAudioDevice)
 

Public Attributes

FTransform Transform
 
FVector Velocity
 
FVector AttenuationOverride
 
uint32 bUseAttenuationOverride:1
 
struct FInteriorSettings InteriorSettings
 
uint32 AudioVolumeID
 
uint32 WorldID
 
int32 ListenerIndex
 
double InteriorStartTime
 
double InteriorEndTime
 
double ExteriorEndTime
 
double InteriorLPFEndTime
 
double ExteriorLPFEndTime
 
float InteriorVolumeInterp
 
float InteriorLPFInterp
 
float ExteriorVolumeInterp
 
float ExteriorLPFInterp
 
FAudioDeviceAudioDevice
 

Detailed Description

Defines the properties of the listener

Constructor & Destructor Documentation

◆ FListener()

FListener::FListener ( FAudioDevice InAudioDevice)
inline

Member Function Documentation

◆ ApplyInteriorSettings()

void FListener::ApplyInteriorSettings ( uint32  AudioVolumeID,
const FInteriorSettings Settings 
)

Apply the interior settings to ambient sounds

◆ GetFront()

FVector FListener::GetFront ( ) const
inline

◆ GetPosition()

FVector FListener::GetPosition ( bool  bAllowOverride) const

Gets the position of the listener

◆ GetRight()

FVector FListener::GetRight ( ) const
inline

◆ GetUp()

FVector FListener::GetUp ( ) const
inline

◆ Interpolate()

float FListener::Interpolate ( const double  EndTime)

Works out the interp value between source and end

◆ UpdateCurrentInteriorSettings()

void FListener::UpdateCurrentInteriorSettings ( )

Gets the current state of the interior settings for the listener

Member Data Documentation

◆ AttenuationOverride

FVector FListener::AttenuationOverride

An attenuation override to use for distance and attenuation calculations

◆ AudioDevice

FAudioDevice* FListener::AudioDevice

◆ AudioVolumeID

uint32 FListener::AudioVolumeID

The ID of the volume the listener resides in

◆ bUseAttenuationOverride

uint32 FListener::bUseAttenuationOverride

Is our attenuation override active

◆ ExteriorEndTime

double FListener::ExteriorEndTime

◆ ExteriorLPFEndTime

double FListener::ExteriorLPFEndTime

◆ ExteriorLPFInterp

float FListener::ExteriorLPFInterp

◆ ExteriorVolumeInterp

float FListener::ExteriorVolumeInterp

◆ InteriorEndTime

double FListener::InteriorEndTime

◆ InteriorLPFEndTime

double FListener::InteriorLPFEndTime

◆ InteriorLPFInterp

float FListener::InteriorLPFInterp

◆ InteriorSettings

struct FInteriorSettings FListener::InteriorSettings

◆ InteriorStartTime

double FListener::InteriorStartTime

The times of interior volumes fading in and out

◆ InteriorVolumeInterp

float FListener::InteriorVolumeInterp

◆ ListenerIndex

int32 FListener::ListenerIndex

Index of this listener inside the AudioDevice's listener array

◆ Transform

FTransform FListener::Transform

◆ Velocity

FVector FListener::Velocity

◆ WorldID

uint32 FListener::WorldID

The ID of the world the listener resides in


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