description:
Return the cached parameter with the given name if it exists
False if param not found, true if found.

code: virtual bool GetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) & OutParam ) const


description: Return reference to the cached parameter array.

module: AudioExtensions

code: virtual const [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > & GetParameters() const


description: Deprecated* UseResetParameters()orOnDeleteActiveSound()instead depending on use case.

code: virtual bool Reset()


description: Reset parameters which stored on the transmitter.

code: virtual void ResetParameters()


description: Parameter Setters.

code: virtual bool SetParameters ( [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > && InParameters )


code: FParameterTransmitterBase ( [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > && InDefaultParams )


className: FParameterPath

code: struct FParameterPath


code: virtual ~FParameterTransmitterBase()


className: FParameterTransmitterBase

description: Base implementation for the parameter transmitter, which caches parameters and provides implementer to add additional logic to route parameter data accordingly.

code: class FParameterTransmitterBase : public [Audio::IParameterTransmitter](API\Runtime\AudioExtensions\IParameterTransmitter)

AudioParameters

type: TArray<FAudioP...


className: FParameterTransmitterInitParams

description: Data passed to CreateParameterTransmitter.

code: struct FParameterTransmitterInitParams

AudioDeviceID

type: DeviceID

description: Audio device ID.

InstanceID

description: Unique ID for this audio instance.

SampleRate

type: float

description: Audio sample rate.


className: FProxyDataInitParams

code: struct FProxyDataInitParams

NameOfFeatureRequestingProxy

type: FName


code: FPushedAudioDetails ( int32 InFramesPerSec, int32 InNumChannels, int32 InSampleOffset, bool In_bContainsLoopPoint, bool In_bHasFinished, bool In_bHasError )


className: FPushedAudioDetails

code: struct FPushedAudioDetails

bContainsLoopPoint

type: uint32:  1


className: FSoundfieldDecoderInputData

code: struct FSoundfieldDecoderInputData

PositionalData

type: FSoundfieldSpea...

description: The positions of the channels we will outputFSoundfieldDecoderOutputData::AudioBufferto.

SoundfieldBuffer

type: ISoundfieldAudi...


className: FSoundfieldDecoderOutputData

code: struct FSoundfieldDecoderOutputData


className: FSoundfieldEncoderInputData

description: All input parameters for a single Encode operation.

code: struct FSoundfieldEncoderInputData

AudioBuffer

description: Input buffer of interleaved floats.

InputSettings

type: ISoundfieldEnco...

description: If the input audio was already encoded to ambisonics, this will point to the settings the audio was encoded with.

NumChannels

description: Number of channels of the source audio buffer.


code: bool operator== ( const [FSoundfieldEncodingKey](API\Runtime\AudioExtensions\FSoundfieldEncodingKey) & Other ) const


code: FSoundfieldEncodingKey ( [ISoundfieldFactory](API\Runtime\AudioExtensions\ISoundfieldFactory) * Factory, [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & InSettings )


className: FSoundfieldEncodingKey

description: This is used in FMixerSourceVoice to make sure we only encode sources once for each type of stream.

code: struct FSoundfieldEncodingKey


className: FSoundfieldMixerInputData

code: struct FSoundfieldMixerInputData

EncodingSettings

type: constISoundfie...

description: Settings used to encode both the input packet than the packet we are mixing to.

InputPacket

description: Packet that should be mixed into the output.

SendLevel

description: The amount, in linear gain, to.


className: FSoundGeneratorOutput

description: NOTE: This is not widely supported and should be considered experimental.

code: struct FSoundGeneratorOutput

Name

description: The output's name


className: bWasAudioProxyClassImplemented

code: static constexpr bool bWasAudioProxyClassImplemented = true;


code: virtual const [Audio::FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) & GetParameter() const


className: FSoundModulationParameterAssetProxy

description: Proxy to modulator, allowing for modulator to be referenced by the Audio Render Thread independently from the implementing modulation plugin (ex. for MetaSound implementation).

code: class FSoundModulationParameterAssetProxy : public [Audio::TProxyData< FSoundModulationParameterAssetProxy >](API\Runtime\AudioExtensions\TProxyData), public [TSharedFromThis< FSoundModulationParameterAssetProxy, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


code: virtual [Audio::FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) CreateModulatorHandle ( [IAudioModulationManager](API\Runtime\AudioExtensions\IAudioModulationManager) & InModulation ) const


code: virtual [Audio::FModulatorId](API\Runtime\AudioExtensions\FModulatorId) GetModulatorId() const


code: FSoundModulatorAssetProxy ( const [FSoundModulatorAssetProxy](API\Runtime\AudioExtensions\FSoundModulatorAssetProxy) & InAssetProxy )


code: FSoundModulatorAssetProxy ( const [USoundModulatorBase](API\Runtime\AudioExtensions\USoundModulatorBase) & InModulatorBase )


className: FSoundfieldSpeakerPositionalData

description: Positional data for each channel.

code: struct FSoundfieldSpeakerPositionalData

ChannelPositions

type: constTArray<A...

Rotation

type: FQuat

description: For encoding, this is the rotation of the emitter source relative to the world.


className: FSoundModulatorAssetProxy

code: class FSoundModulatorAssetProxy : public [Audio::TProxyData< FSoundModulatorAssetProxy >](API\Runtime\AudioExtensions\TProxyData), public [TSharedFromThis< FSoundModulatorAssetProxy, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)

ModulatorSettings

type: TUniquePtr<Aud...


className: FSourcePtr

description: Types.

code: typedef IEncoderInput * FSourcePtr


className: FSpatializationParams

description: FSpatializationParamsStruct for retrieving parameters needed for computing spatialization and occlusion plugins.

code: struct FSpatializationParams

AttenuationDistance

description: The distance used to compute attenuation.

AudioClock

type: double

description: The time when this spatialization params was built.

Distance

description: The distance between listener and emitter.

EmitterPosition

type: FVector

description: The emitter position relative to listener.

EmitterWorldPosition

description: The emitter world position.

EmitterWorldRotation

description: The emitter world rotation.

LastEmitterWorldRotation

description: The emitter world rotation on callback ago.

LeftChannelPosition

description: The left channel position.

ListenerOrientation

description: The listener orientation.

ListenerPosition

description: The listener position (is likely at the origin).

NonSpatializedAmount

description: The amount of non-spatialized this source is. 1.0 means fully 2D, 0.0 means fully 3D.

NormalizedOmniRadius

description: Deprecated

RightChannelPosition

description: The right channel position.


className: FTransformationPtr

code: typedef [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [Audio::IWaveTransformation](API\Runtime\AudioExtensions\IWaveTransformation) > FTransformationPtr


className: FWaveformTransformationWaveInfo

description: Information about the current state of the wave file we are transforming

code: struct FWaveformTransformationWaveInfo


className: FWaveTransformUObjectConfiguration

description: Information about the the wave file we are transforming for Transformation UObjects.


description: Thread safe function to disconnect everything from this endpoint. Anything that owns anAudio::FPatchInputwill be notified and will have to callPatchNewInput()again to reconnect.

code: void DisconnectAllInputs()


description: OPTIONAL OVERRIDES: For endpoints that do not explicitly fire a timed callback to poll audio data, this should be overridden to return true, and OnAudioCallback and GetDesiredNumFrames should be overridden.

code: virtual bool EndpointRequiresCallback() const


code: virtual int32 GetDesiredNumFrames() const


description: This should return the number of channels we should be sending to this endpoint. If the number of channels changes, please call DisconnectAllInputs.

code: virtual int32 GetNumChannels() const


description: Whether this endpoint is of an implemented type

code: virtual bool IsImplemented()


description: REQUIRED OVERRIDES: This should return the sample rate we should be sending to this endpoint. If the sample rate changes, please callDisconnectAllInputs().

code: virtual float GetSampleRate() const


description:
For endpoints that override EndpointRequiresCallback to return true, this callback will be called every (GetDesiredNumFrames()/GetSampleRate()) seconds.
whether the endpoint is still valid. If this returns false, DisconnectAllInputs will be called automatically.

code: virtual bool OnAudioCallback ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< const float > & InAudio, const int32 & NumChannels, const [IAudioEndpointSettingsProxy](API\Runtime\AudioExtensions\IAudioEndpointSettingsProxy) * InSettings )


description:
Create a new patch point for this endpoint. Please see MultithreadedPatching.h to see how to use the FPatchInput class.
a newAudio::FPatchInput. The FPatchInput may be disconnected if this endpoint's sample rate or channel count changes, in which case you will need to reconnect by calling this again.

code: [Audio::FPatchInput](API\Runtime\SignalProcessing\DSP\FPatchInput) PatchNewInput ( float ExpectedDurationPerRender, float & OutSampleRate, int32 & OutNumChannels )


description: Use this as a thread safe way to use the current settings posted to thisIAudioEndpoint. Locks with IAudioEndpoint::SetSettings.

code: void PollSettings ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(const [IAudioEndpointSettingsProxy](API\Runtime\AudioExtensions\IAudioEndpointSettingsProxy) *)> NewSettingsRetrieved )


description: If this audio endpoint hasn't spawned a seperate callback thread but requires a callback, this should be executed somewhere.

code: void ProcessAudioIfNeccessary()


description: IfEndpointRequiresCallback()returns true, this can be used to manually run the callback.

code: void RunCallbackSynchronously()


description: Post new settings for this endpoint. There is no type safety on this call, so make sure that you are using the correct implementation ofIAudioEndpointSettingsProxyfor this implementation ofIAudioEndpoint.

code: void SetNewSettings ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAudioEndpointSettingsProxy](API\Runtime\AudioExtensions\IAudioEndpointSettingsProxy) > && InNewSettings )


description: IfEndpointRequiresCallback()returns true, this can be used to spawn an async thread and begin calling OnAudioCallback.

code: void StartRunningAsyncCallback()


code: void StopRunningAsyncCallback()


code: virtual ~IAudioEndpoint()


className: IAudioEndpoint

description: Class that allows audio to be sent to an arbitrary locale. This can be used for multi-device rendering, haptics systems, etc. Note that this only for interleaved audio buffers with no metadata for object-based or soundfield-based rendering. For those, see

code: class IAudioEndpoint


description: Get a registered endpoint factory by name.

code: static [IAudioEndpointFactory](API\Runtime\AudioExtensions\IAudioEndpointFactory) * Get ( const [FName](API\Runtime\Core\UObject\FName) & InName )


description: Called for every new endpoint submix created with this factory's endpoint type.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAudioEndpoint](API\Runtime\AudioExtensions\IAudioEndpoint) > CreateNewEndpointInstance ( const [FAudioPluginInitializationParams](API\Runtime\AudioExtensions\FAudioPluginInitializationParams) & InitInfo, const [IAudioEndpointSettingsProxy](API\Runtime\AudioExtensions\IAudioEndpointSettingsProxy) & InitialSettings )


code: static [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetAvailableEndpointTypes()


description:
METHODS USED BY IMPLEMENTATIONS OFIAudioEndpoint: This is used by theIAudioEndpointimplementation to poll buffered audio to process or send to the endpoint. Note that this is NOT thread safe ifEndpointRequiresCallback()is overridden to return true. If that is the case, use an override of OnAudioCallback instead.
[out] the number of samples polled from this thing.

code: int32 PopAudio ( float * OutAudio, int32 NumSamples )


description: Should return the StaticClass of this factory's implementation ofUAudioEndpointSettingsBase.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetCustomSettingsClass() const


description: Return the settings an endpoint should use

code: virtual const [UAudioEndpointSettingsBase](API\Runtime\AudioExtensions\UAudioEndpointSettingsBase) * GetDefaultSettings() const


code: static [IAudioEndpointFactory](API\Runtime\AudioExtensions\IAudioEndpointFactory) * GetDummyFactory()


description: Get the name for the endpoint type that this factory produces.


description: This is used when callingIModularFeatures::Get().RegisterModularFeature forIAudioEndpointFactoryimplementations. It's not needed if one usesRegisterEndpointType()to registerIAudioEndpointFactoryimplementations.


description: This is a special cased name for endpoint submixes that render directly to the default audio device inAudio::FMixerDevice::OnProcessAudioStream.


description: This needs to be called to make a soundfield format usable by the engine. It can be called from aISoundfieldFactorysubclass' constructor

code: static void RegisterEndpointType ( [IAudioEndpointFactory](API\Runtime\AudioExtensions\IAudioEndpointFactory) * InFactory )


description: This needs to be called it an implementation ofISoundfieldFactoryis about to be destroyed. It can be called from the destructor of an implementation ofISoundfieldFactory.

code: static void UnregisterEndpointType ( [IAudioEndpointFactory](API\Runtime\AudioExtensions\IAudioEndpointFactory) * InFactory )


className: IAudioEndpointFactory

description: This factory is used to expose Endpoint types to the editor. Once a factory is constructed and RegisterEndpointType is called, it will be exposed as a type of endpoint That a submix in the submix graph could be constructed with.

code: class IAudioEndpointFactory : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)

bIsImplemented

type: bool


description: Virtual destructor

code: virtual ~IAudioEndpointFactory()


code: virtual ~IAudioEndpointSettingsProxy()


className: IAudioEndpointSettingsProxy

description: This set of interfaces is useful for push audio to arbitrary outputs. This interface should be used to provide a non-uclass version of the data described in your implementation ofUAudioEndpointSettingsBase.

code: class IAudioEndpointSettingsProxy


code: TAudioModulationPtr CreateNewModulationPlugin ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * OwningDevice )


description: theUClasstype of your settings for modulation. This allows us to only pass in user settings for your plugin.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetCustomModulationSettingsClass() const


code: const [FName](API\Runtime\Core\UObject\FName) & GetDisplayName() const


description: IModularFeature.


className: IAudioModulationFactory

description: IAudioModulationFactory

code: class IAudioModulationFactory : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Virtual destructor

code: virtual ~IAudioModulationFactory()


description: Get the modulator value from the AudioRender Thread.

code: bool GetModulatorValue ( const [Audio::FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) & ModulatorHandle, float & OutValue ) const


description: Get the modulator value from any thread.

code: bool GetModulatorValueThreadSafe ( const [Audio::FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) & ModulatorHandle, float & OutValue ) const


description: Initialize the modulation plugin with the same rate and number of sources

code: void Initialize ( const [FAudioPluginInitializationParams](API\Runtime\AudioExtensions\FAudioPluginInitializationParams) & InitializationParams )


description: Request to post help from active plugin (non-shipping builds only)

code: bool OnPostHelp ( [FCommonViewportClient](API\Runtime\Engine\FCommonViewportClient) * ViewportClient, const TCHAR * Stream )


description: Render stats pertaining to modulation (non-shipping builds only)

code: int32 OnRenderStat ( [FViewport](API\Runtime\Engine\FViewport) * Viewport, [FCanvas](API\Runtime\Engine\FCanvas) * Canvas, int32 X, int32 Y, const [UFont](API\Runtime\Engine\Engine\UFont) & Font, const FVector * ViewLocation, const FRotator * ViewRotation )


description: Toggle showing render stats pertaining to modulation (non-shipping builds only)

code: bool OnToggleStat ( [FCommonViewportClient](API\Runtime\Engine\FCommonViewportClient) * ViewportClient, const TCHAR * Stream )


description: Processes all modulators Run on the audio render thread prior to processing audio

code: void ProcessModulators ( const double InElapsed )


code: void RegisterModulator ( uint32 InHandleId, [Audio::FModulatorId](API\Runtime\AudioExtensions\FModulatorId) InModulatorId )


description: Updates modulator definition on the AudioRender Thread with that provided by theUObjectrepresentation

code: void UpdateModulator ( const [USoundModulatorBase](API\Runtime\AudioExtensions\USoundModulatorBase) & InModulator )


className: IAudioModulationManager

code: class IAudioModulationManager : public [TSharedFromThis< IAudioModulationManager >](API\Runtime\Core\Templates\TSharedFromThis)


description: Virtual destructor

code: virtual ~IAudioModulationManager()


description: Initialize the occlusion plugin with the same rate and number of sources.

code: virtual void Initialize ( const [FAudioPluginInitializationParams](API\Runtime\AudioExtensions\FAudioPluginInitializationParams) InitializationParams )


description: Called when a source is assigned to a voice.

code: virtual void OnInitSource ( const uint32 SourceId, const [FName](API\Runtime\Core\UObject\FName) & AudioComponentUserId, const uint32 NumChannels, [UOcclusionPluginSourceSettingsBase](API\Runtime\AudioExtensions\UOcclusionPluginSourceSettingsBa-) * InSettings )


description: Called when a source is done playing and is released.

code: virtual void OnReleaseSource ( const uint32 SourceId )


description: Processes audio with the given input and output data structs.

code: virtual void ProcessAudio ( const [FAudioPluginSourceInputData](API\Runtime\AudioExtensions\FAudioPluginSourceInputData) & InputData, [FAudioPluginSourceOutputData](API\Runtime\AudioExtensions\FAudioPluginSourceOutputData) & OutputData )


code: void UnregisterModulator ( const [Audio::FModulatorHandle](API\Runtime\AudioExtensions\FModulatorHandle) & InHandle )


description: Shuts down the audio plugin.

code: virtual void Shutdown()


description: Virtual destructor

code: virtual ~IAudioOcclusion()


className: IAudioOcclusion

code: class IAudioOcclusion


code: TAudioOcclusionPtr CreateNewOcclusionPlugin ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * OwningDevice )


description: theUClasstype of your settings for occlusion. This allows us to only pass in user settings for your plugin.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetCustomOcclusionSettingsClass() const


description: Begin IAudioPluginWithMetadata implementation


description: IModularFeature.


description: Virtual destructor

code: virtual ~IAudioOcclusionFactory()


className: IAudioOcclusionFactory

description: IAudioOcclusionFactory

code: class IAudioOcclusionFactory : public [IAudioPluginFactory](API\Runtime\AudioExtensions\IAudioPluginFactory), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Resets all parameters to their original values.

code: void ResetParameters()


description: Sets a named Boolean Array.

code: void SetBoolArrayParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [TArray](API\Runtime\Core\Containers\TArray)< bool > & InValue )


description: Sets a named Boolean.

code: void SetBoolParameter ( [FName](API\Runtime\Core\UObject\FName) InName, bool InBool )


description: Sets a named Float Array.

code: void SetFloatArrayParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [TArray](API\Runtime\Core\Containers\TArray)< float > & InValue )


description: Sets a named Float.

code: void SetFloatParameter ( [FName](API\Runtime\Core\UObject\FName) InName, float InFloat )


description: Sets a named Int32 Array.

code: void SetIntArrayParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & InValue )


description: Sets a namedUObjectArray.

code: void SetObjectArrayParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > & InValue )


description: Sets a named Int32.

code: void SetIntParameter ( [FName](API\Runtime\Core\UObject\FName) InName, int32 InInt )


description: Sets a namedUObject.

code: void SetObjectParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [UObject](API\Runtime\CoreUObject\UObject\UObject) * InValue )


description: Sets a named parameter to the given parameter structure value.

code: void SetParameter ( [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) && InValue )


code: template<> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< int32 > && InIntegers )


code: template<> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > && InStrings )


code: template<> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< [UObject](API\Runtime\CoreUObject\UObject\UObject) * > && InObjects )


description: Template Specialization for non-script clients.

code: template<typename [DataType](API\Plugins\OptimusCore\DataType)> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [DataType](API\Plugins\OptimusCore\DataType) && )


code: template<> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, bool && InBool )


code: template<> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, float && InFloat )


code: template<> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, int32 && InInteger )


code: template<> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [FString](API\Runtime\Core\Containers\FString) && InString )


code: template<> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [UObject](API\Runtime\CoreUObject\UObject\UObject) *&& InObject )


code: template<> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< bool > && InBools )


code: template<> void SetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< float > && InFloats )


description: Sets an array of parameters as a batch.

