1. Epic GamesDeveloper
  3. AudioExtensions

AudioExtensions

Unreal Engine C++ API Reference > Runtime

Classes

  Type Name Description
Public struct 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    
Private struct FPushedAudioDetails    
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 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 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 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 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 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 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  
Public class UWaveformTransformationBase Base class to hold editor configurable properties for an arbitrary transformation of audio waveform data.  
Public class UWaveformTransformationChain Object that holds an ordered list of transformations to perform on a sound wave.  

Constants

Name Description
Audio::kSectionVer  

Typedefs

Name Description
DeviceID  
FCodecPtr  
FDecodeReturn  
FDecoderInputPtr  
FDecoderOutputPtr  
FDecoderPtr Factory for decoders.
FDestPtr  
FEncoderPtr Factory for encoders.
FModulationMixFunction  
FModulationNormalizedConversionFunction  
FModulationUnitConversionFunction  
FModulatorHandleId  
FModulatorId  
FModulatorTypeId  
FSourcePtr Types.
FTransformationPtr  
USettingsPtr  

Functions

  Type Name Description
Private function Virtual    
Public function Virtual    
Private function Virtual    
Private function Virtual   Please use IAudioFormat/IStreamedCompressedInfo instead
Private function Virtual    
Public function Virtual    
Public function Virtual   Please use IAudioFormat/IStreamedCompressedInfo instead
Private function Virtual bool  
Public function IAudioProxyDataFactory *  
Public function Static FPtr

Audio::Create ( TArray< uint8 >& OutBuffer
)

  
Private function Static TUniquePtr< IDecoderOutput >

Audio::Create ( const FRequirements& Requirements,
TArrayView< uint8 > InExternalMemory
)

 Factory.
Public function Static TUniquePtr< IEncoderInput >

Audio::Create ( TArrayView< const int16 > InSamples,
const FFormat& InInfo
)

 Please use IAudioFormat/IStreamedCompressedInfo instead
Private function Static TUniquePtr< IDecoderOutput >

Audio::Create ( const FRequirements& Requirements
)

 Please use IAudioFormat/IStreamedCompressedInfo instead
Public function Static FPtr Create one.
Public function Virtual FDecoderPtr

Audio::CreateDecoder ( IDecoder::FDecoderInputPtr InSrc,
IDecoder::FDecoderOutputPtr InDst
)

 Factory for decoders.
Public function Virtual FEncoderPtr

Audio::CreateEncoder ( IEncoder::FSourcePtr
)

  
Private function FDecodeReturn

Audio::Decode ( bool bIsLooping
)

 Do the decode.
Public function Const bool

Audio::Encode ( FSourcePtr InSrc,
FDestPtr InDst,
USettingsPtr InSettingsObject
)

 Encode.
Private function Virtual bool  
Public function  

Audio::FCodecDetails ( FName InName,
FName InFamilyName,
uint32 InVersion,
const FCodecFeatures& InFeatures
)

  
Private function constexpr

Audio::FCodecFeatures ( std::initializer_list< EFeatureBitField > InitList
)

  
Public function  

Audio::FDecoderInputArrayView ( TArrayView< const uint8 > InData,
uint32 InOffsetInStream
)

 Pass in array view and we'll wrap around it.
Public function  

Audio::FDecoderInputArrayView ( TUniquePtr< FArchive >&& InReader,
uint32 InOffsetInStream
)

 Pass in an archive.
Private function  

Audio::FEncodedSectionBase ( FFcc InSectionName,
uint32 InVersion
)

  
Public function constexpr

Audio::FFcc ( const char One,
const char Two,
const char Three,
const char Four
)

 Please use IAudioFormat/IStreamedCompressedInfo instead
Private function    
Private function  

Audio::FFormatDescriptorSection ( FName InCodecName,
FName InCodecFamilyName,
uint32 InCodecVersion,
uint32 InNumChannels,
uint32 InNumSamples,
uint32 InNumSamplesPerSec,
uint32 InNumBytesPerPacket
)

  
Private function   Please use IAudioFormat/IStreamedCompressedInfo instead
Public function Const FCodecPtr

Audio::FindCodecByFamilyName ( FName InFamilyName,
int32 InVersion
)

 Find codec by finding by family name. (Version can be INDEX_NONE and give the latest version).
Public function Const FCodecPtr

Audio::FindCodecByName ( FName InName,
int32 InVersion
)

 Find exact code name. (Version can be INDEX_NONE and give the latest version).
Public function Const FCodecPtr

Audio::FindCodecByParsingInput ( IDecoderInput* InObject
)

  
Public function Const FCodecPtr

Audio::FindDefaultCodec ( FName InPlatformName
)

 Find default codec for a platform. (none uses host platform).
Private function bool

Audio::FindSection ( FEncodedSectionBase& OutSection
)

  
Private function  

Audio::FRawSection ( FFcc InName,
TArrayView< const uint8 > InBuffer
)

 Please use IAudioFormat/IStreamedCompressedInfo instead
Private function   Please use IAudioFormat/IStreamedCompressedInfo instead
Public function Const FString Given input and settings determine DDC key.
Public function Static ICodecRegistry & Abstract Singleton.
Private function Static constexpr float TODO: Move this somewhere central.
Public function Const const FCodecDetails & Please use IAudioFormat/IStreamedCompressedInfo instead
Public function Const FName  
Private function Const FRequirements

