AudioExtensions

Windows
MacOS
Linux

Classes

Name

Description

Public struct

FAudioPluginInitializationParams

Public struct

FAudioPluginSourceInputData

Public struct

FAudioPluginSourceOutputData

Public struct

FChannelPositionInfo

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

FSoundModulation

Collection of settings available on sound objects

Public struct

FSoundModulationControls

Modulatable controls found on each sound instance processed by the modulation plugin enabled

Public struct

FSoundModulationParameter

Parameter allowing modulation control override for systems opting in to the Modulation System.

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

IAudioModulation

Public class

IAudioModulationFactory

IAudioModulationFactory

Public class

IAudioOcclusion

Public class

IAudioOcclusionFactory

IAudioOcclusionFactory

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

IAudioReverb

Public class

IAudioReverbFactory

Public class

IAudioSpatialization

IAudioSpatialization

Public class

IAudioSpatializationFactory

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

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 modulateable, allowing for certain specific behaviors to be controlled on the sound level by the modulation system.

Public class

UAudioEndpointSettingsBase

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

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

USoundModulationPluginSourceSettingsBase

Override to provide users with modulation settings custom to 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

EAudioPlugin

Enumeration of audio plugin types

Functions

Name Description

Public function

ToType &

 

DowncastSoundfieldRef

(
    FromType& InRef
)

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

Public function

uint32

 

GetTypeHash

(
    const FSoundfieldEncodingKey & Valu...
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback