USoundSubmix

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

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

Include

#include "Sound/SoundSubmix.h"

Syntax

class USoundSubmix : public UObject

Variables

Name Description

Public variable

UAmbisonicsSubm...

 

AmbisonicsPluginSettings

TODO: Hide this unless Channel Format is ambisonics. Also, worry about thread safety.

Public variable

uint8: 1

 

bMuteWhenBackgrounded

Mute this submix when the application is muted or in the background.

Public variable

ESubmixChannelF...

 

ChannelFormat

Experimental! Specifies the channel format for the submix. Sources will be mixed at the specified format. Useful for specific effects that need to operate on a specific format.

Public variable

TArray< USoundS...

 

ChildSubmixes

Child submixes to this sound mix.

Public variable

int32

 

EnvelopeFollowerAttackTime

The attack time in milliseconds for the envelope follower.

Public variable

int32

 

EnvelopeFollowerReleaseTime

The release time in milliseconds for the envelope follower.

Public variable

FOnSubmixRecord...

 

OnSubmixRecordedFileDone

Blueprint delegate for when a recorded file is finished exporting.

Public variable

float

 

OutputVolume

The output volume of the submix. Applied after submix effects and analysis are performed.

Public variable

USoundSubmix &#...

 

ParentSubmix

Protected variable

TUniquePtr< Aud...

 

RecordingData

State handling for bouncing output.

Public variable

UEdGraph *

 

SoundSubmixGraph

EdGraph based representation of the SoundSubmix

Public variable

TArray< USoundE...

 

SubmixEffectChain

Constructors

Name Description

Public function

USoundSubmix

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

AddEnvelopeFollowerDelegate

(
    const UObject* WorldContextObj...,
    const FOnSubmixEnvelopeBP& OnSubmi...
)

Public function Static

void

 

AddReferencedObjects

(
    UObject* InThis,
    FReferenceCollector& Collector
)

Add Referenced objects

Public function Static

TSharedPtr< ...

 

GetSoundSubmixAudioEditor()

Gets the sound submix graph editor implementation.

Public function

bool

 

RecurseCheckChild

(
    USoundSubmix* ChildSoundSubmix
)

Sound Submix Editor functionality.

Public function

void

 

RefreshAllGraphs

(
    bool bIgnoreThis
)

Refresh all EdGraph representations of SoundSubmixes

Public function

void

 

RegisterSubmixBufferListener

(
    ISubmixBufferListener* InBuffe...
)

Registers and unregisters buffer listeners with the submix.

Public function

void

 

SetParentSubmix

(
    USoundSubmix* InParentSubmix
)

Set the parent submix of this SoundSubmix, removing it as a child from its previous owner

Public function Static

void

 

SetSoundSubmixAudioEditor

Sets the sound submix graph editor implementation.*

Public function

void

 

SetSubmixOutputVolume

(
    const UObject* WorldContextObj...,
    float InOutputVolume
)

Sets the output volume of the submix.

Public function

void

 

StartEnvelopeFollowing

(
    const UObject* WorldContextObj...
)

Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP.

Public function

void

 

StartEnvelopeFollowing

(
    FAudioDevice* InDevice
)

Public function

void

 

StartRecordingOutput

(
    const UObject* WorldContextObj...,
    float ExpectedDuration
)

Start recording the audio from this submix.

Public function

void

 

StartRecordingOutput

(
    FAudioDevice* InDevice,
    float ExpectedDuration
)

Public function

void

 

StopEnvelopeFollowing

(
    const UObject* WorldContextObj...
)

Start envelope following the submix output. Register with OnSubmixEnvelope to receive envelope follower data in BP.

Public function

void

 

StopEnvelopeFollowing

(
    FAudioDevice* InDevice
)

Public function

void

 

StopRecordingOutput

(
    const UObject* WorldContextObj...,
    EAudioRecordingExportType ExportTyp...,
    const FString& Name,
    FString Path,
    USoundWave* ExistingSoundWaveT...
)

Finish recording the audio from this submix and export it as a wav file or a USoundWave.

Public function

void

 

StopRecordingOutput

(
    FAudioDevice* InDevice,
    EAudioRecordingExportType ExportTyp...,
    const FString& Name,
    FString Path,
    USoundWave* ExistingSoundWaveT...
)

Public function

void

 

UnregisterSubmixBufferListener

(
    ISubmixBufferListener* InBuffe...
)

Overridden from UObject

Name Description

Protected function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Protected function Virtual

FString

 

GetDesc()

Return a one line description of an object for viewing in the thumbnail view of the generic browser

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Protected function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Protected function Virtual

void

 

PreEditChange

(
    UProperty* PropertyAboutToChan...
)

This is called when a property is about to be modified externally

Constants

Name

Description

SoundSubmixAudioEditor

Ptr to interface to sound class editor operations.

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