1. Epic GamesDeveloper
  3. FAudioDevice

FAudioDevice

API > API/Runtime > API/Runtime/Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/AudioDevice.h
Include #include "AudioDevice.h"

Syntax

class FAudioDevice : public FExec

Variables

  Type Name Description
Protected variable double AudioClock The audio clock from the audio hardware. Not supported on all platforms.
Protected variable uint8: 1 bAllowCenterChannel3DPanning Whether or not we allow center channel panning (audio mixer only feature.)
Public variable uint8: 1 bAudioMixerModuleLoaded Whether or not the audio mixer module is being used by this device.
Public variable uint8: 1 bDisableAudioCaching HACK: Temporarily disable audio caching.
Public variable uint8: 1 bIsAudioDeviceHardwareInitialized Whether or not the lower-level audio device hardware initialized.
Public variable uint8: 1 bIsBakedAnalysisEnabled If baked analysis querying is enabled.
Public variable uint8: 1 bIsStoppingVoicesEnabled  
Public variable uint8: 1 bOcclusionIsExternalSend Whether or not various audio plugin interfaces are external sends.
Public variable uint8: 1 bReverbIsExternalSend  
Protected variable FAudioSpatializationInterfaceInfo * CurrentSpatializationInterfaceInfoPtr  
Protected variable FName CurrentSpatializationPluginInterfaceName 3rd party audio spatialization interface.
Protected variable FDelegateHandle DeviceCreatedHandle Handle for our device created delegate.
Protected variable float DeviceDeltaTime  
Protected variable FDelegateHandle DeviceDestroyedHandle Handle for our device destroyed delegate.
Public variable Audio::FDeviceId DeviceID The handle for this audio device used in the audio device manager.
Protected variable FAudioEffectsManager * Effects Interface to audio effects processing
Protected variable TArray< FSoundSource * > FreeSources  
Public variable TArray< FListenerProxy > ListenerProxies Game thread cache of listener transforms.
Protected variable TArray< FListener > Listeners Audio thread representation of listeners.
Public variable TAudioModulationPtr ModulationInterface 3rd party modulation interface
Public variable int32 NumPrecacheFrames The number of frames to precache.
Public variable int32 NumStoppingSources The number of sources to reserve for stopping sounds.
Public variable TAudioOcclusionPtr OcclusionInterface 3rd party occlusion interface.
Protected variable FOnAudioDevicePostRender OnAudioDevicePostRender Callback as audio device has just finished rendering a buffer.
Protected variable FOnAudioDevicePreRender OnAudioDevicePreRender Callback as audio device is about to render a buffer.
Public variable FAudioPlatformSettings PlatformSettings The platform specific audio settings.
Protected variable FAudioPluginInitializationParams PluginInitializationParams Cached parameters passed to the initialization of various audio plugins
Public variable TArray< TAudioPluginListenerPtr > PluginListeners 3rd party listener observers registered to this audio device.
Protected variable FCriticalSection RenderStateCallbackListCritSec  
Public variable TAudioReverbPtr ReverbPluginInterface 3rd party reverb interface.
Public variable int32 SampleRate The sample rate of all the audio devices
Public variable TAudioSourceDataOverridePtr SourceDataOverridePluginInterface 3rd party source data override interface.
Protected variable TArray< FSoundSource * > Sources  
Protected variable TArray< FAudioSpatializationInterfaceInfo > SpatializationInterfaces  

Constructors

  Type Name Description
Public function   Constructor

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

ActivateReverbEffect ( UReverbEffect* ReverbEffect,
FName TagName,
float Priority,
float Volume,
float FadeTime
)

 Activates a Reverb Effect without the need for a volume
Public function void  
Public function Virtual void

AddEnvelopeFollowerDelegate ( USoundSubmix* InSubmix,
const FOnSubmixEnvelopeBP& OnSubmixEnvelopeBP
)

 Adds an envelope follower delegate to the submix for this audio device.
Public function void

AddNewActiveSound ( const FActiveSound& ActiveSound,
TArray< FAudioParameter >&& InDefaultParams
)

 Adds an active sound to the audio device
Public function void

AddNewActiveSound ( const FActiveSound& ActiveSound,
const TArray< FAudioParameter >* InDefaultParams
)

 Adds an active sound to the audio device
Public function Virtual Audio::FPatchOutputStrongPtr

AddPatchForSubmix ( uint32 InObjectId,
float InPatchGain
)

  
Public function Virtual Audio::FPatchInput

AddPatchInputForAudioBus ( uint32 InAudioBusId,
int32 InFrames,
int32 InChannels,
float InGain
)

  
Public function Virtual Audio::FPatchOutputStrongPtr

