FSoundEffectSubmix

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

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

void

 

Init

(
    const FSoundEffectSubmixInitData& ...
)

Called on an audio effect at initialization on main thread before audio processing begins.

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

void

 

Tick()

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

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

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

Post Feedback