code: void SetParameters ( [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > && InValues )


description: Sets an array of parameters as a batch.

code: void SetParameters_Blueprint ( const [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > & InParameters )


description: Sets a named String Array.

code: void SetStringArrayParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InValue )


description: Sets a named String.

code: void SetStringParameter ( [FName](API\Runtime\Core\UObject\FName) InName, const [FString](API\Runtime\Core\Containers\FString) & InValue )


description: Executes a named trigger. Doesnotcache trigger value, so only executes if the sound is already playing. If the intent is for the trigger to execute immediately (if playing) and be called on initialization for all future instances, call 'SetBoolParameter' with the intended initial trigger behavior (true if trigger desired on initialization, false if not).

code: void SetTriggerParameter ( [FName](API\Runtime\Core\UObject\FName) InName )


className: IAudioParameterControllerInterface

description: Base interface for any object implementing parameter control for a given sound instance controller.

code: class IAudioParameterControllerInterface : public [IInterface](API\Runtime\CoreUObject\UObject\IInterface)


code: static [IAudioParameterInterfaceRegistry](API\Runtime\AudioExtensions\IAudioParameterInterfaceRegistry) & Get()


description: Iterate all registered interfaces.

code: void IterateInterfaces ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([FParameterInterfacePtr](API\Runtime\Engine\Sound\FParameterInterfacePtr))> InFunction ) const


description: Execute a given function when an interface is registered.

code: void OnRegistration ( [TUniqueFunction](API\Runtime\Core\Templates\TUniqueFunction)< void([FParameterInterfacePtr](API\Runtime\Engine\Sound\FParameterInterfacePtr))> && InFunction )


code: void RegisterInterface ( [FParameterInterfacePtr](API\Runtime\Engine\Sound\FParameterInterfacePtr) InInterface )


className: IAudioParameterInterfaceRegistry

description: 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.).

code: class IAudioParameterInterfaceRegistry

Interfaces

type: TSet<FParamete...

RegistrationFunction

type: TUniqueFunction...


description: Returns human-readable string representing the display name of this plugin. This is the name that will be used in settings and .ini files. If multiple IAudioPlugin implementations are found that return identical strings here, The first one of these loaded will be used.FStringof the display name of this plugin.


description:
Returns whether this plugin supports use on the specified platform.
true if this plugin supports use on Platform, false otherwise.

code: bool SupportsPlatform ( const [FString](API\Runtime\Core\Containers\FString) & PlatformName )


description:
Returns whether this plugin sends audio to an external renderer. if this returns true, the audio engine will not mix the result of the audio process callback from the plugin into the audio output.
true only if the plugin will handle sending audio to the DAC itself.

code: virtual bool IsExternalSend()


className: IAudioPluginFactory

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

code: class IAudioPluginFactory


code: virtual void OnDeviceShutdown ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * AudioDevice )


description: This function is called when a game world initializes a listener with an audio device thisIAudioPluginListeneris registered to. Please note that it is possible to miss this event if you register thisIAudioPluginListenerafter the listener is initialized.

code: virtual void OnListenerInitialize ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * AudioDevice, [UWorld](API\Runtime\Engine\Engine\UWorld) * ListenerWorld )


description: Called when the listener is shutdown.

code: virtual void OnListenerShutdown ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * AudioDevice )


description: Called when the listener is updated on the given audio device.

code: virtual void OnListenerUpdated ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * AudioDevice, const int32 ViewportIndex, const FTransform & ListenerTransform, const float InDeltaSeconds )


description: This is overridable for any actions a plugin manager may need to do on a level change.

code: virtual void OnWorldChanged ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * AudioDevice, [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld )


description: This is overridable for any actions a plugin manager may need to do on the game thread.

code: virtual void OnTick ( [UWorld](API\Runtime\Engine\Engine\UWorld) * InWorld, const int32 ViewportIndex, const FTransform & ListenerTransform, const float InDeltaSeconds )


className: IAudioPluginListener

description: IAudioPluginListenerImplementations of this interface can receive updates about the audio listener's position in the game world, as well as other data. to use this, register a ListenerObserver to an audio device usingFAudioDevice::RegisterPluginListener().

code: class IAudioPluginListener


description: Deprecated* Call TSharedPtrCreateProxyData(...) instead of a TUniquePtrCreateNewProxyData(...).

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [Audio::IProxyData](API\Runtime\AudioExtensions\IProxyData) > CreateNewProxyData ( const [Audio::FProxyDataInitParams](API\Runtime\AudioExtensions\FProxyDataInitParams) & InitParams )


className: IAudioProxyDataFactory

description: This can be subclassed to make aUClassan audio proxy factory.

code: class IAudioProxyDataFactory


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [Audio::IProxyData](API\Runtime\AudioExtensions\IProxyData) > CreateProxyData ( const [Audio::FProxyDataInitParams](API\Runtime\AudioExtensions\FProxyDataInitParams) & InitParams )


description: Returns the plugin-managed effect submix instance

code: FSoundEffectSubmixPtr GetEffectSubmix()


description: Returns the plugin-managed effect submix


code: virtual ~IAudioPluginListener()


description: Initialize the reverb plugin with the same rate and number of sources.

code: virtual void Initialize ( const [FAudioPluginInitializationParams](API\Runtime\AudioExtensions\FAudioPluginInitializationParams) InitializationParams )


description: Called when a source is assigned to a voice.

code: void OnInitSource ( const uint32 SourceId, const [FName](API\Runtime\Core\UObject\FName) & AudioComponentUserId, const uint32 NumChannels, [UReverbPluginSourceSettingsBase](API\Runtime\AudioExtensions\UReverbPluginSourceSettingsBase) * InSettings )


description: Called when a source is done playing and is released.

code: void OnReleaseSource ( const uint32 SourceId )


description: Shuts down the audio plugin.

code: virtual void Shutdown()


description: Processes audio with the given input and output data structs.

code: virtual void ProcessSourceAudio ( const [FAudioPluginSourceInputData](API\Runtime\AudioExtensions\FAudioPluginSourceInputData) & InputData, [FAudioPluginSourceOutputData](API\Runtime\AudioExtensions\FAudioPluginSourceOutputData) & OutputData )


description: Virtual destructor

code: virtual ~IAudioReverb()


className: IAudioReverb

code: class IAudioReverb


code: TAudioReverbPtr CreateNewReverbPlugin ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * OwningDevice )


description: theUClasstype of your settings for reverb. This allows us to only pass in user settings for your plugin.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetCustomReverbSettingsClass() const


description: Begin IAudioPluginWithMetadata implementation


description: IModularFeature.


description: Virtual destructor

code: virtual ~IAudioReverbFactory()


className: IAudioReverbFactory

code: class IAudioReverbFactory : public [IAudioPluginFactory](API\Runtime\AudioExtensions\IAudioPluginFactory), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Allows this plugin to override any source data. Called per audio source before any other parameters are updated on sound sources.

code: virtual void GetSourceDataOverrides ( const uint32 SourceId, const FTransform & InListenerTransform, [FWaveInstance](API\Runtime\Engine\FWaveInstance) * InOutWaveInstance )


description: Initializes the source data override plugin with the given buffer length.


code: virtual void OnInitSource ( const uint32 SourceId, const [FName](API\Runtime\Core\UObject\FName) & AudioComponentUserId, [USourceDataOverridePluginSourceSettingsBase](API\Runtime\AudioExtensions\USourceDataOverridePluginSourceS-) * InSettings )


description: Called when all sources have finished processing.

code: virtual void OnAllSourcesProcessed()


code: virtual void OnReleaseSource ( const uint32 SourceId )


description: Virtual destructor

code: virtual ~IAudioSourceDataOverride()


description: a new instance of your source data override plugin, owned by a shared pointer.

code: TAudioSourceDataOverridePtr CreateNewSourceDataOverridePlugin ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * OwningDevice )


description: theUClasstype of your settings for source data overrides. This allows us to only pass in user settings for your plugin.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetCustomSourceDataOverrideSettingsClass() const


className: IAudioSourceDataOverride

description: Interface to allow a plugin to override a sound's actual position and simulate propagation (e.g. traversal around corners, etc).

code: class IAudioSourceDataOverride


description: Virtual destructor


description: Creates an audio spatialization effect.

code: virtual bool CreateSpatializationEffect ( uint32 SourceId )


className: IAudioSourceDataOverrideFactory

description: IAudioSourceDataOverrideFactoryImplement this modular feature to make your SourceDataOverride plugin visible to the engine.

code: class IAudioSourceDataOverrideFactory : public [IAudioPluginFactory](API\Runtime\AudioExtensions\IAudioPluginFactory), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Returns the spatialization effect for the given voice id.

code: virtual void * GetSpatializationEffect ( uint32 SourceId )


description: DEPRECATED: Initializes the spatialization effect with the given buffer length.

code: virtual void InitializeSpatializationEffect ( uint32 BufferLength )


description: DEPRECATED: Gets the spatialization effect parameters.

code: virtual void GetSpatializationParameters ( uint32 SourceId, [FSpatializationParams](API\Runtime\AudioExtensions\FSpatializationParams) & OutParams )


description: Initializes the spatialization plugin with the given buffer length.

code: virtual void Initialize ( const [FAudioPluginInitializationParams](API\Runtime\AudioExtensions\FAudioPluginInitializationParams) InitializationParams )


description: Returns whether or not the spatialization effect has been initialized

code: virtual bool IsSpatializationEffectInitialized() const


code: virtual void OnDeviceShutdown ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * AudioDevice )


description: Called when a source is assigned to a voice.

code: virtual void OnInitSource ( const uint32 SourceId, const [FName](API\Runtime\Core\UObject\FName) & AudioComponentUserId, [USpatializationPluginSourceSettingsBase](API\Runtime\AudioExtensions\USpatializationPluginSourceSetti-) * InSettings )


code: virtual void ProcessAudio ( const [FAudioPluginSourceInputData](API\Runtime\AudioExtensions\FAudioPluginSourceInputData) & InputData, [FAudioPluginSourceOutputData](API\Runtime\AudioExtensions\FAudioPluginSourceOutputData) & OutputData )


description: DEPRECATED: Uses the given HRTF algorithm to spatialize a mono audio stream.

code: virtual void ProcessSpatializationForVoice ( uint32 SourceId, float * InSamples, float * OutSamples, const FVector & Position )


description: DEPRECATED: Uses the given HRTF algorithm to spatialize a mono audio stream, assumes the parameters have already been set before processing.

code: virtual void ProcessSpatializationForVoice ( uint32 SourceId, float * InSamples, float * OutSamples )


description: DEPRECATED: sets the spatialization effect parameters.

code: virtual void SetSpatializationParameters ( uint32 SourceId, const [FSpatializationParams](API\Runtime\AudioExtensions\FSpatializationParams) & Params )


description: Shuts down the audio plugin.

code: virtual void Shutdown()


description: Virtual destructor

code: virtual ~IAudioSpatialization()


className: IAudioSpatialization