AddPatchOutputForAudioBus ( uint32 InAudioBusId,
int32 InFrames,
int32 InChannels,
float InGain
)

  
Public function FDelegateHandle

AddPostRenderDelegate ( const FOnAudioDevicePostRender::FDelegate& InDelegate
)

  
Public function FDelegateHandle

AddPreRenderDelegate ( const FOnAudioDevicePreRender::FDelegate& InDelegate
)

  
Public function void Track references to UObjects
Public function void

AddSoundToStop ( FActiveSound* SoundToStop
)

 Marks a sound to be stopped. Returns true if added to stop, false if already pending stop.
Public function Virtual void

AddSpectralAnalysisDelegate ( USoundSubmix* InSubmix,
const FSoundSpectrumAnalyzerDelegateSettings& InDelegateSettings,
const FOnSubmixSpectralAnalysisBP& OnSubmixSpectralAnalysisBP
)

  
Public function void

AddVirtualLoop ( const FAudioVirtualLoop& InVirtualLoop
)

  
Public function Const void Applies interior settings from affecting volumes to the active sound (called on audio thread)
Public function Const bool  
Public function Const bool

CanHaveMultipleActiveSounds ( uint64 AudioComponentID
)

 Whether a given Audio Component ID should be allowed to have multiple associated Active Sounds
Public function Static bool Query if the editor is in VR Preview for the current play world.
Public function Const float

ClampPitch ( float InPitchScale
)

  
Public function void

ClearListenerAttenuationOverride ( int32 ListenerIndex
)

 Removes a listener attenuation override for the specified listener.
Public function void

ClearSoundMixClassOverride ( USoundMix* InSoundMix,
USoundClass* InSoundClass,
float FadeOutTime
)

 Clears a sound class override in the given sound mix.
Public function void Clear the effect of one SoundMix completely.
Public function void Clear the effect of all SoundMix modifiers.
Public function Virtual void

ClearSubmixEffectChainOverride ( USoundSubmix* InSoundSubmix,
float InCrossfadeTime
)

 Clears all submix effect chain overrides from the submix.
