AudioExtensions

Choose your operating system:

Windows

macOS

Linux

Classes

Name

Description

Public class

FActiveDecodeHandle

Public struct

FAudioParameter

Public struct

FAudioPluginInitializationParams

Public struct

FAudioPluginSourceInputData

Public struct

FAudioPluginSourceOutputData

Public struct

FChannelPositionInfo

Public struct

FCodecDetails

Public struct

FCodecFeatures

Public struct

FDecodedFormatInfo

Public struct

FDecoderInputArrayView

Public class

FDecoderInputBase

Public class

FDummyEndpointSettingsProxy

A blank class for when unimplemented endpoint types are returned.

Public struct

FEncodedSectionBase

Public class

FFcc

Four character code class.

Public struct

FFormatDescriptorSection

Public struct

FHeaderSection

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

FNestedSection

Public struct

FParameterInterface

Public struct

FParameterPath

Public struct

FParameterTransmitterInitParams

Data passed to CreateParameterTransmitter.

Public struct

FProxyDataInitParams

Public struct

FRawSection

Public struct

FSampleSection

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 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

FSpatializationParams

FSpatializationParams Struct for retrieving parameters needed for computing spatialization and occlusion plugins.

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

Public class

IAudioPluginFactory

IAudioPluginFactory This interface is inherited by spatialization, reverb and occlusion plugins to describe specifics of a plugin such as platform support, and display names.

Public class

IAudioPluginListener

IAudioPluginListener Implementations of this interface can receive updates about the audio listener's position in the game world, as well as other data.

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 Implement this modular feature to make your SourceDataOverride plugin visible to the engine.

Public class

IAudioSpatialization

IAudioSpatialization

Public class

IAudioSpatializationFactory

IAudioSpatializationFactory Implement this modular feature to make your Spatialization plugin visible to the engine.

Public struct

ICodec

Public class

ICodecRegistry

Public struct

IDecoder

Public struct

IDecoderInput

Public struct

IDecoderOutput

Public struct

IDecoderScheduler

Public struct

IEncoder

Public class

IEncoderInput

Public class

IEncoderOutput

Public class

ILegacyParameterTransmitter

Parameter getter & reference collector for legacy parameter 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

TCircularOutputBuffer

Public struct

TDecoderOutputArrayView

Public struct

TDecoderOutputOwnBuffer

Public class

TProxyData

This class can be implemented to create a custom, threadsafe instance of a given UObject.

Public class

UAudioCodecEncoderSettings

Public class

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

UDummyEndpointSettings

Public class

UOcclusionPluginSourceSettingsBase

This is a class which should be overridden to provide users with settings to use for individual sounds

Public class

UReverbPluginSourceSettingsBase

This is a class which should be overridden to provide users with settings to use for individual sounds

Public class

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

USoundfieldEffectSettingsBase

Public class

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

USoundfieldEndpointSettingsBase

This opaque class should be used for specifying settings for how audio should be send to an external endpoint.

Public class

USoundModulatorBase

Base class for all modulators

Public class

USourceDataOverridePluginSourceSettingsBase

This is a class which should be overridden to provide users with settings to use for individual sounds

Public class

USpatializationPluginSourceSettingsBase

This is a class which should be overridden to provide users with settings to use for individual sounds

Typedefs

Enums

Name

Description

Public enum

Audio::EBitRepresentation

NON-UOBJECT LAYER:

Public enum

EAudioParameterType

Public enum

EAudioPlugin

Enumeration of audio plugin types

Functions

Name Description

Public function

IAudioProxyD...

 

Audio::CastToProxyDataFactory

(
    UObject* InObject
)

SFINAE used to optionally invoke subclasses of IAudioProxyDataFactory when we can.

Public function Static

constexpr fl...

 

Audio::GetConvertScalar()

TODO: Move this somewhere central.

Public function

ToType &

 

DowncastSoundfieldRef

(
    FromType& InRef
)

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

Public function

uint32

 

GetTypeHash

(
    const FSoundfieldEncodingKey& Valu...
)