description: This class represents instances of a plugin that will process spatialization for a stream of audio. Currently used to process a mono-stream through an HRTF spatialization algorithm into a stereo stream. This algorithm contains an audio effect assigned to every VoiceId (playing sound instance). It assumes the effect is updated in the audio engine update loop with new position information.

code: class IAudioSpatialization


description: a new instance of your spatialization plugin, owned by a shared pointer.

code: TAudioSpatializationPtr CreateNewSpatializationPlugin ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * OwningDevice )


description: theUClasstype of your settings for spatialization. This allows us to only pass in user settings for your plugin.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetCustomSpatializationSettingsClass() const


description: Begin IAudioPluginWithMetadata implementation


description: the max amount of channels your plugin supports. For example, override this to return 2 to support spatializing mono and stereo sources.

code: virtual int32 GetMaxSupportedChannels()


description: IModularFeature.


description: Virtual destructor

code: virtual ~IAudioSpatializationFactory()


className: IAudioSpatializationFactory

description: IAudioSpatializationFactoryImplement this modular feature to make your Spatialization plugin visible to the engine.

code: class IAudioSpatializationFactory : public [IAudioPluginFactory](API\Runtime\AudioExtensions\IAudioPluginFactory), public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


code: virtual [TArray](API\Runtime\Core\Containers\TArray)< const [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [UObject](API\Runtime\CoreUObject\UObject\UObject) > * > GetReferencedObjects() const


code: virtual ~ILegacyParameterTransmitter()


className: ILegacyParameterTransmitter

description: Reference collector functionality for legacy parameter system (i.e. backwards compatibility with the SoundCue system). None of this should be used by future assets supporting parameters (ex. MetaSounds) as object pointers within parameters should NOT be cached on threads other than the GameThread, utilizing a proxy methodology like MetaSounds that copiesUObjectdata when and where necessary.

code: class ILegacyParameterTransmitter


code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IModulatorSettings](API\Runtime\AudioExtensions\IModulatorSettings) > Clone() const


code: const [Audio::FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) & GetOutputParameter() const


code: virtual ~IModulatorSettings()


code: [Audio::FModulatorTypeId](API\Runtime\AudioExtensions\FModulatorTypeId) Register ( [Audio::FModulatorHandleId](API\Runtime\AudioExtensions\FModulatorHandleId) HandleId, [IAudioModulationManager](API\Runtime\AudioExtensions\IAudioModulationManager) & InModulation ) const


className: IModulatorSettings

description: Interface for cached off ModulatorUObjectdata used as default settings to be converted to instanced proxy data per AudioDevice on the AudioRenderThread. If proxy is already active, implementation is expected to ignore register call and return existing modulator proxy's type Id & set parameter accordingly.

code: class IModulatorSettings


description:
Return the cached parameter with the given name if it exists
False if param not found, true if found.

code: bool GetParameter ( [FName](API\Runtime\Core\UObject\FName) InName, [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) & OutParam ) const


description: Return reference to the cached parameter array.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > & GetParameters() const


description: Called when the active sound is deleted due to the sound finishing, being stopped, or being virtualized.

code: virtual void OnDeleteActiveSound()


description: Deprecated* UseResetParameters()orOnDeleteActiveSound()instead depending on use case.

code: virtual bool Reset()


className: RouterName

code: static const [FName](API\Runtime\Core\UObject\FName) RouterName = "ParameterTransmitter";


description: Reset parameters which stored on the transmitter.

code: virtual void ResetParameters()


description: Parameter Setters.

code: bool SetParameters ( [TArray](API\Runtime\Core\Containers\TArray)< [FAudioParameter](API\Runtime\AudioExtensions\FAudioParameter) > && InParameters )


className: IParameterTransmitter

description: An audio instance transmitter ushers control parameters to a single audio object instance.

code: class IParameterTransmitter : public [Audio::ILegacyParameterTransmitter](API\Runtime\AudioExtensions\ILegacyParameterTransmitter)


code: virtual ~IParameterTransmitter()


code: template<typename ProxyType> bool CheckTypeCast() const


description: Deprecated* Proxy data is stored in a TSharedPtr<> and no longer requires cloning

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IProxyData](API\Runtime\AudioExtensions\IProxyData) > Clone() const


code: template<typename ProxyType> ProxyType & GetAs()


code: template<typename ProxyType> const ProxyType & GetAs() const


code: IProxyData ( [FName](API\Runtime\Core\UObject\FName) InProxyTypeName )


className: IProxyData

description: Base class that allows us to typecheck proxy data before downcasting it in debug builds.

code: class IProxyData


description: Create a new version of this packet.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) > Duplicate() const


description: Zero out the contents of this packet.

code: void Reset()


description: Read or write this packet to a byte buffer.

code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: virtual ~ISoundfieldAudioPacket()


className: ISoundfieldAudioPacket

description: This interface represents all encoded soundfield audio from a single render callback.

code: class ISoundfieldAudioPacket


code: void Decode ( const [FSoundfieldDecoderInputData](API\Runtime\AudioExtensions\FSoundfieldDecoderInputData) & InputData, [FSoundfieldDecoderOutputData](API\Runtime\AudioExtensions\FSoundfieldDecoderOutputData) & OutputData )


code: void DecodeAndMixIn ( const [FSoundfieldDecoderInputData](API\Runtime\AudioExtensions\FSoundfieldDecoderInputData) & InputData, [FSoundfieldDecoderOutputData](API\Runtime\AudioExtensions\FSoundfieldDecoderOutputData) & OutputData )


code: virtual ~ISoundfieldDecoderStream()


code: void ProcessAudio ( [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) & InOutPacket, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & EncodingSettings, const [ISoundfieldEffectSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEffectSettingsProxy) & ProcessorSettings )


className: ISoundfieldEffectInstance

description: Single instance that actually processes the soundfield.

code: class ISoundfieldEffectInstance


code: virtual ~ISoundfieldEffectInstance()


className: ISoundfieldDecoderStream

code: class ISoundfieldDecoderStream


className: ISoundfieldEffectSettingsProxy

code: class ISoundfieldEffectSettingsProxy


code: void Encode ( const [FSoundfieldEncoderInputData](API\Runtime\AudioExtensions\FSoundfieldEncoderInputData) & InputData, [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) & OutputData )


code: void EncodeAndMixIn ( const [FSoundfieldEncoderInputData](API\Runtime\AudioExtensions\FSoundfieldEncoderInputData) & InputData, [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) & OutputData )


className: ISoundfieldEncoderStream

code: class ISoundfieldEncoderStream


code: virtual ~ISoundfieldEncoderStream()


description: This should return a unique This is used so that we don't call the same encode operation multiple times for a single source being sent to identical submixes.

code: uint32 GetUniqueId() const


description: This should return a new, identical encoding settings.


className: ISoundfieldEncodingSettingsProxy

description: This interface should be used to provide a non-uclass version of the data described in your implementation ofUSoundfieldEncodingSettingsBase. We will then pass this proxy object to the soundfield stream classes.

code: class ISoundfieldEncodingSettingsProxy


description: OPTIONAL OVERRIDES: For endpoints that do not explicitly fire a timed callback to poll audio data, this should be overridden to return true, and OnAudioCallback and GetDesiredCallbackFrequency should be overridden.

code: virtual bool EndpointRequiresCallback() const


description: For endpoints that return true for EndpointRequiresCallback, this should return the duration between OnAudioCallback calls in seconds.

code: virtual float GetDesiredCallbackPeriodicity() const


description: Returns the amount of ISoundfieldAudioPackets currently buffered for this endpoint.

code: int32 GetNumPacketsBuffer()


description: Returns the amount of ISoundfieldAudioPackets that can be buffered for this endpoint before reaching capacity.

code: int32 GetRemainderInPacketBuffer()


description: METHODS USED BY IMPLEMENTATIONS OFISoundfieldEndpoint: This is used by theIAudioEndpointimplementation to poll buffered audio to process or send to the endpoint. Note that this is NOT thread safe ifEndpointRequiresCallback()is overridden to return true. If that is the case, use an override of OnAudioCallback instead.


description: Use this as a thread safe way to use the current settings posted to thisIAudioEndpoint. Locks with IAudioEndpoint::SetSettings.

code: void PollSettings ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(const [ISoundfieldEndpointSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEndpointSettingsProxy) *)> SettingsCallback )


description: If this endpoint hasn't created it's own async callback thread but still requires an explicit callback, this should be called.

code: void ProcessAudioIfNecessary()


description: Push a soundfield packet to the buffer.

code: bool PushAudio ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) > && InPacket )


code: void RunCallbackSynchronously()


description: Post new settings for this endpoint. There is no type safety on this call, so make sure that you are using the correct implementation ofIAudioEndpointSettingsProxyfor this implementation ofIAudioEndpoint.

code: void SetNewSettings ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldEndpointSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEndpointSettingsProxy) > && InNewSettings )


description: IfEndpointRequiresCallback()returns true, this will be used to spawn an async thread and begin calling OnAudioCallback.

code: void StartRunningCallback()


code: void StopRunningCallback()


description: For endpoints that override EndpointRequiresCallback to return true, this callback will be called every (GetDesiredNumFrames() / GetSampleRate()) seconds.

code: virtual void OnAudioCallback ( [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) > && InPacket, const [ISoundfieldEndpointSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEndpointSettingsProxy) * InSettings )


code: ISoundfieldEndpoint ( int32 NumRenderCallbacksToBuffer )


code: virtual ~ISoundfieldEndpoint()


className: ISoundfieldEndpoint

description: Class that allows soundfield-encoded audio to be sent to an arbitrary locale. For endpoint types that support receiving our downmixed interleaved audio data directly, implementIAudioEndpointinstead.

code: class ISoundfieldEndpoint


code: virtual bool CanTranscodeToSoundfieldFormat ( [FName](API\Runtime\Core\UObject\FName) DestinationFormat, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & DestinationEncodingSettings )


description: This function is not necessary to override, since audio sent to an endpoint does not need to be decoded to interleaved audio buffers.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldDecoderStream](API\Runtime\AudioExtensions\ISoundfieldDecoderStream) > CreateDecoderStream ( const [FAudioPluginInitializationParams](API\Runtime\AudioExtensions\FAudioPluginInitializationParams) & InitInfo, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & InitialSettings )


description: This is the default name used when a user creates a soundfield endpoint submix. Soundfied Endpoint submixes with this type will send their audio to the default output with no encoding.