Public function Virtual void Counts the bytes for the structures used in this class
Public function Static UAudioComponent * Creates an audio component to handle playing a sound.
Public function Virtual FAudioEffectsManager * Creates a new platform specific sound source
Public function FSoundSource * Creates a new platform specific sound source
Public function void Deactivates a Reverb Effect not applied by a volume
Public function void De-initialization step that occurs after device destroyed broadcast, but before removal from the device manager
Public function void Platform dependent call to destroy any effect related data
Public function Virtual Const bool Whether or not the platform disables caching of decompressed PCM data (i.e. to save memory on fixed memory platforms
Public function Virtual void Enables the audio device to output debug audio to test audio device output.
Public function void

EnableRadioEffect ( bool bEnable
)

 Enables or Disables the radio effect.
Public function Virtual void

FadeIn ()

  
Public function Virtual void

FadeOut ()

 Optional fadeout and fade in of audio to avoid clicks when closing or opening/reusing audio device.
Public function Const int32

FindClosestListenerIndex ( const FTransform& SoundTransform
)

 Returns the index of the listener closest to the given sound transform
Public function Const int32

FindClosestListenerIndex ( const FVector& Position,
float& OutSqDistance,
bool AllowAttenuationOverrides
)

 Returns the index of the listener closest to the given sound transform
Public function Static int32

FindClosestListenerIndex ( const FTransform& SoundTransform,
const TArray< FListener >& InListeners
)

 Returns the index of the listener closest to the given sound transform
Public function void

Flush ( UWorld* WorldToFlush,
bool bClearActivatedReverb
)

 Stop all the audio components and sources attached to the world.
Public function Virtual void

FlushAudioRenderingCommands ( bool bPumpSynchronously
)

 Allows audio rendering command queue to flush during audio device flush.
Public function Virtual void

FlushExtended ( UWorld* WorldToFlush,
bool bClearActivatedReverb
)

 Derived classes can override this method to do their own cleanup.
Public function Const void

GatherInteriorData ( FActiveSound& ActiveSound,
FSoundParseParameters& ParseParams
)

 Gathers data about interior volumes affecting the active sound (called on audio thread)
Public function Const const TMap< FName, FActivatedReverb > &  
Public function Const const TArray< FActiveSound * > &  
Public function Const const TArray< FWaveInstance * > &  
Public function Const double Returns the audio clock of the audio device. Not supported on all platforms.
Public function Virtual Const void

GetAudioDeviceList ( TArray< FString >& OutAudioDeviceNames
)

 Returns an array of available audio devices names for the platform
Public function Static FAudioDeviceManager * Returns the audio device manager
Public function Const FName

GetAudioStateProperty ( const FName& PropertyName
)

  
Public function Virtual Const double Return the audio stream time
Public function Const void

GetAudioVolumeSettings ( const uint32 WorldID,
const FVector& Location,
FAudioVolumeSettings& OutSettings
)

  
Public function Const TArray< FName > Get the current list of available spatialization plugins
Public function Const void

GetAzimuth ( const FAttenuationListenerData& OutListenerData,
float& OutAzimuth,
float& AbsoluteAzimuth
)

 Returns the azimuth angle of the sound relative to the sound's nearest listener.
Public function Const int32 Returns the buffer length of the audio device.
Public function float  
Public function Const UReverbEffect * Returns the currently applied reverb effect if there is one.
Public function Virtual bool

GetCurrentSourceEffectChain ( const uint32 SourceEffectChainId,
TArray< FSourceEffectChainEntry >& OutCurrentSourceEffectChainEntries
)

 Returns the current source effect chain entries set dynamically from BP or elsewhere.
Public function FAudioSpatializationInterfaceInfo  
Public function Const bool

GetDefaultAudioSettings ( uint32 WorldID,
FReverbSettings& OutReverbSettings,
FInteriorSettings& OutInteriorSettings
)

 Gets the default reverb and interior settings for the provided world.
Public function USoundMix *  
Public function Const float Returns the default reverb send level used for sources which have reverb applied but no attenuation settings.
Public function Const float Returns the current audio device update delta time.
Public function Const bool

GetDistanceSquaredToListener ( const FVector& Location,
int32 ListenerIndex,
float& OutSqDistance
)

 Sets OutSqDistance to the distance from location to the appropriate listener representation, depending on calling thread.
Public function Const bool

GetDistanceSquaredToNearestListener ( const FVector& Location,
float& OutSqDistance
)

 Sets OutSqDistance to the distance from location the closest listener, depending on calling thread.
Public function Const float

GetDistanceToNearestListener ( const FVector& Location
)

 Returns the distance to the nearest listener from the given location
Public function Const const FAudioEffectsManager * Return the pointer to the sound effects handler
Public function FAudioEffectsManager * Return the pointer to the sound effects handler
Public function Const float

GetFocusFactor ( const float Azimuth,
const FSoundAttenuationSettings& AttenuationSettings
)

 Returns the focus factor of a sound based on its position and listener data.
Public function Const float Returns the game's delta time
Public function Const const FGlobalFocusSettings &  
Public function Const TRange< float > Returns global pitch range
Public function Const const FDynamicParameter &  
Public function Const const FVector &

GetListenerAttenuationOverride ( int32 ListenerIndex
)

 Returns the listener attenuation override for the specified listener
Public function Const bool

GetListenerPosition ( int32 ListenerIndex,
FVector& OutPosition,
bool bAllowOverride
)

 Returns a position from the appropriate listener representation, depending on calling thread.
Public function Const const TArray< FListener > &  
Public function Const bool

GetListenerTransform ( int32 ListenerIndex,
FTransform& OutTransform
)

 Returns the transform of the appropriate listener representation, depending on calling thread
Public function FVector

GetListenerTransformedDirection ( const FVector& Position,
float* OutDistance
)

 Gets the direction of the given position vector transformed relative to listener.
Public function Const bool

GetListenerWorldID ( int32 ListenerIndex,
uint32& OutWorldID
)

 Returns the WorldID of the appropriate listener representation, depending on calling thread
Public function Const float Low pass filter OneOverQ value
Public function Virtual void

GetMagnitudesForFrequencies ( USoundSubmix* InSubmix,
const TArray< float >& InFrequencies,
TArray< float >& OutMagnitudes
)

  
Public function Static FAudioDeviceHandle Returns the main audio device of the engine
Public function Const int32 Returns the max channels used by the audio device.
Public function void

GetMaxDistanceAndFocusFactor ( USoundBase* Sound,
const UWorld* World,
const FVector& Location,
const FSoundAttenuationSettings* AttenuationSettingsToApply,
float& OutMaxDistance,
float& OutFocusFactor
)

 Gets the max distance and focus factor of a sound.
Public function Const int32 Returns the maximum sources used by the audio device set on initialization, including the number of stopping voices reserved.
Public function Static float Returns the global maximum distance used in the audio engine.
Public function Const EDebugState Gets the current audio debug state
Public function Virtual Const int32 Returns the number of active sound sources
Public function Const int32 Returns the number of buffers the audio device keeps queued.
Public function Const int32 Returns the number of free sources.
Public function Virtual void

GetPhasesForFrequencies ( USoundSubmix* InSubmix,
const TArray< float >& InFrequencies,
TArray< float >& OutPhases
)

  
Public function Const float  
Public function Const const TArray< USoundMix * > &  
Public function Const float Returns the volume that combines transient master volume and the FApp::GetVolumeMultiplier() value
Public function Static const FAudioQualitySettings & Returns the quality settings used by the default audio settings.
Public function Const float Returns the sample rate used by the audio device.
Public function int32 Iterate over the active AudioComponents for wave instances that could be playing.
Public function FSoundClassProperties * Gets the current properties of a sound class, if the sound class hasn't been registered, then it returns nullptr
Public function FSoundClassDynamicProperties * Returns the parameters which are dynamic from the given sound class.
Public function Const const TMap< USoundMix *, FSoundMixState > &  
Public function Const FSoundSource *

GetSoundSource ( FWaveInstance* WaveInstance
)

  
Public function TAudioSpatializationPtr Return the spatialization plugin interface.
Public function Static TSubsystemClass *

GetSubsystem ( const FAudioDeviceHandle& InHandle
)

 Get a Subsystem of specified type from the provided AudioDeviceHandle returns nullptr if the Subsystem cannot be found or the AudioDeviceHandle is invalid
Public function Const TSubsystemClass * Get a Subsystem of specified type
Public function Const const TArray< TSubsystemClass * > & Gets all Subsystems of specified type, this is only necessary for interfaces that can have multiple implementations instanced at a time.
Public function Const UAudioEngineSubsystem * Get a Subsystem of specified type
Public function UAudioComponent *

GetTestComponent ( UWorld* InWorld
)

  
Public function Const float  
Public function Const const TMap< FWaveInstance *, FSoundSource * > &  
Protected function void

HandlePause ( bool bGameTicking,
bool bGlobalPause
)

 Handle pausing/unpausing of sources when entering or leaving pause mode, or global pause (like device suspend)
Public function Virtual bool Whether this SoundWave has an associated info class to decompress it
Public function bool

Init ( Audio::FDeviceId InDeviceID,
int32 InMaxSources,
int32 BufferSizeOverride,
int32 NumBuffersOverride
)

 Basic initialization of the platform agnostic layer of the audio system
Public function Virtual void Initialized audio buses marked as default that are to be enabled for the duration of the application.
Public function void *

InitEffect ( FSoundSource* Source
)

 Platform dependent call to init effect data on a sound source
Public function Virtual bool Starts up any platform specific hardware/APIs
Protected function void Create our subsystem collection root object and initialize subsystems
Public function void Set up the sound class hierarchy
Public function Virtual void  
Protected function void Set up the initial sound sources Allows us to initialize sound source early on, allowing for render callback hookups for iOS Audio.
Public function Virtual void Initializes sound submixes.
Public function Const void When the set of Audio volumes have changed invalidate the cached values of active sounds
Public function Virtual Const bool

IsAudioBusActive ( uint32 InAudioBusId
)

  
Public function Const bool  
Public function Const bool Returns if baked analysis querying is enabled.
Public function Virtual bool Check if any background music or sound is playing through the audio device
Public function Const bool Whether or not HRTF is disabled.
Public function Const bool Whether or not HRTF spatialization is enabled for all.
Protected function Const bool Whether the device was initialized.
Public function Const bool  
Public function Const bool Whether or not there's a modulation plugin enabled.
Public function Virtual Const bool  
Public function Const bool Whether or not there's an occlusion plugin enabled.
Public function Static bool  
Public function bool

IsPendingStop ( FActiveSound* ActiveSound
)

 Whether the provided ActiveSound is currently pending to stop
Public function Const bool Whether or not there's a reverb plugin enabled.
Public function Static bool  
Public function Const bool  
Public function Static bool  
Public function Const bool Whether or not there's a spatialization plugin enabled.
Public function Const bool Returns if stopping voices is enabled.
Public function Const bool

IsUsingListenerAttenuationOverride ( int32 ListenerIndex
)

 Returns if the specific listener is using an attenuation override position.
Public function Static bool  
Public function Const bool

LocationIsAudible ( const FVector& Location,
int32 ListenerIndex,
const float MaxDistance
)

 Checks to see if a coordinate is within a distance of a specific listener
Public function Const bool

LocationIsAudible ( const FVector& Location,
const float MaxDistance
)

 Checks to see if a coordinate is within a distance of any listener
Public function void

NotifyActiveSoundOcclusionTraceDone ( FActiveSound* ActiveSound,
bool bIsOccluded
)

 Notify that a pending async occlusion trace finished on the active sound.
Protected function Const void Notifies subsystems an active sound has been added (called on audio thread)
Protected function void  
Protected function void  
Protected function Const void Notifies subsystems an active sound is about to be deleted (called on audio thread)
Public function void

OnBeginPIE ( const bool bIsSimulating
)

 Deals with anything audio related that should happen when PIE starts
Public function void Called after FAudioDevice creation and init
Public function void Called before FAudioDevice teardown
Public function void

OnEndPIE ( const bool bIsSimulating
)

 Deals with anything audio related that should happen when PIE ends
Protected function Virtual void

OnListenerUpdated ( const TArray< FListener >& InListeners
)

 This is overridden in Audio::FMixerDevice to propogate listener information to the audio thread.
Public function void  
Public function void

PauseActiveSound ( uint64 AudioComponentID,
const bool bInIsPaused
)

 Pauses the active sound for the specified audio component
Public function void

PlaySoundAtLocation ( USoundBase* Sound,
UWorld* World,
float VolumeMultiplier,
float PitchMultiplier,
float StartTime,
const FVector& Location,
const FRotator& Rotation,
USoundAttenuation* AttenuationSettings,
USoundConcurrency* ConcurrencySettings,
const TArray< FAudioParameter >* Params,
const AActor* OwningActor
)

 Plays a sound at the given location without creating an audio component.
Public function Const bool Whether play when silent is enabled for all sounds associated with this audio device
Public function void

PopSoundMixModifier ( USoundMix* SoundMix,
bool bIsPassive
)

 Pop a SoundMix from the Audio Device's list.
Public function Virtual void

Precache ( USoundWave* SoundWave,
bool bSynchronous,
bool bTrackMemory,
bool bForceFullDecompression
)

 Precaches the passed in sound node wave object.Precaches the passed in sound node wave object.
Public function void Precaches all existing sounds. Called when audio setup is complete
Public function void

PushSoundMixModifier ( USoundMix* SoundMix,
bool bIsPassive,
bool bIsRetrigger
)

 Push a SoundMix onto the Audio Device's list.
Public function void

RegisterPluginListener ( const TAudioPluginListenerPtr PluginListener
)

 Registers a third party listener-observer to this audio device.
Public function void

RegisterSoundClass ( USoundClass* InSoundClass
)

 Registers a sound class with the audio device
Public function Virtual void

RegisterSoundSubmix ( USoundSubmixBase* SoundSubmix,
bool bInit
)

 Registers the sound submix
Public function Virtual void

RegisterSubmixBufferListener ( ISubmixBufferListener* InSubmixBufferListener,
USoundSubmix* SoundSubmix
)

 Registers the submix buffer listener with the given submix.
Public function void

RemoveActiveSound ( FActiveSound* ActiveSound
)

 Removes an active sound from the active sounds array
Public function void

RemoveAudioVolumeProxy ( uint32 AudioVolumeID
)

  
Public function bool  
Public function bool  
Public function void

RemoveSoundMix ( USoundMix* SoundMix
)

 Removes a sound mix - called when SoundMix is unloaded
Public function Virtual void

RemoveSpectralAnalysisDelegate ( USoundSubmix* InSubmix,
const FOnSubmixSpectralAnalysisBP& OnSubmixSpectralAnalysisBP
)

  
Public function void  
Public function void Resets all interpolating values to defaults.
Public function Virtual void Resume any context related objects
Public function void Attempts to retrigger a provided loop
Public function void

SendCommandToActiveSounds ( uint64 InAudioComponentID,
TUniqueFunction< void(FActiveSound&)> InFunc,
const TStatId InStatId
)

 Performs an operation on all active sounds requested to execute by an audio component
Public function void

SetAudioStateProperty ( const FName& PropertyName,
const FName& PropertyValue
)

  
Public function void

SetBaseSoundMix ( USoundMix* SoundMix
)

 Sets a new sound mix and applies it to all appropriate sound classes
Public function void

SetCanHaveMultipleActiveSounds ( uint64 AudioComponentID,
bool InCanHaveMultipleActiveSounds
)

 Set whether a given Audio Component ID should be allowed to have multiple associated Active Sounds
Public function bool Set and initialize the current Spatialization plugin (by name)
Public function void

SetDefaultAudioSettings ( UWorld* World,
const FReverbSettings& DefaultReverbSettings,
const FInteriorSettings& DefaultInteriorSettings
)

 Sets the default reverb and interior settings for the provided world
Public function void Sets the Sound Mix that should be active by default
Public function void

SetDeviceMuted ( bool bMuted
)

  
Public function void

SetGlobalFocusSettings ( const FGlobalFocusSettings& NewFocusSettings
)

  
Public function void

SetGlobalPitchModulation ( float PitchScale,
float TimeSec
)

  
Public function void

SetHRTFDisabled ( bool InIsHRTFDisabled
)

  
Public function void

SetHRTFEnabledForAll ( bool InbHRTFEnabledForAll
)

  
Public function void

SetListener ( UWorld* World,
int32 InListenerIndex,
const FTransform& ListenerTransform,
float InDeltaSeconds
)

 Sets the details about the listener
Public function void

SetListenerAttenuationOverride ( int32 ListenerIndex,
const FVector AttenuationPosition
)

 Sets an override position for the specified listener to do attenuation calculations.
Public function void

SetMaxChannels ( int32 InMaxChannels
)

 Sets the maximum number of channels dynamically.
Public function void

SetMaxChannelsScaled ( float InScaledChannelCount
)

 Sets the maximum number of channels dynamically by scaled percentage.
Public function void

SetMixDebugState ( EDebugState DebugState
)

  
Public function void

SetPlatformAudioHeadroom ( float PlatformHeadRoom
)

  
Public function void

SetSoundClassDistanceScale ( USoundClass* InSoundClass,
float DistanceScale,
float TimeSec
)

 Overrides the attenuation scale used on a sound class.
Public function void

SetSoundMixClassOverride ( USoundMix* InSoundMix,
USoundClass* InSoundClass,
float Volume,
float Pitch,
float FadeInTime,
bool bApplyToChildren
)

 Sets a sound class override in the given sound mix.
Public function void

SetSoundMixModifiers ( const TMap< USoundMix*, FSoundMixState >& InSoundMixModifiers,
const TArray< USoundMix* >& InPrevPassiveSoundMixModifiers,
USoundMix* InDefaultBaseSoundMix
)

  
Public function void

SetSpatializationInterfaceEnabled ( bool InbSpatializationInterfaceEnabled
)

  
Public function Virtual void

SetSubmixAutoDisable ( USoundSubmix* InSoundSubmix,
bool bInAutoDisable
)

 Set whether or not a submix is auto-disabled.
Public function Virtual void

SetSubmixAutoDisableTime ( USoundSubmix* InSoundSubmix,
float InDisableTime
)

 Set what the auto-disable time is.
Public function Virtual void

SetSubmixDryLevel ( USoundSubmix* InSoundSubmix,
float InDryLevel
)

 Set the wet-dry level of the given submix
Public function Virtual void

SetSubmixEffectChainOverride ( USoundSubmix* InSoundSubmix,
const TArray< FSoundEffectSubmixPtr >& InSubmixEffectChain,
float InCrossfadeTime
)

 Sets a submix effect chain override for the given submix
Public function Virtual void

SetSubmixModulationBaseLevels ( USoundSubmix* InSoundSubmix,
float InVolumeModBase,
float InWetModBase,
float InDryModBase
)

  
Public function Virtual void

SetSubmixOutputVolume ( USoundSubmix* InSoundSubmix,
float InOutputVolume
)

 Set the wet-dry level of the given submix
Public function Virtual void

SetSubmixWetDryLevel ( USoundSubmix* InSoundSubmix,
float InOutputVolume,
float InWetLevel,
float InDryLevel
)

 Set the wet-dry level of the given submix
Public function Virtual void

SetSubmixWetLevel ( USoundSubmix* InSoundSubmix,
float InWetLevel
)

 Set the wet-dry level of the given submix
Public function void

SetTransientPrimaryVolume ( float TransientPrimaryVolume
)

  
Public function void

SetUseAttenuationForNonGameWorlds ( bool bInUseAttenuationForNonGameWorlds
)

 Set whether or not we force the use of attenuation for non-game worlds (as by default we only care about game worlds)
Public function Const bool

ShouldUseRealtimeDecompression ( bool bForceFullDecompression,
const FSoundGroup& SoundGroup,
USoundWave* SoundWave,
float CompressedDurationThreshold
)

 Returns true if a sound wave should be decompressed.
Public function Virtual void Shutdown all audio buses marked as default.
Public function Const bool

SoundIsAudible ( USoundBase* Sound,
const UWorld* World,
const FVector& Location,
const FSoundAttenuationSettings* AttenuationSettingsToApply,
float MaxDistance,
float FocusFactor
)

 Checks if the given sound would be audible.
Public function bool  
Public function Virtual void

StartAudioBus ( uint32 InAudioBusId,
int32 InNumChannels,
bool bInIsAutomatic
)

  
Public function Virtual void This is called by a USoundSubmix to start envelope following on a submix isntance on this device.
Public function Virtual void

StartRecording ( USoundSubmix* InSubmix,
float ExpectedRecordingDuration
)

 This is called by a USoundSubmix to start recording a submix instance on this device.
Protected function void

StartSources ( TArray< FWaveInstance* >& WaveInstances,
int32 FirstActiveIndex,
bool bGameTicking
)

 Start and/or update any sources that have a high enough priority to play
Public function Virtual void  
Public function void

StopActiveSound ( FActiveSound* ActiveSound
)

 (Deprecated in favor of AddSoundToStop). Stops the active sound
Public function void

StopActiveSound ( uint64 AudioComponentID
)

 Removes the active sound for the specified audio component
Public function Virtual void

StopAllSounds ( bool bShouldStopUISounds
)

 Stops all game sounds (and possibly UI) sounds
Public function Virtual void

StopAudioBus ( uint32 InAudioBusId
)

  
Public function Virtual void This is called by a USoundSubmix when we stop envelope following a submix instance on this device.
Public function Virtual Audio::FAlignedFloatBuffer &

StopRecording ( USoundSubmix* InSubmix,
float& OutNumChannels,
float& OutSampleRate
)

 This is called by a USoundSubmix when we stop recording a submix on this device.
Public function void

StopSoundsUsingResource ( USoundWave* SoundWave,
TArray< UAudioComponent* >* StoppedComponents
)

 Stop any playing sounds that are using a particular SoundWave
Protected function void

StopSources ( TArray< FWaveInstance* >& WaveInstances,
int32 FirstActiveIndex
)

 Stop sources that need to be stopped, and touch the ones that need to be kept alive Stop sounds that are too low in priority to be played
Public function void Stops any sound sources which are using the given buffer.
Public function Virtual void  
Public function void  
Public function Virtual Const bool Whether this device supports realtime decompression of sound waves (i.e. DTYPE_RealTime)
Public function void

Suspend ( bool bGameTicking
)

 Suspend/resume all sounds (global pause for device suspend/resume, etc.)
Public function Virtual void Suspend any context related objects
Public function void Tears down the audio device
Public function Virtual void Shuts down any platform specific hardware/APIs
Public function void

UnlinkActiveSoundFromComponent ( const FActiveSound& InActiveSound
)

 Disables ActiveSound from responding to calls from its associated AudioComponent.
Public function void

UnregisterPluginListener ( const TAudioPluginListenerPtr PluginListener
)

 Unregisters a third party listener-observer to this audio device.
Public function void Unregisters a sound class
Public function Virtual void

UnregisterSoundSubmix ( const USoundSubmixBase* SoundSubmix
)

 Unregisters the sound submix
Public function Virtual void

UnregisterSubmixBufferListener ( ISubmixBufferListener* InSubmixBufferListener,
USoundSubmix* SoundSubmix
)

 Unregisters the submix buffer listener with the given submix.
Public function void

Update ( bool bGameTicking
)

 The audio system's main "Tick" function
Public function void

UpdateActiveSoundPlaybackTime ( bool bIsTimeTicking
)

 Update the active sound playback time. This is done here to do after all audio is updated.
Public function void  
Public function Virtual void Sets the update delta time for the audio frame
Public function void * Platform dependent call to update the sound output with new parameters The audio system's main "Tick" function
Public function Virtual void Update called on game thread.
Public function Virtual void Lets the platform any tick actions
Public function Virtual void Updates timing information for hardware.
Public function Virtual void

UpdateSourceEffectChain ( const uint32 SourceEffectChainId,
const TArray< FSourceEffectChainEntry >& SourceEffectChain,
const bool bPlayEffectChainTails
)

 Updates the source effect chain. Only implemented in audio mixer.
Public function Virtual void

UpdateSubmixModulationSettings ( USoundSubmix* InSoundSubmix,
const TSet< TObjectPtr< USoundModulatorBase >>& InOutputModulation,
const TSet< TObjectPtr< USoundModulatorBase >>& InWetLevelModulation,
const TSet< TObjectPtr< USoundModulatorBase >>& InDryLevelModulation
)

  
Public function Virtual void Updates the submix properties of any playing submix instances.
Public function void

UpdateVirtualLoops ( bool bForceUpdate
)

  
Public function Virtual bool

ValidateAPICall ( const TCHAR* Function,
uint32 ErrorCode
)

 Check for errors and output a human readable string

Classes

  Type Name Description
Public struct FAudioSpatializationInterfaceInfo    
Public struct FAudioVolumeSettings    
Public struct FCreateComponentParams    

Typedefs

Name Description
FToggleSoloPtr Handles all argument parsing for the solo commands in one place

Deprecated Variables

  Type Name Description
Public variable uint8: 1 bSpatializationIsExternalSend This member is no longer in use. Use the return value of GetCurrentSpatializationPluginInterfaceInfo()
Public variable int32 MaxChannelsSupportedBySpatializationPlugin This member is no longer in use. Use the return value of GetCurrentSpatializationPluginInterfaceInfo()
Public variable TAudioSpatializationPtr SpatializationPluginInterface Do not access this member directly, it is not used. Call GetSpatializationPluginInterface() instead.

Deprecated Functions

  Type Name Description
Public function Virtual Audio::FPatchOutputStrongPtr

AddPatchForAudioBus ( uint32 InAudioBusId,
float InPatchGain
)

 AddPatchForAudioBus is deprecated. Use AddPatchOutputForAudioBus.
Public function Virtual Audio::FPatchOutputStrongPtr

AddPatchForAudioBus_GameThread ( uint32 InAudioBusId,
float InPatchGain
)

 AddPatchForAudioBus_GameThread is deprecated. Use AddPatchOutputForAudioBus.
Public function Virtual void

AddPatchInputForAudioBus ( const Audio::FPatchInput& InPatchInput,
uint32 InAudioBusId,
float InPatchGain
)

 This overload of AddPatchInputForAudioBus is deprecated. Use the overload that takes the number of frames and channels as parameters.
Public function Virtual void

AddPatchInputForAudioBus_GameThread ( const Audio::FPatchInput& InPatchInput,
uint32 InAudioBusId,
float InPatchGain
)

 AddPatchInputForAudioBus_GameThread is deprecated. Use AddPatchInputForAudioBus.
Public function void Use ClearListenerAttenuationOverride that passes a ListenerIndex instead
Public function Virtual Const ICompressedAudioInfo *

CreateCompressedAudioInfo ( const USoundWave* SoundWave
)

 CreateCompressedAudioInfo is now deprecated. Please use IAudioInfoFactory::Create() instead
Public function Virtual Const ICompressedAudioInfo *

CreateCompressedAudioInfo ( const FSoundWaveProxyPtr& SoundWave
)

 CreateCompressedAudioInfo is now deprecated. Please use IAudioInfoFactory::Create() instead
Public function FActiveSound *

FindActiveSound ( uint64 AudioComponentID
)

 This call cannot be called from the GameThread & AudioComponents can now execute multiple ActiveSound instances at once. Use 'SendCommandToActiveSounds' instead.
Public function Const const FVector & Use ParseAttenuation that passes a ListenerIndex instead
Public function Const float GetMasterVolume has been deprecated. Please use GetPrimaryVolume instead.
Public function Const FName

GetRuntimeFormat ( const USoundWave* SoundWave
)

 GetRuntimeFormat is now deprecated. Please call SoundWave::GetRuntimeFormat() instead
Public function Const const TMap< USoundClass *, FSoundClassProperties > & Direct access of SoundClasses is no longer allowed. Instead you should use the SoundMixClassOverride system
Public function Const float

GetSquaredDistanceToListener ( const FVector& Location,
const FTransform& ListenerTransform
)

 Use GetDistanceSquaredToListener to check against a specific Listener
Public function Const float GetTransientMasterVolume has been deprecated. Please use GetTransientPrimaryVolume instead.
Public function Const bool Use ParseAttenuation that passes a ListenerIndex instead
Public function Const bool

LocationIsAudible ( const FVector& Location,
const FTransform& ListenerTransform,
const float MaxDistance
)

 Use LocationIsAudible that passes a ListenerIndex to check against a specific Listener
Public function Const void NotifyPending is deprecated in public scope. Use IActiveSoundUpdateInterface::OnNotifyPendingDelete instead.
Public function void

SetListenerAttenuationOverride ( const FVector AttenuationPosition
)

 Use SetListenerAttenuationOverride that passes a ListenerIndex instead
Public function void

SetTransientMasterVolume ( float TransientPrimaryVolume
)

 SetTransientMasterVolume has been deprecated. Please use SetTransientPrimaryVolume instead.
Public function Virtual void

UpdateSubmixModulationSettings ( USoundSubmix* InSoundSubmix,
USoundModulatorBase* InOutputModulation,
USoundModulatorBase* InWetLevelModulation,
USoundModulatorBase* InDryLevelModulation
)

 UpdateSubmixModulationSettings taking single modulators is deprecated. Use the overload that allows for modulator sets

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page