USynthSound

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

AudioMixer

Header

/Engine/Source/Runtime/AudioMixer/Public/Components/SynthComponent.h

Include

#include "Components/SynthComponent.h"

Syntax

class USynthSound : public USoundWaveProcedural

Variables

Name Description

Protected variable

bool

 

bAudioMixer

Protected variable

TArray < float >

 

FloatBuffer

Protected variable

USynthComponent ...

 

OwningSynthComponent

End USoundWave

Constructors

Name Description

Public function

USynthSound

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function

USynthCompon ...

 

GetOwningSynthComponent()

Public function

void

 

Init

(
    USynthComponent * InSynthCompon...,
    const int32 InNumChannels,
    const int32 SampleRate,
    const int32 InCallbackSize
)

Public function

void

 

StartOnAudioDevice

(
    FAudioDevice * InAudioDevice
)

Overridden from USoundWaveProcedural

Name Description

Public function Virtual

int32

 

OnGeneratePCMAudio

(
    TArray < uint8 >& OutAudio,
    int32 NumSamples
)

Virtual function to generate PCM audio from the audio render thread.

Overridden from USoundWave

Name Description

Public function Virtual Const

Audio::EAudi ...

 

GetGeneratedPCMDataFormat()

Return the format of the generated PCM data type.

Public function Virtual

void

 

OnBeginGenerate()

Begin USoundWave

Public function Virtual

void

 

OnEndGenerate()

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

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