Audio::GetRequirements ( const FDecodedFormatInfo& InFormat
)

  
Public function friend uint32  
Private function Const bool  
Private function Const bool

Audio::HasFeature ( EFeatureBitField InBit
)

  
Private function Const bool  
Public function Const constexpr bool  
Public function Static bool

Audio::IsValidHeader ( TArrayView< const uint8 > InBytes
)

 Please use IAudioFormat/IStreamedCompressedInfo instead
Private function bool

Audio::MakeTocNested ( FArchive& Ar,
uint32 HeaderStart,
FNestedSection& Header
)

  
Private function Const bool

Audio::operator== ( const FFormatDescriptorSection& Rhs
)

  
Public function Const bool  
Public function Const constexpr bool

Audio::operator== ( const FFcc& InRhs
)

  
Private function bool  
Private function Const TArrayView< const uint8 >

Audio::PeekNextPacket ( int32 InMaxPacketLength
)

  
Private function int32

Audio::PopAudio ( TArray< int16 >& InExternalBuffer,
FPushedAudioDetails& OutDetails
)

 Convenience convert TArray -> TArrayView.
Private function int32

Audio::PopAudio ( TArrayView< float > OutExternalBuffer,
FPushedAudioDetails& OutDetails
)

  
Private function int32

Audio::PopAudio ( TArrayView< int16 > InExternalBuffer,
FPushedAudioDetails& OutDetails
)

  
Private function int32

Audio::PopAudio ( TArray< float >& InExternalBuffer,
FPushedAudioDetails& OutDetails
)

  
Public function int32

Audio::PopAudioInternal ( TArrayView< T > InExternalBuffer
)

 This a bit naive, but ok for proof of concept.
Private function TArrayView< const uint8 >

Audio::PopNextPacket ( int32 InPacketSize
)

  
Private function int32

Audio::PushAudio ( const FPushedAudioDetails& InDetails,
TArrayView< const int16 > In16BitInterleave
)

  
Private function int32

Audio::PushAudio ( const FPushedAudioDetails& InDetails,
TArrayView< const float > InFloat32Interleave
)

  
Public function int32

Audio::PushAudioInternal ( const FPushedAudioDetails& InDetails,
TArrayView< const T > InAudio
)

  
Public function bool Register each codec.
Private function bool  
Private function Virtual bool

Audio::SeekToTime ( const float InSeconds
)

  
Private function void  
Public function void

Audio::SetArchive ( FArchive* InArchive,
uint32 InOffsetInStream
)

  
Public function void

Audio::SetArrayView ( TArrayView< TSampleType > InBuffer
)

  
Public function void

Audio::SetArrayViewBytes ( TArrayView< uint8 > InBytes
)

  
Public function void

Audio::SetArrayViewBytes ( TArrayView< const uint8 > InBytes,
uint32 InOffsetInStream
)

  
Public function  

Audio::TCircularOutputBuffer ( const FRequirements& InReqs
)

  
Public function  

Audio::TDecoderOutputArrayView ( const FRequirements& InReqs
)

  
Public function  

Audio::TDecoderOutputOwnBuffer ( const IDecoderOutput::FRequirements& Requirements
)

 Please use IAudioFormat/IStreamedCompressedInfo instead
Private function Const int64 We need this for back compatibility.
Public function Const FString  
Public function bool  

Variables

  Type Name Description
Private variable bool bError  
Private variable EBitRepresentation BitRep  
Private variable bool bSampleSection  
Public variable TArrayView< TSampleType > Buffer Please use IAudioFormat/IStreamedCompressedInfo instead
Private variable FName CodecFamilyName  
Private variable FName CodecName Codec name, family and version.
Private variable uint32 CodecVersion  
Public variable FName FamilyName Please use IAudioFormat/IStreamedCompressedInfo instead
Public variable FCodecFeatures Features  
Private variable uint32_t FeaturesBitField Please use IAudioFormat/IStreamedCompressedInfo instead
Private variable int32 LoopEndOffset  
Private variable int32 LoopStartOffset  
Private variable uint32 NumBytesPerPacket  
Private variable uint32 NumChannels Info on the compressed data.
Private variable uint32 NumFrames  
Private variable uint32 NumFramesPerSec Please use IAudioFormat/IStreamedCompressedInfo instead
Public variable int64 Offset  
Private variable uint32 OffsetInStream  
Private variable TArray< uint8 > PopBuffer Please use IAudioFormat/IStreamedCompressedInfo instead
Private variable   PRAGMA_DISABLE_DEPRECATION_WARNINGS Please use IAudioFormat/IStreamedCompressedInfo instead
Public variable FRequirements Reqs Please use IAudioFormat/IStreamedCompressedInfo instead
Private variable uint32 SectionSize Please use IAudioFormat/IStreamedCompressedInfo instead
Private variable uint32 SectionVersion  
Private variable uint32 SizePos This is not serialized and is used for accounting during serialization.
Private variable TMap< FFcc, int32 > Toc  
Private variable uint32 Value  
Public variable uint32 Version  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page