Navigation
| Name | AudioExtensions |
| Type | Runtime |
| Location | /Engine/Source/Runtime/AudioExtensions/ |
| Module Build Rules | AudioExtensions.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FDummyEndpointSettingsProxy | A blank class for when unimplemented endpoint types are returned. |
| FParameterTransmitterBase | Base implementation for the parameter transmitter, which caches parameters and provides implementer to add additional logic to route parameter data accordingly. |
| 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). |
| 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). |
| TProxyData | This class can be implemented to create a custom, threadsafe instance of a given UObject. |
| UAudioEndpointSettingsBase | This opaque class should be used for specifying settings for how audio should be send to an external endpoint. |
| UAudioParameterControllerInterface | |
| UAudioPropertiesSheetAssetBase | |
| UAudioPropertiesSheetAssetUserInterface | |
| UDummyEndpointSettings | |
| UOcclusionPluginSourceSettingsBase | This is a class which should be overridden to provide users with settings to use for individual sounds |
| UReverbPluginSourceSettingsBase | This is a class which should be overridden to provide users with settings to use for individual sounds |
| 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. |
| USoundfieldEffectSettingsBase | |
| 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. |
| USoundfieldEndpointSettingsBase | This opaque class should be used for specifying settings for how audio should be send to an external endpoint. |
| USoundModulatorBase | Base class for all modulators |
| USourceDataOverridePluginSourceSettingsBase | This is a class which should be overridden to provide users with settings to use for individual sounds |
| USpatializationPluginSourceSettingsBase | This is a class which should be overridden to provide users with settings to use for individual sounds |
| UWaveformTransformationBase | Base class to hold editor configurable properties for an arbitrary transformation of audio waveform data. |
| UWaveformTransformationChain | Object that holds an ordered list of transformations to perform on a sound wave. |
Structs
| Name | Remarks |
|---|---|
| FAudioParameter | |
| FAudioPluginInitializationParams | |
| FAudioPluginSourceInputData | |
| FAudioPluginSourceOutputData | |
| FChannelPositionInfo | |
| FModulationParameter | |
| FModulatorHandle | Handle to a modulator which interacts with the modulation API to manage lifetime of modulator proxy objects internal to modulation plugin implementation. |
| 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.). |
| FParameterPath | |
| FParameterTransmitterInitParams | Data passed to CreateParameterTransmitter. |
| FProxyDataInitParams | |
| FSoundfieldDecoderInputData | |
| FSoundfieldDecoderOutputData | |
| FSoundfieldEncoderInputData | All input parameters for a single Encode operation. |
| FSoundfieldEncodingKey | This is used in FMixerSourceVoice to make sure we only encode sources once for each type of stream. |
| FSoundfieldMixerInputData | |
| FSoundfieldSpeakerPositionalData | Positional data for each channel. |
| FSoundGeneratorOutput | Base class for generators that have outputs that can be exposed to other game code. |
| FSoundWaveCloudStreamingPlatformProjectSettings | Platform specific settings for Sound Wave cloud streaming. |
| FSoundWaveCloudStreamingPlatformSettings | Platform specific settings for Sound Wave cloud streaming. |
| FSoundWaveCuePoint | Struct defining a cue point in a sound wave asset. |
| FSpatializationParams | FSpatializationParams Struct for retrieving parameters needed for computing spatialization and occlusion plugins. |
| FWaveformTransformationInfo | Information to be retrieved from each transformation (Add members as needed when new transformation types are added) |
| FWaveformTransformationWaveInfo | Information about the current state of the wave file we are transforming |
| FWaveTransformUObjectConfiguration | Information about the the wave file we are transforming for Transformation UObjects. |
Interfaces
| Name | Remarks |
|---|---|
| IAudioEndpoint | Class that allows audio to be sent to an arbitrary locale. |
| IAudioEndpointFactory | This factory is used to expose Endpoint types to the editor. |
| IAudioEndpointSettingsProxy | Interfaces for Endpoints |
| IAudioModulationFactory | IAudioModulationFactory |
| IAudioModulationManager | |
| IAudioOcclusion | |
| IAudioOcclusionFactory | IAudioOcclusionFactory |
| IAudioParameterControllerInterface | Base interface for any object implementing parameter control for a given sound instance controller. |
| 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.). |
| IAudioPluginFactory | IAudioPluginFactory |
| IAudioPluginListener | IAudioPluginListener |
| IAudioPropertiesDetailsInjector | |
| IAudioPropertiesDetailsInjectorBuilder | |
| IAudioPropertiesSheetAssetUserInterface | IAudioPropertiesSheetAssetUserInterface |
| IAudioProxyDataFactory | This can be subclassed to make a UClass an audio proxy factory. |
| IAudioReverb | |
| IAudioReverbFactory | |
| IAudioSourceDataOverride | Interface to allow a plugin to override a sound's actual position and simulate propagation (e.g. traversal around corners, etc). |
| IAudioSourceDataOverrideFactory | IAudioSourceDataOverrideFactory |
| IAudioSpatialization | IAudioSpatialization |
| IAudioSpatializationFactory | IAudioSpatializationFactory |
| ILegacyParameterTransmitter | Reference collector functionality for legacy parameter system (i.e. backwards compatibility with the SoundCue system). |
| IModulatorSettings | Interface for cached off Modulator UObject data used as default settings to be converted to instanced proxy data per AudioDevice on the AudioRenderThread. |
| IParameterTransmitter | Interface for a audio instance transmitter. |
| IProxyData | Base class that allows us to typecheck proxy data before downcasting it in debug builds. |
| ISoundfieldAudioPacket | This interface represents all encoded soundfield audio from a single render callback. |
| ISoundfieldDecoderStream | |
| ISoundfieldEffectInstance | Single instance that actually processes the soundfield. |
| ISoundfieldEffectSettingsProxy | |
| ISoundfieldEncoderStream | |
| ISoundfieldEncodingSettingsProxy | This interface should be used to provide a non-uclass version of the data described in your implementation of USoundfieldEncodingSettingsBase. |
| ISoundfieldEndpoint | Class that allows soundfield-encoded audio to be sent to an arbitrary locale. |
| ISoundfieldEndpointFactory | This factory is used to expose Soundfield Endpoint types to the editor. |
| ISoundfieldEndpointSettingsProxy | Interfaces for Soundfield Endpoints |
| ISoundfieldFactory | |
| ISoundfieldMixerStream | |
| ISoundfieldTranscodeStream | |
| ISoundModulatable | Interface to sound that is modulatable, allowing for certain specific behaviors to be controlled on the sound level by the modulation system. |
| ISoundWaveCloudStreamingFeature | |
| IWaveTransformation | Base class for the object that processes waveform data Pass tweakable variables from its paired settings UObject in the constructor in UWaveformTransformationBase::CreateTransformation |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DeviceID | uint32 | IAudioParameterTransmitter.h | |
| FModulationMixFunction | TFunction< void(float &, float)> | IAudioModulation.h | |
| FModulationNormalizedConversionFunction | TFunction< void(float &)> | IAudioModulation.h | |
| FModulationUnitConversionFunction | TFunction< void(float &)> | IAudioModulation.h | |
| FModulatorHandleId | uint32 | IAudioModulation.h | |
| FModulatorId | uint32 | IAudioModulation.h | |
| FModulatorTypeId | uint32 | IAudioModulation.h | |
| FParameterInterfacePtr | TSharedPtr< FParameterInterface, ESPMode::ThreadSafe > | IAudioParameterInterfaceRegistry.h | |
| FSoundEffectSubmixPtr | TSharedPtr< FSoundEffectSubmix, ESPMode::ThreadSafe > | Deprecated in favor of TSoundEffectSubmixPtr. | IAudioExtensionPlugin.h |
| FSoundModulationParameterAssetProxyPtr | TSharedPtr< FSoundModulationParameterAssetProxy, ESPMode::ThreadSafe > | IAudioModulation.h | |
| FSoundModulatorAssetProxyPtr | TSharedPtr< FSoundModulatorAssetProxy, ESPMode::ThreadSafe > | IAudioModulation.h | |
| FTransformationPtr | TUniquePtr< Audio::IWaveTransformation > | IWaveformTransformation.h | |
| TAudioModulationPtr | TSharedPtr< IAudioModulationManager, ESPMode::ThreadSafe > | IAudioExtensionPlugin.h | |
| TAudioOcclusionPtr | TSharedPtr< IAudioOcclusion, ESPMode::ThreadSafe > | IAudioExtensionPlugin.h | |
| TAudioPluginListenerPtr | TSharedPtr< IAudioPluginListener, ESPMode::ThreadSafe > | IAudioExtensionPlugin.h | |
| TAudioReverbPtr | TSharedPtr< IAudioReverb, ESPMode::ThreadSafe > | IAudioExtensionPlugin.h | |
| TAudioSourceDataOverridePtr | TSharedPtr< IAudioSourceDataOverride, ESPMode::ThreadSafe > | IAudioExtensionPlugin.h | |
| TAudioSpatializationPtr | TSharedPtr< IAudioSpatialization, ESPMode::ThreadSafe > | IAudioExtensionPlugin.h | |
| TSoundEffectPtr | TSharedPtr< FSoundEffectBase, ESPMode::ThreadSafe > | IAudioExtensionPlugin.h | |
| TSoundEffectSourcePtr | TSharedPtr< FSoundEffectSource, ESPMode::ThreadSafe > | IAudioExtensionPlugin.h | |
| TSoundEffectSubmixPtr | TSharedPtr< FSoundEffectSubmix, ESPMode::ThreadSafe > | IAudioExtensionPlugin.h |
Enums
Public
| Name | Remarks |
|---|---|
| Audio::ETransformationPriority | Copyright Epic Games, Inc. All Rights Reserved. |
| EAudioParameterType | |
| EAudioPlugin | Enumeration of audio plugin types |
| ESoundWaveCloudStreamingPlatformEnableType | Platform specific enabling of Sound Wave cloud streaming. |
| ESoundWaveCloudStreamingPlatformProjectEnableType | Platform specific enabling of Sound Wave cloud streaming. |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AudioPropertiesDetailsInjector::BuilderModularFeatureName | const FLazyName | IAudioPropertiesDetailsInjector.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IAudioProxyDataFactory * Audio::CastToProxyDataFactory
(
UObject* InObject |
IAudioProxyInitializer.h | ||
ToType & DowncastSoundfieldRef
(
FromType& InRef |
This helper function is used to downcast abstract objects during callbacks. | ISoundfieldFormat.h |