Choose your operating system:
Windows
macOS
Linux
| FExec
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Public/AudioDevice.h |
Include |
#include "AudioDevice.h" |
class FAudioDevice : public FExec
Name | Description | ||
---|---|---|---|
|
double |
AudioClock |
The audio clock from the audio hardware. Not supported on all platforms. |
|
uint8: 1 |
bAllowCenterChannel3DPanning |
Whether or not we allow center channel panning (audio mixer only feature.) |
|
uint8: 1 |
bAudioMixerModuleLoaded |
Whether or not the audio mixer module is being used by this device. |
|
uint8: 1 |
bDisableAudioCaching |
HACK: Temporarily disable audio caching. |
|
uint8: 1 |
bIsAudioDeviceHardwareInitialized |
Whether or not the lower-level audio device hardware initialized. |
|
uint8: 1 |
bIsBakedAnalysisEnabled |
If baked analysis querying is enabled. |
|
uint8: 1 |
bIsStoppingVoicesEnabled |
|
|
uint8: 1 |
bOcclusionIsExternalSend |
|
|
uint8: 1 |
bReverbIsExternalSend |
|
|
uint8: 1 |
bSpatializationIsExternalSend |
Whether of not various audio plugin interfaces are external sends. |
|
DeviceCreatedHandle |
Handle for our device created delegate. |
|
|
float |
DeviceDeltaTime |
|
|
DeviceDestroyedHandle |
Handle for our device destroyed delegate. |
|
|
DeviceID |
The handle for this audio device used in the audio device manager. |
|
|
Effects |
Interface to audio effects processing |
|
|
FreeSources |
||
|
ListenerProxies |
Game thread cache of listener transforms. |
|
|
Listeners |
Audio thread representation of listeners. |
|
|
MaxChannelsSupportedBySpatializationPlugin |
Max amount of channels a source can be to be spatialized by our active spatialization plugin. |
|
|
ModulationInterface |
3rd party modulation interface |
|
|
NumPrecacheFrames |
The number of frames to precache. |
|
|
NumStoppingSources |
The number of sources to reserve for stopping sounds. |
|
|
OcclusionInterface |
3rd party occlusion interface. |
|
|
PlatformSettings |
The platform specific audio settings. |
|
|
PluginListeners |
3rd party listener observers registered to this audio device. |
|
|
ReverbPluginInterface |
3rd party reverb interface. |
|
|
SampleRate |
The sample rate of all the audio devices |
|
|
SourceDataOverridePluginInterface |
3rd party source data override interface. |
|
|
Sources |
||
|
SpatializationPluginInterface |
3rd party audio spatialization interface. |
Name | Description | |
---|---|---|
|
FAudioDevice() |
Constructor |
Name | Description | |
---|---|---|
|
~FAudioDevice() |
Name | Description | ||
---|---|---|---|
|
ActivateReverbEffect ( |
Activates a Reverb Effect without the need for a volume |
|
|
AddAudioVolumeProxy ( |
||
|
AddEnvelopeFollowerDelegate ( |
Adds an envelope follower delegate to the submix for this audio device. |
|
|
AddNewActiveSound ( |
Adds an active sound to the audio device |
|
|
AddNewActiveSound ( |
Adds an active sound to the audio device |
|
|
Audio::FPatc... |
AddPatchForSubmix ( |
|
|
AddReferencedObjects ( |
Track references to UObjects |
|
|
AddSoundToStop ( |
Marks a sound to be stopped. Returns true if added to stop, false if already pending stop. |
|
|
AddSpectralAnalysisDelegate ( |
||
|
AddVirtualLoop ( |
||
|
ApplyInteriorSettings ( |
Applies interior settings from affecting volumes to the active sound (called on audio thread) |
|
|
AreStartupSoundsPreCached() |
||
|
CanHaveMultipleActiveSounds ( |
Whether a given Audio Component ID should be allowed to have multiple associated Active Sounds |
|
|
CanUseVRAudioDevice() |
Query if the editor is in VR Preview for the current play world. |
|
|
float |
ClampPitch ( |
|
|
ClearListenerAttenuationOverride ( |
Removes a listener attenuation override for the specified listener. |
|
|
ClearSoundMixClassOverride ( |
Clears a sound class override in the given sound mix. |
|
|
ClearSoundMixModifier ( |
Clear the effect of one SoundMix completely. |
|
|
ClearSoundMixModifiers() |
Clear the effect of all SoundMix modifiers. |
|
|
ClearSubmixEffectChainOverride ( |
Clears all submix effect chain overrides from the submix. |
|
|
CountBytes ( |
Counts the bytes for the structures used in this class |
|
|
UAudioCompon... |
CreateComponent ( |
|
|
ICompressedA... |
CreateCompressedAudioInfo ( |
|
|
ICompressedA... |
CreateCompressedAudioInfo ( |
Creates a Compressed audio info class suitable for decompressing this SoundWave |
|
FAudioEffect... |
CreateEffectsManager() |
Creates a new platform specific sound source |
|
FSoundSource... |
CreateSoundSource() |
Creates a new platform specific sound source |
|
DeactivateReverbEffect ( |
Deactivates a Reverb Effect not applied by a volume |
|
|
Deinitialize() |
De-initialization step that occurs after device destroyed broadcast, but before removal from the device manager |
|
|
DestroyEffect ( |
Platform dependent call to destroy any effect related data |
|
|
DisablePCMAudioCaching() |
Whether or not the platform disables caching of decompressed PCM data (i.e. to save memory on fixed memory platforms |
|
|
EnableDebugAudioOutput() |
Enables the audio device to output debug audio to test audio device output. |
|
|
EnableRadioEffect ( |
Enables or Disables the radio effect. |
|
|
FadeIn() |
||
|
FadeOut() |
Optional fadeout and fade in of audio to avoid clicks when closing or opening/reusing audio device. |
|
|
FindClosestListenerIndex ( |
Returns the index of the listener closest to the given sound transform |
|
|
FindClosestListenerIndex ( |
Returns the index of the listener closest to the given sound transform |
|
|
FindClosestListenerIndex |
Returns the index of the listener closest to the given sound transform |
|
|
Flush |
Stop all the audio components and sources attached to the world. |
|
|
FlushAudioRenderingCommands ( |
Allows audio rendering command queue to flush during audio device flush. |
|
|
FlushExtended |
Derived classes can override this method to do their own cleanup. |
|
|
GatherInteriorData ( |
Gathers data about interior volumes affecting the active sound (called on audio thread) |
|
|
const TMap< ... |
GetActiveReverb() |
|
|
const TArray... |
GetActiveSounds() |
|
|
const TArray... |
GetActiveWaveInstances() |
|
|
double |
GetAudioClock() |
Returns the audio clock of the audio device. Not supported on all platforms. |
|
GetAudioDeviceList |
Returns an array of available audio devices names for the platform |
|
|
FAudioDevice... |
GetAudioDeviceManager() |
Returns the audio device manager |
|
GetAudioStateProperty ( |
||
|
double |
GetAudioTime() |
Return the audio stream time |
|
GetAudioVolumeSettings ( |
||
|
GetAzimuth ( |
Returns the azimuth angle of the sound relative to the sound's nearest listener. |
|
|
GetBufferLength() |
Returns the buffer length of the audio device. |
|
|
float |
GetCompressionDurationThreshold ( |
|
|
UReverbEffec... |
GetCurrentReverbEffect() |
Returns the currently applied reverb effect if there is one. |
|
GetCurrentSourceEffectChain ( |
Returns the current source effect chain entries set dynamically from BP or elsewhere. |
|
|
GetDefaultAudioSettings ( |
Gets the default reverb and interior settings for the provided world. |
|
|
USoundMix &#... |
GetDefaultBaseSoundMixModifier() |
|
|
float |
GetDefaultReverbSendLevel() |
Returns the default reverb send level used for sources which have reverb applied but no attenuation settings. |
|
float |
GetDeviceDeltaTime() |
Returns the current audio device update delta time. |
|
GetDistanceSquaredToListener |
Sets OutSqDistance to the distance from location to the appropriate listener representation, depending on calling thread. |
|
|
GetDistanceSquaredToNearestListener ( |
Sets OutSqDistance to the distance from location the closest listener, depending on calling thread. |
|
|
float |
GetDistanceToNearestListener ( |
Returns the distance to the nearest listener from the given location |
|
const FAudio... |
GetEffects() |
Return the pointer to the sound effects handler |
|
FAudioEffect... |
GetEffects() |
Return the pointer to the sound effects handler |
|
float |
GetFocusFactor ( |
Returns the focus factor of a sound based on its position and listener data. |
|
float |
GetGameDeltaTime() |
Returns the game's delta time |
|
const FGloba... |
GetGlobalFocusSettings() |
|
|
TRange< floa... |
GetGlobalPitchRange() |
Returns global pitch range |
|
const FDynam... |
GetGlobalPitchScale() |
|
|
const FVecto... |
GetListenerAttenuationOverride ( |
Returns the listener attenuation override for the specified listener |
|
GetListenerPosition |
Returns a position from the appropriate listener representation, depending on calling thread. |
|
|
const TArray... |
GetListeners() |
|
|
GetListenerTransform ( |
Returns the transform of the appropriate listener representation, depending on calling thread |
|
|
GetListenerTransformedDirection ( |
Gets the direction of the given position vector transformed relative to listener. |
|
|
GetListenerWorldID |
Returns the WorldID of the appropriate listener representation, depending on calling thread |
|
|
float |
GetLowPassFilterResonance() |
Low pass filter OneOverQ value |
|
GetMagnitudesForFrequencies ( |
||
|
FAudioDevice... |
GetMainAudioDevice() |
Returns the main audio device of the engine |
|
float |
GetMasterVolume() |
Returns the volume that combines transient master volume and the FApp::GetVolumeMultiplier() value |
|
GetMaxChannels() |
Returns the max channels used by the audio device. |
|
|
GetMaxDistanceAndFocusFactor ( |
Gets the max distance and focus factor of a sound. |
|
|
GetMaxSources() |
Returns the maximum sources used by the audio device set on initialization, including the number of stopping voices reserved. |
|
|
GetMixDebugState() |
Gets the current audio debug state |
|
|
GetNumActiveSources() |
Returns the number of active sound sources |
|
|
GetNumFreeSources() |
Returns the number of free sources. |
|
|
GetPhasesForFrequencies ( |
||
|
float |
GetPlatformAudioHeadroom() |
|
|
const TArray... |
GetPrevPassiveSoundMixModifiers() |
|
|
const FAudio... |
GetQualityLevelSettings() |
Returns the quality settings used by the default audio settings. |
|
GetRuntimeFormat ( |
||
|
float |
GetSampleRate() |
Returns the sample rate used by the audio device. |
|
GetSortedActiveWaveInstances ( |
Iterate over the active AudioComponents for wave instances that could be playing. |
|
|
FSoundClassP... |
GetSoundClassCurrentProperties ( |
Gets the current properties of a sound class, if the sound class hasn't been registered, then it returns nullptr |
|
FSoundClassD... |
GetSoundClassDynamicProperties ( |
Returns the parameters which are dynamic from the given sound class. |
|
const TMap< ... |
GetSoundMixModifiers() |
|
|
FSoundSource... |
GetSoundSource ( |
|
|
TAudioSpatia... |
GetSpatializationPluginInterface() |
Return the spatialization plugin interface. |
|
TSubsystemCl... |
GetSubsystem() |
Get a Subsystem of specified type |
|
TSubsystemCl... |
GetSubsystem ( |
Get a Subsystem of specified type from the provided AudioDeviceHandle returns nullptr if the Subsystem cannot be found or the AudioDeviceHandle is invalid |
|
const TArray... |
GetSubsystemArray() |
Gets all Subsystems of specified type, this is only necessary for interfaces that can have multiple implementations instanced at a time. |
|
UAudioEngine... |
GetSubsystemBase ( |
Get a Subsystem of specified type |
|
UAudioCompon... |
GetTestComponent ( |
|
|
float |
GetTransientMasterVolume() |
|
|
const TMap< ... |
GetWaveInstanceSourceMap() |
|
|
HandlePause |
Handle pausing/unpausing of sources when entering or leaving pause mode, or global pause (like device suspend) |
|
|
HasCompressedAudioInfoClass ( |
Whether this SoundWave has an associated info class to decompress it |
|
|
Init ( |
Basic initialization of the platform agnostic layer of the audio system |
|
|
InitDefaultAudioBuses() |
Initialized audio buses marked as default that are to be enabled for the duration of the application. |
|
|
void * |
InitEffect ( |
Platform dependent call to init effect data on a sound source |
|
InitializeHardware() |
Starts up any platform specific hardware/APIs |
|
|
InitializeSubsystemCollection() |
Create our subsystem collection root object and initialize subsystems |
|
|
InitSoundClasses() |
Set up the sound class hierarchy |
|
|
InitSoundEffectPresets() |
||
|
InitSoundSources() |
Set up the initial sound sources Allows us to initialize sound source early on, allowing for render callback hookups for iOS Audio. |
|
|
InitSoundSubmixes() |
Initializes sound submixes. |
|
|
InvalidateCachedInteriorVolumes() |
When the set of Audio volumes have changed invalidate the cached values of active sounds |
|
|
IsAudioDeviceMuted() |
||
|
IsAudioMixerEnabled() |
Returns if this is the multi-platform audio mixer. |
|
|
IsBakedAnalaysisQueryingEnabled() |
Returns if baked analysis querying is enabled. |
|
|
IsExernalBackgroundSoundActive() |
Check if any background music or sound is playing through the audio device |
|
|
IsHRTFDisabled() |
Whether or not HRTF is disabled. |
|
|
IsHRTFEnabledForAll() |
Whether or not HRTF spatialization is enabled for all. |
|
|
IsInitialized() |
Whether the device was initialized. |
|
|
IsMainAudioDevice() |
||
|
IsModulationPluginEnabled() |
Whether or not there's a modulation plugin enabled. |
|
|
IsNonRealtime() |
||
|
IsOcclusionPluginEnabled() |
Whether or not there's an occlusion plugin enabled. |
|
|
IsOcclusionPluginLoaded() |
||
|
IsPendingStop ( |
Whether the provided ActiveSound is currently pending to stop |
|
|
IsReverbPluginEnabled() |
Whether or not there's a reverb plugin enabled. |
|
|
IsReverbPluginLoaded() |
||
|
IsSourceDataOverridePluginEnabled() |
||
|
IsSourceDataOverridePluginLoaded() |
||
|
IsSpatializationPluginEnabled() |
Whether or not there's a spatialization plugin enabled. |
|
|
IsStoppingVoicesEnabled() |
Returns if stopping voices is enabled. |
|
|
IsUsingListenerAttenuationOverride ( |
Returns if the specific listener is using an attenuation override position. |
|
|
LegacyReverbDisabled() |
||
|
LocationIsAudible |
Checks to see if a coordinate is within a distance of a specific listener |
|
|
LocationIsAudible ( |
Checks to see if a coordinate is within a distance of any listener |
|
|
NotifyActiveSoundOcclusionTraceDone ( |
Notify that a pending async occlusion trace finished on the active sound. |
|
|
NotifyPendingDelete ( |
Notifies subsystems an active sound is about to be deleted (called on audio thread) |
|
|
OnBeginPIE ( |
Deals with anything audio related that should happen when PIE starts |
|
|
OnDeviceCreated ( |
Called after FAudioDevice creation and init |
|
|
OnDeviceDestroyed ( |
Called before FAudioDevice teardown |
|
|
OnEndPIE ( |
Deals with anything audio related that should happen when PIE ends |
|
|
OnListenerUpdated |
This is overridden in Audio::FMixerDevice to propogate listener information to the audio thread. |
|
|
OnPreGarbageCollect() |
||
|
PauseActiveSound |
Pauses the active sound for the specified audio component |
|
|
PlaySoundAtLocation ( |
Plays a sound at the given location without creating an audio component. |
|
|
PlayWhenSilentEnabled() |
Whether play when silent is enabled for all sounds associated with this audio device |
|
|
PopSoundMixModifier |
Pop a SoundMix from the Audio Device's list. |
|
|
Precache ( |
Precaches the passed in sound node wave object. Precaches the passed in sound node wave object. |
|
|
PrecacheStartupSounds() |
Precaches all existing sounds. Called when audio setup is complete |
|
|
PushSoundMixModifier |
Push a SoundMix onto the Audio Device's list. |
|
|
RegisterPluginListener ( |
Registers a third party listener-observer to this audio device. |
|
|
RegisterSoundClass ( |
Registers a sound class with the audio device |
|
|
RegisterSoundSubmix ( |
Registers the sound submix |
|
|
RegisterSubmixBufferListener ( |
Registers the submix buffer listener with the given submix. |
|
|
RemoveActiveSound ( |
Removes an active sound from the active sounds array |
|
|
RemoveAudioVolumeProxy ( |
||
|
RemoveSoundMix ( |
Removes a sound mix - called when SoundMix is unloaded |
|
|
RemoveSpectralAnalysisDelegate ( |
||
|
ResetAudioVolumeProxyChangedState() |
||
|
ResetInterpolation() |
Resets all interpolating values to defaults. |
|
|
ResumeContext() |
Resume any context related objects |
|
|
RetriggerVirtualLoop ( |
Attempts to retrigger a provided loop |
|
|
SendCommandToActiveSounds ( |
Performs an operation on all active sounds requested to execute by an audio component |
|
|
SetAudioStateProperty |
||
|
SetBaseSoundMix ( |
Sets a new sound mix and applies it to all appropriate sound classes |
|
|
SetCanHaveMultipleActiveSounds |
Set whether a given Audio Component ID should be allowed to have multiple associated Active Sounds |
|
|
SetDefaultAudioSettings ( |
Sets the default reverb and interior settings for the provided world |
|
|
SetDefaultBaseSoundMix ( |
Sets the Sound Mix that should be active by default |
|
|
SetDeviceMuted ( |
||
|
SetGlobalFocusSettings ( |
||
|
SetGlobalPitchModulation ( |
||
|
SetHRTFDisabled ( |
||
|
SetHRTFEnabledForAll ( |
||
|
SetListener ( |
Sets the details about the listener |
|
|
SetListenerAttenuationOverride |
Sets an override position for the specified listener to do attenuation calculations. |
|
|
SetMaxChannels ( |
Sets the maximum number of channels dynamically. |
|
|
SetMaxChannelsScaled ( |
Sets the maximum number of channels dynamically by scaled percentage. |
|
|
SetMixDebugState ( |
||
|
SetPlatformAudioHeadroom ( |
||
|
SetSoundClassDistanceScale ( |
Overrides the attenuation scale used on a sound class. |
|
|
SetSoundMixClassOverride ( |
Sets a sound class override in the given sound mix. |
|
|
SetSoundMixModifiers |
||
|
SetSpatializationInterfaceEnabled ( |
||
|
SetSubmixAutoDisable ( |
Set whether or not a submix is auto-disabled. |
|
|
SetSubmixAutoDisableTime ( |
Set what the auto-disable time is. |
|
|
SetSubmixDryLevel ( |
Set the wet-dry level of the given submix |
|
|
SetSubmixEffectChainOverride ( |
Sets a submix effect chain override for the given submix |
|
|
SetSubmixModulationBaseLevels ( |
||
|
SetSubmixOutputVolume ( |
Set the wet-dry level of the given submix |
|
|
SetSubmixWetDryLevel ( |
Set the wet-dry level of the given submix |
|
|
SetSubmixWetLevel ( |
Set the wet-dry level of the given submix |
|
|
SetTransientMasterVolume ( |
||
|
SetUseAttenuationForNonGameWorlds ( |
Set whether or not we force the use of attenuation for non-game worlds (as by default we only care about game worlds) |
|
|
ShouldUseRealtimeDecompression ( |
Returns true if a sound wave should be decompressed. |
|
|
ShutdownDefaultAudioBuses() |
Shutdown all audio buses marked as default. |
|
|
SoundIsAudible ( |
Checks if the given sound would be audible. |
|
|
StartEnvelopeFollowing ( |
This is called by a USoundSubmix to start envelope following on a submix isntance on this device. |
|
|
StartRecording ( |
This is called by a USoundSubmix to start recording a submix instance on this device. |
|
|
StartSources ( |
Start and/or update any sources that have a high enough priority to play |
|
|
StartSpectrumAnalysis ( |
||
|
StopActiveSound ( |
Removes the active sound for the specified audio component |
|
|
StopActiveSound ( |
(Deprecated in favor of AddSoundToStop). Stops the active sound |
|
|
StopAllSounds ( |
Stops all game sounds (and possibly UI) sounds |
|
|
StopEnvelopeFollowing ( |
This is called by a USoundSubmix when we stop envelope following a submix instance on this device. |
|
|
Audio::FAlig... |
StopRecording ( |
This is called by a USoundSubmix when we stop recording a submix on this device. |
|
StopSoundsUsingResource ( |
Stop any playing sounds that are using a particular SoundWave |
|
|
StopSources ( |
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 |
|
|
StopSourcesUsingBuffer ( |
Stops any sound sources which are using the given buffer. |
|
|
StopSpectrumAnalysis ( |
||
|
StopTestComponent() |
||
|
SupportsRealtimeDecompression() |
Whether this device supports realtime decompression of sound waves (i.e. DTYPE_RealTime) |
|
|
Suspend ( |
Suspend/resume all sounds (global pause for device suspend/resume, etc.) |
|
|
SuspendContext() |
Suspend any context related objects |
|
|
Teardown() |
Tears down the audio device |
|
|
TeardownHardware() |
Shuts down any platform specific hardware/APIs |
|
|
UnlinkActiveSoundFromComponent ( |
Disables ActiveSound from responding to calls from its associated AudioComponent. |
|
|
UnregisterPluginListener ( |
Unregisters a third party listener-observer to this audio device. |
|
|
UnregisterSoundClass ( |
Unregisters a sound class |
|
|
UnregisterSoundSubmix ( |
Unregisters the sound submix |
|
|
UnregisterSubmixBufferListener ( |
Unregisters the submix buffer listener with the given submix. |
|
|
Update ( |
The audio system's main "Tick" function |
|
|
UpdateActiveSoundPlaybackTime ( |
Update the active sound playback time. This is done here to do after all audio is updated. |
|
|
UpdateAudioVolumeProxy ( |
||
|
UpdateDeviceDeltaTime() |
Sets the update delta time for the audio frame |
|
|
void * |
UpdateEffect ( |
Platform dependent call to update the sound output with new parameters The audio system's main "Tick" function |
|
UpdateGameThread() |
Update called on game thread. |
|
|
UpdateHardware() |
Lets the platform any tick actions |
|
|
UpdateHardwareTiming() |
Updates timing information for hardware. |
|
|
UpdateSourceEffectChain ( |
Updates the source effect chain. Only implemented in audio mixer. |
|
|
UpdateSubmixModulationSettings ( |
||
|
UpdateSubmixProperties ( |
Updates the submix properties of any playing submix instances. |
|
|
UpdateVirtualLoops ( |
||
|
ValidateAPICall |
Check for errors and output a human readable string |
Name | Description | ||
---|---|---|---|
|
Exec ( |
Exec handler |
Name |
Description |
|
---|---|---|
|
FAudioVolumeSettings |
|
|
FCreateComponentParams |
Name |
Description |
---|---|
FToggleSoloPtr |
Handles all argument parsing for the solo commands in one place |
Name | Description | ||
---|---|---|---|
|
ClearListenerAttenuationOverride() |
Use ClearListenerAttenuationOverride that passes a ListenerIndex instead |
|
|
UAudioCompon... |
CreateComponent ( |
Use CreateComponent that passes a parameters block instead |
|
FActiveSound... |
FindActiveSound ( |
This call cannot be called from the GameThread & AudioComponents can now execute multiple ActiveSound instances at once. Use 'SendCommandToActiveSounds' instead. |
|
const FVecto... |
GetListenerAttenuationOverride() |
Use ParseAttenuation that passes a ListenerIndex instead |
|
const TMap< ... |
GetSoundClassPropertyMap() |
Direct access of SoundClasses is no longer allowed. Instead you should use the SoundMixClassOverride system |
|
float |
GetSquaredDistanceToListener ( |
Use GetDistanceSquaredToListener to check against a specific Listener |
|
IsUsingListenerAttenuationOverride() |
Use ParseAttenuation that passes a ListenerIndex instead |
|
|
LocationIsAudible ( |
Use LocationIsAudible that passes a ListenerIndex to check against a specific Listener |
|
|
SetListenerAttenuationOverride ( |
Use SetListenerAttenuationOverride that passes a ListenerIndex instead |