description: REQUIRED OVERRIDES: These overrides are required fromISoundfieldFactory: ISoundfieldFactory::CreateNewEncoderStream ISoundfieldFactory::CreateNewTranscoderStream ISoundfieldFactory::CreateNewMixerStreamISoundfieldFactory::CreateEmptyPacketISoundfieldFactory::CanTranscodeFromSoundfieldFormatISoundfieldFactory::GetCustomEncodingSettingsClassISoundfieldFactory::GetDefaultEncodingSettingsCalled for every new endpoint submix created with this factory's endpoint type.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldEndpoint](API\Runtime\AudioExtensions\ISoundfieldEndpoint) > CreateNewEndpointInstance ( const [FAudioPluginInitializationParams](API\Runtime\AudioExtensions\FAudioPluginInitializationParams) & InitInfo, const [ISoundfieldEndpointSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEndpointSettingsProxy) & InitialSettings )


description: Get a registered endpoint factory by name.

code: static [ISoundfieldEndpointFactory](API\Runtime\AudioExtensions\ISoundfieldEndpointFactory) * Get ( const [FName](API\Runtime\Core\UObject\FName) & InName )


code: static [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetAllSoundfieldEndpointTypes()


description: Should return the StaticClass of this factory's implementation ofUSoundfieldEndpointSettingsBase.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetCustomEndpointSettingsClass() const


description: Return the settings an endpoint should use if a soundfield endpoint submix did not have their settings specified.


description: Get the name for the endpoint type that this factory produces.


description: This is theFNameused to register Soundfield Endpoint factories with the modular feature system.


description: Get soundfield format name


description: This is overridden to return true for soundfield formats that are only used for sending audio externally. Rather than overriding this, consider implementingISoundfieldEndpointFactory.

code: virtual bool IsEndpointFormat()


description: This needs to be called it an implementation ofISoundfieldFactoryis about to be destroyed. It can be called from the destructor of an implementation ofISoundfieldFactory.

code: static void UnregisterEndpointType ( [ISoundfieldEndpointFactory](API\Runtime\AudioExtensions\ISoundfieldEndpointFactory) * InFactory )


description: This needs to be called to make a soundfield format usable by the engine. It can be called from aISoundfieldFactorysubclass' constructor

code: static void RegisterEndpointType ( [ISoundfieldEndpointFactory](API\Runtime\AudioExtensions\ISoundfieldEndpointFactory) * InFactory )


description: Virtual destructor

code: virtual ~ISoundfieldEndpointFactory()


className: ISoundfieldEndpointFactory

description: This factory is used to expose Soundfield Endpoint types to the editor. Once a factory is constructed and RegisterEndpointType is called, it will be exposed as a type of endpoint That a submix in the submix graph could be constructed with. Also note that an implementation of ISoundfieldDecoder is not necessary for soundfield formats that are only used for soundfield endpoints.

code: class ISoundfieldEndpointFactory : public [ISoundfieldFactory](API\Runtime\AudioExtensions\ISoundfieldFactory)


className: ISoundfieldEndpointSettingsProxy

description: This set of interfaces can be used to This interface should be used to provide a non-uclass version of the data described in your implementation ofUSoundfieldEndpointSettingsBase.

code: class ISoundfieldEndpointSettingsProxy


description: Override this function to decide whether this soundfield format can read and convert from a source format.

code: bool CanTranscodeFromSoundfieldFormat ( [FName](API\Runtime\Core\UObject\FName) SourceFormat, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & SourceEncodingSettings )


code: bool CanTranscodeToSoundfieldFormat ( [FName](API\Runtime\Core\UObject\FName) DestinationFormat, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & DestinationEncodingSettings )


code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldDecoderStream](API\Runtime\AudioExtensions\ISoundfieldDecoderStream) > CreateDecoderStream ( const [FAudioPluginInitializationParams](API\Runtime\AudioExtensions\FAudioPluginInitializationParams) & InitInfo, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & InitialSettings )


description: Called when a stream is opened.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldEncoderStream](API\Runtime\AudioExtensions\ISoundfieldEncoderStream) > CreateEncoderStream ( const [FAudioPluginInitializationParams](API\Runtime\AudioExtensions\FAudioPluginInitializationParams) & InitInfo, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & InitialSettings )


code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldMixerStream](API\Runtime\AudioExtensions\ISoundfieldMixerStream) > CreateMixerStream ( const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & InitialSettings )


code: static [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetAvailableSoundfieldFormats()


description: Transcoder streams are fed a soundfield audio packet with either a different format entirely, or the same format and different settings. Specifying and returns a Transcoder Stream is not necessary if CanTranscodeSoundfieldFormat and ShouldReencodeBetween always returns false.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldTranscodeStream](API\Runtime\AudioExtensions\ISoundfieldTranscodeStream) > CreateTranscoderStream ( const [FName](API\Runtime\Core\UObject\FName) SourceFormat, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & InitialSourceSettings, const [FName](API\Runtime\Core\UObject\FName) DestinationFormat, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & InitialDestinationSettings, const [FAudioPluginInitializationParams](API\Runtime\AudioExtensions\FAudioPluginInitializationParams) & InitInfo )


description: Get a registered soundfield format factory by name.

code: static [ISoundfieldFactory](API\Runtime\AudioExtensions\ISoundfieldFactory) * Get ( const [FName](API\Runtime\Core\UObject\FName) & InName )


description: Should return the StaticClass of your implementation ofUSoundfieldEncodingSettingsBase.

code: virtual [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetCustomEncodingSettingsClass() const


description: When a submix has this format name, it derives its format from the submix it sends audio to.


description: When a submix has this format name, it is using interleaved, floating point audio with no metadata.


description: Get soundfield format name


description: This is theFNameused to register Soundfield Format factories with the modular feature system.


description: Override this function to determine whether an incoming ISoundfieldPacket would need to be explicitly operated on between two submixes with the same format, but potentially different encoding settings. If this returns true, a new transcoder will be created. if this returns false, then the source submix's ISoundfieldPacket will be passed down directly.

code: virtual bool IsTranscodeRequiredBetweenSettings ( const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & SourceSettings, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & DestinationSettings )


code: static void RegisterSoundfieldFormat ( [ISoundfieldFactory](API\Runtime\AudioExtensions\ISoundfieldFactory) * InFactory )


code: static void UnregisterSoundfieldFormat ( [ISoundfieldFactory](API\Runtime\AudioExtensions\ISoundfieldFactory) * InFactory )


className: ISoundfieldFactory

code: class ISoundfieldFactory : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


code: virtual ~ISoundfieldMixerStream()


code: void MixTogether ( const [FSoundfieldMixerInputData](API\Runtime\AudioExtensions\FSoundfieldMixerInputData) & InputData, [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) & PacketToMixInto )


description: If this is overridden to true, we will set up a separate encoding stream for every submix plugged into this soundfield submix. Otherwise, we mix all non-soundfield submixes plugged into this soundfield submix together and use one encoding stream.

code: virtual bool ShouldEncodeAllStreamsIndependently ( const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & EncodingSettings )


description: Virtual destructor

code: virtual ~ISoundfieldFactory()


code: void Transcode ( const [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) & InputData, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & InputSettings, [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) & OutputData, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & OutputSettings )


code: void TranscodeAndMixIn ( const [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) & InputData, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & InputSettings, [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) & PacketToMixTo, const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & OutputSettings )


code: virtual ~ISoundfieldTranscodeStream()


className: ISoundfieldTranscodeStream

code: class ISoundfieldTranscodeStream


className: ISoundfieldMixerStream

code: class ISoundfieldMixerStream


description: Gets the object definition id of the given playing sound's instance

code: uint32 GetObjectId() const


description: Returns number of actively instances of sound playing (including virtualized instances)

code: int32 GetPlayCount() const


description: Returns whether or not sound is an editor preview sound

code: bool IsPreviewSound() const


description: Stops sound.

code: void Stop()


code: virtual ~ISoundModulatable()


className: ISoundModulatable

description: Interface to sound that is modulatable, allowing for certain specific behaviors to be controlled on the sound level by the modulation system.

code: class ISoundModulatable


code: virtual bool CanChangeChannelCount() const


description: Applies the transformation to the waveform and modifies WaveInfo with the resulting changes.

code: virtual void ProcessAudio ( [FWaveformTransformationWaveInfo](API\Runtime\AudioExtensions\FWaveformTransformationWaveInfo) & InOutWaveInfo ) const


code: virtual bool CanChangeFileLength() const


code: virtual bool SupportsRealtimePreview() const


code: virtual ~IWaveTransformation()


className: IWaveTransformation

description: note: WaveTransformation vs WaveformTransformation is to prevent UHT class name conflicts without having to namespace everything - remember this in derived classes!

code: class IWaveTransformation


className: bWasAudioProxyClassImplemented

code: static constexpr bool bWasAudioProxyClassImplemented = false;


className: TProxyData

description: This class can be implemented to create a custom, threadsafe instance of a givenUObject. This is a CRTP class, and should always be subclassed with the name of the subclass.

code: template<typename Type> class TProxyData : public [Audio::IProxyData](API\Runtime\AudioExtensions\IProxyData)


code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAudioEndpointSettingsProxy](API\Runtime\AudioExtensions\IAudioEndpointSettingsProxy) > GetProxy() const


code: UAudioParameterControllerInterface ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UAudioEndpointSettingsBase

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

code: class UAudioEndpointSettingsBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UAudioParameterControllerInterface

code: class UAudioParameterControllerInterface : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


className: UOcclusionPluginSourceSettingsBase

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

code: class UOcclusionPluginSourceSettingsBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: UDummyEndpointSettings

code: class UDummyEndpointSettings : public [UAudioEndpointSettingsBase](API\Runtime\AudioExtensions\UAudioEndpointSettingsBase)


className: UReverbPluginSourceSettingsBase

code: class UReverbPluginSourceSettingsBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: USettingsPtr

code: typedef const UAudioCodecEncoderSettings * USettingsPtr


description: Return the default processor settings we should use when none is provided. Will always be called on the CDO.

code: virtual const [USoundfieldEffectSettingsBase](API\Runtime\AudioExtensions\USoundfieldEffectSettingsBase) * GetDefaultSettings() const


description: Spawn a new instance of this processor.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldEffectInstance](API\Runtime\AudioExtensions\ISoundfieldEffectInstance) > GetNewProcessor ( const [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) & EncodingSettings ) const


