FSoundEffectSubmix

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Sound/SoundEffectSubmix.h

Include

#include "Sound/SoundEffectSubmix.h"

Syntax

class FSoundEffectSubmix : public FSoundEffectBase

Constructors

Name Description

Protected function

FSoundEffectSubmix()

Destructors

Name Description

Public function Virtual

~FSoundEffectSubmix()

Functions

Name Description

Public function Virtual Const

uint32

 

GetDesiredInputChannelCountOverride()

Override to down mix input audio to a desired channel count.

Public function Virtual Const

float

 

GetDryLevel()

Allow effects to supply a drylevel.

Public function Const

const FSound...

 

GetInitData()

Returns the data that was given to the source effect when initialized.

Public function Virtual

void

 

OnProcessAudio

(
    const FSoundEffectSubmixInputData&...,
    FSoundEffectSubmixOutputData& OutD...
)

Process the input block of audio. Called on audio thread.

Public function

void

 

ProcessAudio

(
    FSoundEffectSubmixInputData& InDat...,
    FSoundEffectSubmixOutputData& OutD...
)

Processes audio in the submix effect.

Public function Virtual

bool

 

SetParameters

(
    const FAudioEffectParameters& InPa...
)

Provided for interpolating parameters from audio volume system, enabling transition between various settings.

Public function

void

 

Setup

(
    const FSoundEffectSubmixInitData& ...
)

Called by the audio engine or systems internally. This function calls the virtual Init function implemented by derived classes.

Public function Virtual Const

bool

 

SupportsDefaultEQ()

Whether or not effect supports default EQ system.

Public function Virtual Const

bool

 

SupportsDefaultReverb()

Whether or not effect supports default reverb system.

Public function Virtual

void

 

Tick()

Called on game thread to allow submix effect to query game data if needed.