1. Epic GamesDeveloper
  3. AudioExtensions

AudioExtensions

Unreal Engine C++ API Reference > Runtime

Classes

  Type Name Description
Public struct UStruct BlueprintType FAudioParameter    
Public struct FAudioPluginInitializationParams    
Public struct FAudioPluginSourceInputData    
Public struct FAudioPluginSourceOutputData    
Public struct FChannelPositionInfo    
Public class FDummyEndpointSettingsProxy A blank class for when unimplemented endpoint types are returned.  
Public struct FModulationParameter    
Public struct FModulatorHandle Handle to a modulator which interacts with the modulation API to manage lifetime of modulator proxy objects internal to modulation plugin implementation.  
Public struct FParameterInterface Interface for parameterizing data provided to or coming from an executable audio unit (ex. Sound like a MetaSoundSource, arbitrary DSP graph like a MetaSoundPatch, etc.).  
Public struct FParameterPath    
Public class FParameterTransmitterBase Base implementation for the parameter transmitter, which caches parameters and provides implementer to add additional logic to route parameter data accordingly.  
Public struct FParameterTransmitterInitParams Data passed to CreateParameterTransmitter.  
Public struct FProxyDataInitParams    
Public struct FSoundfieldDecoderInputData    
Public struct FSoundfieldDecoderOutputData    
Public struct FSoundfieldEncoderInputData All input parameters for a single Encode operation.  
Public struct FSoundfieldEncodingKey This is used in FMixerSourceVoice to make sure we only encode sources once for each type of stream.  
Public struct FSoundfieldMixerInputData    
Public struct FSoundfieldSpeakerPositionalData Positional data for each channel.  
Public struct UStruct BlueprintType FSoundGeneratorOutput Base class for generators that have outputs that can be exposed to other game code.  
Public class FSoundModulationParameterAssetProxy Proxy to modulator, allowing for modulator to be referenced by the Audio Render Thread independently from the implementing modulation plugin (ex. for MetaSound implementation).  
Public class FSoundModulatorAssetProxy Proxy to modulator, allowing for modulator to be referenced by the Audio Render Thread independently from the implementing modulation plugin (ex. for MetaSound implementation).  
Public struct UStruct FSoundWaveCloudStreamingPlatformProjectSettings Platform specific settings for Sound Wave cloud streaming.  
Public struct UStruct FSoundWaveCloudStreamingPlatformSettings Platform specific settings for Sound Wave cloud streaming.  
Public struct FSpatializationParams FSpatializationParams Struct for retrieving parameters needed for computing spatialization and occlusion plugins.  
Public struct FWaveformTransformationWaveInfo Information about the current state of the wave file we are transforming  
Public struct FWaveTransformUObjectConfiguration Information about the the wave file we are transforming for Transformation UObjects.  
Public class IAudioEndpoint Class that allows audio to be sent to an arbitrary locale.  
Public class IAudioEndpointFactory This factory is used to expose Endpoint types to the editor.  
Public class IAudioEndpointSettingsProxy Interfaces for Endpoints  
Public class IAudioModulationFactory IAudioModulationFactory  
Public class IAudioModulationManager    
Public class IAudioOcclusion    
Public class IAudioOcclusionFactory IAudioOcclusionFactory  
Public class IAudioParameterControllerInterface Base interface for any object implementing parameter control for a given sound instance controller.  
Public class IAudioParameterInterfaceRegistry Registry of engine-defined audio parameter interfaces, used to parameterize data provided to or coming from an executable audio unit (ex. Sound like a MetaSoundSource, arbitrary DSP graph like a MetaSoundPatch, etc.).  
Public class IAudioPluginFactory IAudioPluginFactory  
Public class IAudioPluginListener IAudioPluginListener  
Public class IAudioProxyDataFactory This can be subclassed to make a UClass an audio proxy factory.  
Public class IAudioReverb    
Public class IAudioReverbFactory    
Public class IAudioSourceDataOverride Interface to allow a plugin to override a sound's actual position and simulate propagation (e.g. traversal around corners, etc).  
Public class IAudioSourceDataOverrideFactory IAudioSourceDataOverrideFactory  
Public class IAudioSpatialization IAudioSpatialization  
Public class IAudioSpatializationFactory IAudioSpatializationFactory  
Public class ILegacyParameterTransmitter Reference collector functionality for legacy parameter system (i.e. backwards compatibility with the SoundCue system).  
Public class IModulatorSettings Interface for cached off Modulator UObject data used as default settings to be converted to instanced proxy data per AudioDevice on the AudioRenderThread.  
Public class IParameterTransmitter Interface for a audio instance transmitter.  
Public class IProxyData Base class that allows us to typecheck proxy data before downcasting it in debug builds.  
Public class ISoundfieldAudioPacket This interface represents all encoded soundfield audio from a single render callback.  
Public class ISoundfieldDecoderStream    
Public class ISoundfieldEffectInstance Single instance that actually processes the soundfield.  
Public class ISoundfieldEffectSettingsProxy    
Public class ISoundfieldEncoderStream    
Public class ISoundfieldEncodingSettingsProxy This interface should be used to provide a non-uclass version of the data described in your implementation of USoundfieldEncodingSettingsBase.  
Public class ISoundfieldEndpoint Class that allows soundfield-encoded audio to be sent to an arbitrary locale.  
Public class ISoundfieldEndpointFactory This factory is used to expose Soundfield Endpoint types to the editor.  
Public class ISoundfieldEndpointSettingsProxy Interfaces for Soundfield Endpoints  
Public class ISoundfieldFactory    
Public class ISoundfieldMixerStream    
Public class ISoundfieldTranscodeStream    
Public class ISoundModulatable Interface to sound that is modulatable, allowing for certain specific behaviors to be controlled on the sound level by the modulation system.  
Public class ISoundWaveCloudStreamingFeature    
Public class IWaveTransformation Base class for the object that processes waveform data Pass tweakable variables from its paired settings UObject in the constructor in UWaveformTransformationBase::CreateTransformation  
Public class TProxyData This class can be implemented to create a custom, threadsafe instance of a given UObject.  
Public class UClass Abstract, MinimalAPI BlueprintType Config editinlinenew UAudioEndpointSettingsBase This opaque class should be used for specifying settings for how audio should be send to an external endpoint.  
Public class UAudioParameterControllerInterface    
Public class UClass Abstract UAudioPropertiesSheetAssetBase    
Public class UClass Abstract UAudioPropertySheetBaseAsset    
Public class UClass UDummyEndpointSettings    
Public class UClass Abstract, MinimalAPI BlueprintType Config editinlinenew UOcclusionPluginSourceSettingsBase This is a class which should be overridden to provide users with settings to use for individual sounds  
Public class UClass Abstract, MinimalAPI BlueprintType Config editinlinenew UReverbPluginSourceSettingsBase This is a class which should be overridden to provide users with settings to use for individual sounds  
Public class UClass Abstract, MinimalAPI BlueprintType Config editinlinenew USoundfieldEffectBase This opaque class should be used for specifying settings for how audio should be encoded to your soundfield format for a given submix or file.  
Public class UClass Abstract, MinimalAPI BlueprintType Config editinlinenew USoundfieldEffectSettingsBase    
Public class UClass Abstract, MinimalAPI BlueprintType Config editinlinenew USoundfieldEncodingSettingsBase This opaque class should be used for specifying settings for how audio should be encoded to your soundfield format for a given submix or file.  
Public class UClass Abstract, MinimalAPI BlueprintType Config editinlinenew USoundfieldEndpointSettingsBase This opaque class should be used for specifying settings for how audio should be send to an external endpoint.  
Public class UClass Abstract, MinimalAPI BlueprintType Config editinlinenew USoundModulatorBase Base class for all modulators  
Public class UClass Abstract, MinimalAPI BlueprintType Config editinlinenew USourceDataOverridePluginSourceSettingsBase This is a class which should be overridden to provide users with settings to use for individual sounds  
Public class UClass Abstract, MinimalAPI BlueprintType Config editinlinenew USpatializationPluginSourceSettingsBase This is a class which should be overridden to provide users with settings to use for individual sounds  
Public class UClass Abstract, MinimalAPI editinlinenew UWaveformTransformationBase Base class to hold editor configurable properties for an arbitrary transformation of audio waveform data.  
Public class UClass MinimalAPI editinlinenew UWaveformTransformationChain Object that holds an ordered list of transformations to perform on a sound wave.  