description: Get the implementation of USoundfieldProcessorSettingsBase that is used for this processor's settings. Will always be called on the CDO.

code: virtual const [UClass](API\Runtime\CoreUObject\UObject\UClass) * GetSettingsClass() const


code: virtual bool SupportsFormat ( const [FName](API\Runtime\Core\UObject\FName) & InFormat ) const


className: USoundfieldEffectBase

description: 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.

code: class USoundfieldEffectBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

Settings

type: TObjectPtr<USo...

description: TODO: Filter classes settable on here by GetSettingsClass.


code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldEffectSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEffectSettingsProxy) > GetNewProxy() const


className: USoundfieldEffectSettingsBase

code: class USoundfieldEffectSettingsBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) > GetProxy() const


className: USoundfieldEncodingSettingsBase

code: class USoundfieldEncodingSettingsBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldEndpointSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEndpointSettingsProxy) > GetProxy() const


className: USoundfieldEndpointSettingsBase

code: class USoundfieldEndpointSettingsBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [Audio::IProxyData](API\Runtime\AudioExtensions\IProxyData) > CreateProxyData ( const [Audio::FProxyDataInitParams](API\Runtime\AudioExtensions\FProxyDataInitParams) & InitParams )


code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [Audio::IModulatorSettings](API\Runtime\AudioExtensions\IModulatorSettings) > CreateProxySettings() const


className: USoundModulatorBase

description: Base class for all modulators

code: class USoundModulatorBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject), public [IAudioProxyDataFactory](API\Runtime\AudioExtensions\IAudioProxyDataFactory)


code: virtual const [Audio::FModulationParameter](API\Runtime\AudioExtensions\FModulationParameter) & GetOutputParameter() const


code: class USourceDataOverridePluginSourceSettingsBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


className: USpatializationPluginSourceSettingsBase

code: class USpatializationPluginSourceSettingsBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: virtual [Audio::FTransformationPtr](API\Runtime\AudioExtensions\FTransformationPtr) CreateTransformation() const


code: virtual void UpdateConfiguration ( [FWaveTransformUObjectConfiguration](API\Runtime\AudioExtensions\FWaveTransformUObjectConfigurati-) & InOutConfiguration )


className: UWaveformTransformationBase

description: Base class to hold editor configurable properties for an arbitrary transformation of audio waveform data.

code: class UWaveformTransformationBase : public [UObject](API\Runtime\CoreUObject\UObject\UObject)


code: [TArray](API\Runtime\Core\Containers\TArray)< [Audio::FTransformationPtr](API\Runtime\AudioExtensions\FTransformationPtr) > CreateTransformations() const


className: UWaveformTransformationChain

description: Object that holds an ordered list of transformations to perform on a sound wave.

code: class UWaveformTransformationChain : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

Transformations

type: TArray<TObject...


className: IAudioLink

description: IAudioLinkAbstract interface for AudioLink instances. Purely opaque.

module: AudioLinkEngine

code: class IAudioLink


code: bool IsLinkPlaying() const


code: void PlayLink ( float StartTime )


code: void SetLinkSound ( [USoundBase](API\Runtime\Engine\Sound\USoundBase) * NewSound )


className: IAudioLinkBlueprintInterface

code: class IAudioLinkBlueprintInterface : public [IInterface](API\Runtime\CoreUObject\UObject\IInterface)


description: Stop an audio component's sound, issue any delegates if needed

code: void StopLink()


code: virtual FSharedBufferedOutputPtr CreatePushableBufferListener ( const [FPushedBufferListenerCreateParams](API\Runtime\AudioLinkEngine\IAudioLinkFactory\FPushedBufferListenerCreateParam-) & )


description:
Create a Source Audio Link.
The newly created Link instance (if successful).

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAudioLink](API\Runtime\AudioLinkEngine\IAudioLink) > CreateSourceAudioLink ( const [FAudioLinkSourceCreateArgs](API\Runtime\AudioLinkEngine\IAudioLinkFactory\FAudioLinkSourceCreateArgs) & )


code: virtual FSharedBufferedOutputPtr CreateSourceBufferListener ( const [FSourceBufferListenerCreateParams](API\Runtime\AudioLinkEngine\IAudioLinkFactory\FSourceBufferListenerCreateParam-) & )


description:
Create a Submix Audio Link.
The newly created Link instance (if successful).

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [IAudioLink](API\Runtime\AudioLinkEngine\IAudioLink) > CreateSubmixAudioLink ( const [FAudioLinkSubmixCreateArgs](API\Runtime\AudioLinkEngine\IAudioLinkFactory\FAudioLinkSubmixCreateArgs) & InCreateArgs )


code: virtual FSharedBufferedOutputPtr CreateSubmixBufferListener ( const [FSubmixBufferListenerCreateParams](API\Runtime\AudioLinkEngine\IAudioLinkFactory\FSubmixBufferListenerCreateParam-) & )


className: FAudioLinkSourceCreateArgs

description: Parameters use when creating a Source Audio Link

code: struct FAudioLinkSourceCreateArgs

AudioComponent

type: TWeakObjectPtr<...


className: FAudioLinkSourcePushedCreateArgs

code: struct FAudioLinkSourcePushedCreateArgs

OwnerName

type: FName

Settings

type: UAudioLinkSetti...


className: FAudioLinkSourcePushedSharedPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAudioLinkSourcePushed](API\Runtime\AudioLinkEngine\IAudioLinkSourcePushed), ESPMode::ThreadSafe > FAudioLinkSourcePushedSharedPtr


className: FAudioLinkSubmixCreateArgs

description: Parameters use when creating a Submix Audio Link

code: struct FAudioLinkSubmixCreateArgs

Device

type: FAudioDevice&#...


className: FAudioLinkSynchronizerSharedPtr

description: Create a AudioLinkSynchronizer callback

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAudioLinkSynchronizer](API\Runtime\AudioLinkEngine\IAudioLinkSynchronizer), ESPMode::ThreadSafe > FAudioLinkSynchronizerSharedPtr


description:
Gets all registered factory names
Array of all factory names

code: static [IAudioLinkFactory](API\Runtime\AudioLinkEngine\IAudioLinkFactory) * FindFactory ( const [FName](API\Runtime\Core\UObject\FName) InFactoryName )


className: FPushedBufferListenerCreateParams


className: FSourceBufferListenerCreateParams


description:
Gets all registered factory instances.
Array of all factories.

code: static [TArray](API\Runtime\Core\Containers\TArray)< [IAudioLinkFactory](API\Runtime\AudioLinkEngine\IAudioLinkFactory) * > GetAllRegisteredFactories()


className: FSubmixBufferListenerCreateParams


code: static [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetAllRegisteredFactoryNames()


description:
Gets the name of this factory type. This will uniquely identity itself, so it can be found by the FindFactory call below
Name of factory


description:
Get the name of all AudioLink factories in the Modular Features registry.
"AudioLink Factory"


description:
Gets the type of of the settings object that this factory uses to define its specific settings. All settings for each AudioLink factory will derive from UAudioLinkSettingsAbstract
Class of the Settings Object

code: [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< UAudioLinkSettingsAbstract > GetSettingsClass() const


description: Constructor will auto register this instance.

code: IAudioLinkFactory()


description: Destructor will auto unregister this instance.

code: virtual ~IAudioLinkFactory()


className: IAudioLinkFactory

description: IAudioLinkFactoryAbstract interface for AudioLink factory objects.

code: class IAudioLinkFactory : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


className: FOnNewBufferParams

code: struct FOnNewBufferParams

Buffer

type: TArrayView< flo...


className: FOnUpdateWorldStateParams

code: struct FOnUpdateWorldStateParams

WorldTransform

type: FTransform


code: void OnNewBuffer ( const [FOnNewBufferParams](API\Runtime\AudioLinkEngine\IAudioLinkSourcePushed\FOnNewBufferParams) & )


code: void OnSourceDone ( const int32 SourceId )


code: void OnSourceReleased ( const int32 SourceId )


code: void OnUpdateWorldState ( const [FOnUpdateWorldStateParams](API\Runtime\AudioLinkEngine\IAudioLinkSourcePushed\FOnUpdateWorldStateParams) & )


code: virtual ~IAudioLinkSourcePushed()


className: IAudioLinkSourcePushed

description: IAudioLinkSourcePushedWhere the owning object needs to push it's state

code: class IAudioLinkSourcePushed : public [IAudioLink](API\Runtime\AudioLinkEngine\IAudioLink)


className: FOnBeginRender

code: typedef TMulticastDelegate_OneParam< void, const [FOnRenderParams](API\Runtime\AudioLinkEngine\IAudioLinkSynchronizer\FOnRenderParams) & > FOnBeginRender


className: FOnCloseStream

code: typedef TMulticastDelegate_NoParams< void > FOnCloseStream


className: FOnEndRender

code: typedef TMulticastDelegate_OneParam< void, const [FOnRenderParams](API\Runtime\AudioLinkEngine\IAudioLinkSynchronizer\FOnRenderParams) & > FOnEndRender


className: FOnOpenStream

code: typedef TMulticastDelegate_OneParam< void, const [FOnOpenStreamParams](API\Runtime\AudioLinkEngine\IAudioLinkSynchronizer\FOnOpenStreamParams) & > FOnOpenStream


className: FOnOpenStreamParams

code: struct FOnOpenStreamParams

Name

type: FString


className: FOnRenderParams

code: struct FOnRenderParams


className: FOnResume

code: typedef TMulticastDelegate_NoParams< void > FOnResume


className: FOnSuspend

code: typedef TMulticastDelegate_NoParams< void > FOnSuspend


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterBeginRenderDelegate ( const FOnBeginRender::FDelegate & )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterCloseStreamDelegate ( const FOnCloseStream::FDelegate & )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterEndRenderDelegate ( const FOnEndRender::FDelegate & )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterOpenStreamDelegate ( const FOnOpenStream::FDelegate & )


code: bool RemoveBeginRenderDelegate ( const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterResumeDelegate ( const FOnResume::FDelegate & )


code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterSuspendDelegate ( const FOnSuspend::FDelegate & )


code: bool RemoveCloseStreamDelegate ( const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & )


code: bool RemoveEndRenderDelegate ( const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & )


code: bool RemoveOpenStreamDelegate ( const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & )


code: bool RemoveResumeDelegate ( const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & )


code: bool RemoveSuspendDelegate ( const [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) & )


code: virtual ~IAudioLinkSynchronizer()


className: IAudioLinkSynchronizer

description: IAudioLinkSynchronizerProvides delegates for hooking and external AudioLinks synchronization callbacks.

code: class IAudioLinkSynchronizer


code: bool operator&61;&61; &40; const FBufferFormat & InRhs &41; const


className: FBufferFormat

description: The format of a buffer.

code: struct FBufferFormat


className: FBufferStreamEnd

description: Stream of buffers ended.

code: struct FBufferStreamEnd


className: FOnBufferStreamEnd

description: Delegates.

code: typedef TBaseDelegate_OneParam< void, [FBufferStreamEnd](API\Runtime\AudioLinkEngine\IBufferedAudioOutput\FBufferStreamEnd) > FOnBufferStreamEnd


className: FOnFormatKnown

description: Delegates.

code: typedef TBaseDelegate_OneParam< void, [FBufferFormat](API\Runtime\AudioLinkEngine\IBufferedAudioOutput\FBufferFormat) > FOnFormatKnown


description:
Gets the format of the buffer, if its known.
success true, false otherwise.

code: bool GetFormat ( [FBufferFormat](API\Runtime\AudioLinkEngine\IBufferedAudioOutput\FBufferFormat) & OutFormat ) const


code: virtual [IPushableAudioOutput](API\Runtime\AudioLinkEngine\IPushableAudioOutput) * GetPushableInterface()


code: virtual const [IPushableAudioOutput](API\Runtime\AudioLinkEngine\IPushableAudioOutput) * GetPushableInterface() const


description:
Attempts to Atomically copy a buffer sized amount of Buffered Sample data from the interface.
false no more data, true more data to come

code: bool PopBuffer ( float * InBuffer, int32 InBufferSizeInSamples, int32 & OutSamplesWritten )


description: Reserve at least this many samples in buffer.

code: void Reserve ( int32 InNumSamplesToReserve, int32 InNumSamplesOfSilence )


code: void SetBufferStreamEndDelegate ( [FOnBufferStreamEnd](API\Runtime\AudioLinkEngine\IBufferedAudioOutput\FOnBufferStreamEnd) InBufferStreamEndDelegate )


code: void SetFormatKnownDelegate ( [FOnFormatKnown](API\Runtime\AudioLinkEngine\IBufferedAudioOutput\FOnFormatKnown) InFormatKnownDelegate )


code: bool Start ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * InAudioDevice )


code: void Stop ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * InAudioDevice )


code: virtual ~IBufferedAudioOutput()


className: IBufferedAudioOutput

description: Abstract interface for communication with outputting audio objects Examples concrete implementation of these are (source, submix etc).

code: class IBufferedAudioOutput


className: FOnNewBufferParams

code: struct FOnNewBufferParams

AudioData

type: const float ...


code: void LastBuffer ( int32 InId )


code: void PushNewBuffer ( const [FOnNewBufferParams](API\Runtime\AudioLinkEngine\IPushableAudioOutput\FOnNewBufferParams) & )


code: UAudioLinkBlueprintInterface ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: IPushableAudioOutput

code: class IPushableAudioOutput


className: UAudioLinkBlueprintInterface

code: class UAudioLinkBlueprintInterface : public [UInterface](API\Runtime\CoreUObject\UObject\UInterface)


description: Plugin interface for Non Real-Time (NRT) Audio Analyzers.

module: AudioMixer

code: namespace Audio { enum EMixerSourceSubmixSendStage { PostDistanceAttenuation, PreDistanceAttenuation, } }


description: Master submixes.

code: namespace Audio { namespace EMasterSubmixType { enum Type { Master, BaseDefault, Reverb, EQ, Count, } } }


className: FOnSynthEnvelopeValue

description: Called by a synth component and returns the sound's envelope value (using an envelope follower in the audio renderer). This only works in the audio mixer.

code: class FOnSynthEnvelopeValue


code: void OnGeneratedBuffer ( const float * AudioBuffer, const int32 NumSamples, const int32 NumChannels )


className: IAudioBufferListener

description: Simple interface class to allow objects to route audio between them.

code: class IAudioBufferListener


description: Activates the SceneComponent, should be overridden by native child classes.

code: virtual void Activate ( bool bReset )


description: Adds and removes audio buffer listener.

code: void AddAudioBufferListener ( [IAudioBufferListener](API\Runtime\AudioMixer\Components\IAudioBufferListener) * InAudioBufferListener )


description: This function allows designers to trigger an adjustment to the sound instance’s playback Volume with options for smoothly applying a curve over time.

code: void AdjustVolume ( float AdjustVolumeDuration, float AdjustVolumeLevel, const EAudioFaderCurve FadeCurve ) const


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Creates the audio component if it hasn't already been created yet. This should only be used when trying to assign explicit settings to the AudioComponent before callingStart().

code: void CreateAudioComponent()


description: Implemented by the synth component to create a generator object instead of generating audio directly on the synth component. This method prevents UObjects from having to exist in the audio render thread.

code: virtual ISoundGeneratorPtr CreateSoundGenerator ( const [FSoundGeneratorInitParams](API\Runtime\Engine\Sound\FSoundGeneratorInitParams) & InParams )


description: Deactivates the SceneComponent.

code: virtual void Deactivate()


description: Ends gameplay for this component. Called fromAActor::EndPlayonly if bHasBegunPlay is true

code: virtual void EndPlay ( const [EEndPlayReason::Type](API\Runtime\Engine\Engine\EEndPlayReason__Type) EndPlayReason )


description: This function allows designers to call Play on an Audio Component instance while applying a volume curve over time. Parameters allow designers to indicate the duration of the fade, the curve shape, and the start time if seeking into the sound.

code: void FadeIn ( float FadeInDuration, float FadeVolumeLevel, float StartTime, const EAudioFaderCurve FadeCurve ) const


description: This function allows designers to call a delayed Stop on an Audio Component instance while applying a volume curve over time. Parameters allow designers to indicate the duration of the fade and the curve shape.

code: void FadeOut ( float FadeOutDuration, float FadeVolumeLevel, const EAudioFaderCurve FadeCurve ) const


description: Retrieves this synth component's audio component.


description:
Gets the set of currently active modulators for a given Modulation Destination.
The set of of Modulators applied to this component for the given Destination.

code: [TSet](API\Runtime\Core\Containers\TSet)< [USoundModulatorBase](API\Runtime\AudioExtensions\USoundModulatorBase) * > GetModulators ( const EModulationDestination Destination )


description: Gets the audio device associated with this synth component.

code: [FAudioDevice](API\Runtime\Engine\FAudioDevice) * GetAudioDevice() const


code: virtual [USoundClass](API\Runtime\Engine\Sound\USoundClass) * GetSoundClass()


description: Called when synth is created.

code: virtual bool Init ( int32 & SampleRate )


description: Call if creating this synth component not via an actor component in BP, but in code or some other location. Optionally override the sample rate of the sound wave, otherwise it uses the audio device's sample rate.

code: void Initialize ( int32 SampleRateOverride )


description: Returns true if this component is currently playing.

code: bool IsPlaying() const


description: Overridable check for a component to indicate to its Owner that it should prevent the Actor from auto destroying when finished

code: virtual bool IsReadyForOwnerToAutoDestroy() const


code: void OnAudioComponentEnvelopeValue ( const [UAudioComponent](API\Runtime\Engine\Components\UAudioComponent) * AudioComponent, const [USoundWave](API\Runtime\Engine\Sound\USoundWave) * SoundWave, const float EnvelopeValue )


description: Called when the synth component begins generating audio in render thread.

code: virtual void OnBeginGenerate()


description: Called when the synth has finished generating audio on the render thread.

code: virtual void OnEndGenerate()


description: Called when more audio is needed to be generated This method of generating audio is soon to be deprecated. For all new synth components, create an FSoundGenerator instance and implement CreateSoundGenerator method to create an instance.

code: virtual int32 OnGenerateAudio ( float * OutAudio, int32 NumSamples )


description: Called by procedural sound wave Returns the number of samples actually generated

code: int32 OnGeneratePCMAudio ( float * GeneratedPCMData, int32 NumSamples )


description: Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

code: virtual void OnRegister()


description: Deprecated* Use OnBeginGenerate to get a callback before audio is generating on the audio render thread

code: virtual void OnStart()


description: Deprecated* Use OnEndGenerate to get a callback when audio stops generating on the audio render thread

code: virtual void OnStop()


description: Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called.

code: virtual void OnUnregister()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


code: void RemoveAudioBufferListener ( [IAudioBufferListener](API\Runtime\AudioMixer\Components\IAudioBufferListener) * InAudioBufferListener )


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Sets how much audio the sound should send to the given AudioBus (post effect).

code: void SetAudioBusSendPostEffect ( [UAudioBus](API\Runtime\Engine\Sound\UAudioBus) * AudioBus, float AudioBusSendLevel )


description: Sets how much audio the sound should send to the given AudioBus (pre effect).

code: void SetAudioBusSendPreEffect ( [UAudioBus](API\Runtime\Engine\Sound\UAudioBus) * AudioBus, float AudioBusSendLevel )


description: Sets whether or not the low pass filter is enabled on the audio component.

code: void SetLowPassFilterEnabled ( bool InLowPassFilterEnabled )


description: Sets lowpass filter frequency of the audio component.

code: virtual void SetLowPassFilterFrequency ( float InLowPassFilterFrequency )


description: Sets the routing for one of the given Synth component's Modulation Destinations.

code: void SetModulationRouting ( const [TSet](API\Runtime\Core\Containers\TSet)< [USoundModulatorBase](API\Runtime\AudioExtensions\USoundModulatorBase) * > & Modulators, const EModulationDestination Destination, const EModulationRouting RoutingMethod )


description: Sets how much audio the sound should send to the given SourceBus (post effect).

code: void SetSourceBusSendPostEffect ( [USoundSourceBus](API\Runtime\Engine\Sound\USoundSourceBus) * SoundSourceBus, float SourceBusSendLevel )


description: Sets whether or not the synth component outputs its audio to any source or audio buses.

code: void SetOutputToBusOnly ( bool bInOutputToBusOnly )


description: Sets how much audio the sound should send to the given SourceBus (pre effect).

code: void SetSourceBusSendPreEffect ( [USoundSourceBus](API\Runtime\Engine\Sound\USoundSourceBus) * SoundSourceBus, float SourceBusSendLevel )


description: Sets how much audio the sound should send to the given submix.

code: void SetSubmixSend ( [USoundSubmixBase](API\Runtime\Engine\Sound\USoundSubmixBase) * Submix, float SendLevel )


description: Set a new volume multiplier

code: void SetVolumeMultiplier ( float VolumeMultiplier )


description: Starts the synth generating audio.

code: void Start()


description: Stops the synth generating audio.

code: void Stop()


description: Method to execute parameter changes on game thread in audio render thread.

code: void SynthCommand ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void()> Command )