Typedefs

Name Description
DeviceID  
FModulationMixFunction  
FModulationNormalizedConversionFunction  
FModulationUnitConversionFunction  
FModulatorHandleId  
FModulatorId  
FModulatorTypeId  
FParameterInterfacePtr  
FSoundEffectSubmixPtr Deprecated in favor of TSoundEffectSubmixPtr.
FSoundModulationParameterAssetProxyPtr  
FSoundModulatorAssetProxyPtr  
FTransformationPtr  
TAudioModulationPtr  
TAudioOcclusionPtr  
TAudioPluginListenerPtr  
TAudioReverbPtr  
TAudioSourceDataOverridePtr  
TAudioSpatializationPtr  
TSoundEffectPtr  
TSoundEffectSourcePtr  
TSoundEffectSubmixPtr  

Enums

  Type Name Description
Public enum UEnum EAudioParameterType    
Public enum EAudioPlugin Enumeration of audio plugin types  
Public enum UEnum ESoundWaveCloudStreamingPlatformEnableType Platform specific enabling of Sound Wave cloud streaming.  
Public enum UEnum ESoundWaveCloudStreamingPlatformProjectEnableType Platform specific enabling of Sound Wave cloud streaming.  

Functions

  Type Name Description
Public function IAudioProxyDataFactory *  
Public function ToType &

DowncastSoundfieldRef ( FromType& InRef
)

 This helper function is used to downcast abstract objects during callbacks.
Public function  

LLM_DECLARE_TAG_API ( Audio_SpatializationPlugins,
AUDIOEXTENSIONS_API
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page