code: USynthComponent ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: USynthComponent

code: class USynthComponent : public [USceneComponent](API\Runtime\Engine\Components\USceneComponent)

AttenuationOverrides

type: FSoundAttenuati...

description: If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component

AttenuationSettings

type: TObjectPtr< cla...

description: If bOverrideSettings is false, the asset to use to determine attenuation properties for sounds generated by this component

bAllowSpatialization

type: uint8:  1

description: Is this audio component allowed to be spatialized?

bAlwaysPlay

description: Whether to artificially prioritize the component to play

bAutoDestroy

description: Auto destroy this component on completion

bEnableBaseSubmix

type: uint32:  1

description: If enabled, sound will route to the Master Submix by default or to the Base Submix if defined.

bEnableBusSends

description: Whether or not to enable sending this audio's output to buses.

bEnableSubmixSends

description: Whether or not to enable Submix Sends other than the Base Submix.

bIsPreviewSound

description: Whether or not this synth is playing as a preview sound

bIsUISound

description: Whether or not this sound plays when the game is paused in the UI

bOverrideAttenuation

description: Should the Attenuation Settings asset be used (false) or should the properties set directly on the component be used for attenuation properties

bStopWhenOwnerDestroyed

description: Stop sound when owner is destroyed

BusSends

type: TArray<FSoundS...

description: This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.

ConcurrencySet

type: TSet<TObjectPt...

description: What sound concurrency to use for sounds generated by this audio component

EnvelopeFollowerAttackTime

description: The attack time in milliseconds for the envelope follower.

EnvelopeFollowerReleaseTime

description: The release time in milliseconds for the envelope follower.

ModulationRouting

type: FSoundModulatio...

NumChannels

description: Can be set by the derived class, defaults to 2.

OnAudioEnvelopeValue

type: FOnSynthEnvelop...

OnAudioEnvelopeValueNative

description: Shadow delegate for nonUObjectsubscribers

PreEffectBusSends

description: This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.

PreferredBufferLength

description: Can be set by the derived class- sets the preferred callback size for the synth component.

SoundClass

description: Sound class this sound belongs to

SoundSubmix

description: Submix this sound belongs to

SoundSubmixSends

description: An array of submix sends. Audio from this sound will send a portion of its audio to these effects.

SourceEffectChain

description: The source effect chain to use for this sound.


description: Creates a sound generator instance from this sound base. Return true if this is being implemented by a subclass. Sound generators procedurally generate audio in the audio render thread.

code: virtual ISoundGeneratorPtr CreateSoundGenerator ( const [FSoundGeneratorInitParams](API\Runtime\Engine\Sound\FSoundGeneratorInitParams) & InParams )


description: Return the format of the generated PCM data type. Used in audio mixer to allow generating float buffers and avoid unnecessary format conversions. This feature is only supported in audio mixer. If your procedural sound wave needs to be used in both audio mixer and old audio engine, it's best to generate int16 data as old audio engine only supports int16 formats. Or check at runtime if the audio mixer is enabled. Audio mixer will convert from int16 to float internally.


code: [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [USynthComponent](API\Runtime\AudioMixer\Components\USynthComponent) > & GetOwningSynthComponentPtr()


code: void Init ( [USynthComponent](API\Runtime\AudioMixer\Components\USynthComponent) * InSynthComponent, const int32 InNumChannels, const int32 SampleRate, const int32 InCallbackSize )


description: BeginUSoundWave

code: virtual void OnBeginGenerate()


description: Virtual function to generate PCM audio from the audio render thread. Returns number of samples generated

code: virtual int32 OnGeneratePCMAudio ( [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & OutAudio, int32 NumSamples )


description: Called when the procedural sound wave is done generating on the render thread. Only used in the audio mixer and when bProcedural is true..

code: virtual void OnEndGenerate()


code: void StartOnAudioDevice ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * InAudioDevice )


code: USynthSound ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: USynthSound

code: class USynthSound : public [USoundWaveProcedural](API\Runtime\Engine\Sound\USoundWaveProcedural)

FloatBuffer

type: TArray< float >

OwningSynthComponent

description: EndUSoundWave


className: InstanceIdCounter

code: static std::atomic< uint32 > InstanceIdCounter = 0;


description: For construction with a givenUObjectunique id.

code: FAudioBusKey ( uint32 InObjectId )


className: FAudioBusKey

code: struct FAudioBusKey


className: FAudioBusSend

description: Struct holding mappings of runtime source ids (bus instances) to bus send level.

code: struct FAudioBusSend

SendLevel

type: float


description: Returns file information.

code: void GetFileInfo ( [FSoundQualityInfo](API\Developer\TargetPlatform\Interfaces\FSoundQualityInfo) & OutInfo )


code: bool PopAudio ( float * OutAudio, int32 NumSamples )


description: Constructor. Takes a file path and immediately loads info. Optionally, CallbackSize can be used to indicate the size of chunks that will be popped off of this instance. When set to 0, the entire file is decompressed into memory.

code: FAudioFileReader ( const [FString](API\Runtime\Core\Containers\FString) & InPath )


className: FAudioFileReader

code: class FAudioFileReader


code: FAudioOutputDeviceInfo ( const [Audio::FAudioPlatformDeviceInfo](API\Runtime\AudioMixerCore\FAudioPlatformDeviceInfo) & InDeviceInfo )


className: FAudioOutputDeviceInfo

description: Platform audio output device info, in a Blueprint-readable format

code: struct FAudioOutputDeviceInfo

bIsCurrentDevice

description: Whether or not this device is the device currently in use

bIsSystemDefault

description: Whether or not this device is the system default

DeviceId

description: ID of the device.

Format

type: EAudioMixerStre...

description: The data format of the audio stream

Name

description: The name of the audio device

NumChannels

description: The number of channels supported by the audio device

OutputChannelArray

type: TArray< EAudioM...

description: The output channel array of the audio device

SampleRate

description: The sample rate of the audio device


className: FAudioThreadTimingData

description: Data used to schedule events automatically in the audio renderer in audio mixer.

code: struct FAudioThreadTimingData

AudioRenderThreadTime

type: double

description: The clock of the audio render thread.

AudioThreadTime

description: The clock of the audio thread, periodically synced to the audio render thread time.

AudioThreadTimeJitterDelta

description: The current audio thread fraction for audio events relative to the render thread.

StartTime

description: The time since audio device started.


description: TMapdoesn't compile using non-copyable types as value types, though you can build and use aTMapwithout using the copy constructor.

code: FChildSubmixInfo ( const [FChildSubmixInfo](API\Runtime\AudioMixer\FChildSubmixInfo) & InInfo )


code: FChildSubmixInfo ( [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FMixerSubmix](API\Runtime\AudioMixer\FMixerSubmix), ESPMode::ThreadSafe > SubmixWeakPtr )


className: FChildSubmixInfo

code: struct FChildSubmixInfo

Encoder

type: TUniquePtr<ISo...

description: If the child submix is not a soundfield submix, we may need to encode its audio output in ProcessAudio.

IncomingPacketToTranscode

description: This is filled by either the Encoder or the Transcoder, and passed to this submix' mixer.

SubmixPtr

type: TWeakPtr<FMixe...

Transcoder

description: If this child submix is a soundfield submix that we can read the output of, we may need to transcode it's audio output.


description: Get audio buffer.

code: bool GetAudioBuffer ( const int32 InNumFrames, const int32 InNumChannels, [FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & OutAudioBuffer )


description: Return the underlying sound wave.


code: [TObjectPtr](API\Runtime\Core\Delegates\TObjectPtr)< [USoundWave](API\Runtime\Engine\Sound\USoundWave) > & GetSoundWavePtr()


description: Initializes the decoding source.

code: void Init()


description: If the sound source finished playing all its source. Will only return true for non-looping sources.

code: bool IsFinished() const


description: Returns if we've been initialized.

code: bool IsInitialized() const


description: Queries if we're ready to initialize.

code: bool IsReadyToInit()


description: Called before we initialize.

code: bool PreInit ( int32 OutputSampleRate )


description: Sets the ForceSyncDecode flag. (Decodes for this soundwave will not happen in an async task if true)

code: void SetForceSyncDecode ( bool bShouldForceSyncDecode )


description: Sets the pitch scale.

code: void SetPitchScale ( float InPitchScale, uint32 NumFrames )


description: Sets the volume scale.

code: void SetVolumeScale ( float InVolumeScale, uint32 NumFrames )


code: FDecodingSoundSource ( [FAudioDevice](API\Runtime\Engine\FAudioDevice) * AudioDevice, const [FSourceDecodeInit](API\Runtime\AudioMixer\FSourceDecodeInit) & InitData )


className: FDecodingSoundSource

code: class FDecodingSoundSource


className: FDecodingSoundSourceHandle

code: struct FDecodingSoundSourceHandle

SoundWaveName

type: FName


className: FDecodingSoundSourcePtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDecodingSoundSource](API\Runtime\AudioMixer\FDecodingSoundSource) > FDecodingSoundSourcePtr


description: Allow anybody to write audio into this audio bus from any thread.

code: void AddNewPatchInput ( const [FPatchInput](API\Runtime\SignalProcessing\DSP\FPatchInput) & InPatchInput )


description: Allow anybody to add a pre-existing patch output object to the audio bus.

code: void AddNewPatchOutput ( const [FPatchOutputStrongPtr](API\Runtime\Engine\FPatchOutputStrongPtr) & InPatchOutputStrongPtr )


code: void RemovePatchInput ( const [FPatchInput](API\Runtime\SignalProcessing\DSP\FPatchInput) & InPatchInput )


className: FMixerAudioBus

description: No constructors are accessible with public or protected access.

code: class FMixerAudioBus