UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::IOscBase Class Referenceabstract

#include <Osc.h>

+ Inheritance diagram for Audio::IOscBase:

Public Member Functions

SIGNALPROCESSING_API IOscBase ()
 
SIGNALPROCESSING_API IOscBase (const IOscBase &)
 
virtual SIGNALPROCESSING_API ~IOscBase ()
 
virtual SIGNALPROCESSING_API void Init (const float InSampleRate, const int32 InVoiceId=0, FModulationMatrix *InMatrix=nullptr, const int32 ModMatrixStage=1)
 
virtual void Start ()=0
 
virtual void Stop ()=0
 
virtual float Generate (float *AuxOutput=nullptr)=0
 
virtual SIGNALPROCESSING_API void Update ()
 
virtual SIGNALPROCESSING_API void Reset ()
 
virtual SIGNALPROCESSING_API void ResetPhase ()
 
void SetGain (const float InGain)
 
void SetGainMod (const float InGainMod)
 
SIGNALPROCESSING_API void SetFrequency (const float InFreqBase)
 
SIGNALPROCESSING_API void SetFrequencyMod (const float InFreqMod)
 
SIGNALPROCESSING_API void SetNote (const float InNote)
 
float GetFrequency () const
 
float GetGain () const
 
SIGNALPROCESSING_API void SetCents (const float InCents)
 
SIGNALPROCESSING_API void SetOctave (const float InOctave)
 
SIGNALPROCESSING_API void SetSampleRate (const float InSampleRate)
 
SIGNALPROCESSING_API void SetSemitones (const float InSemiTone)
 
SIGNALPROCESSING_API void SetDetune (const float InDetune)
 
SIGNALPROCESSING_API void SetPitchBend (const float InPitchBend)
 
SIGNALPROCESSING_API void SetFreqScale (const float InFreqScale)
 
SIGNALPROCESSING_API void SetPulseWidth (const float InPulseWidth)
 
bool IsPlaying () const
 
bool IsSync () const
 
void SetSync (const bool bInSync)
 
SIGNALPROCESSING_API void SetSlaveOsc (IOscBase *InSlaveOsc)
 
SIGNALPROCESSING_API void SetFollowerOsc (IOscBase *InFollowerOsc)
 
FPatchDestination GetModDestFrequency () const
 
FPatchDestination GetModDestPulseWidth () const
 
FPatchDestination GetModDestGain () const
 
FPatchDestination GetModDestAdd () const
 
FPatchDestination GetModDestScale () const
 

Protected Member Functions

void UpdatePhase ()
 
bool WrapPhase ()
 
float GetPhase () const
 
float GetQuadPhase () const
 

Protected Attributes

int32 VoiceId
 
float SampleRate
 
float Nyquist
 
float Freq
 
float BaseFreq
 
FOscFrequencyMod FreqData
 
float Gain
 
float ExternalGainMod
 
float Phase
 
float PhaseInc
 
float PulseWidthBase
 
float PulseWidthMod
 
float PulseWidth
 
FModulationMatrixModMatrix
 
FPatchDestination ModFrequencyDest
 
FPatchDestination ModPulseWidthDest
 
FPatchDestination ModGainDest
 
FPatchDestination ModScaleDest
 
FPatchDestination ModAddDest
 
IOscBaseFollowerOsc
 
bool bIsPlaying
 
bool bChanged
 
bool bIsSync
 

Constructor & Destructor Documentation

◆ IOscBase() [1/2]

Audio::IOscBase::IOscBase ( )

◆ IOscBase() [2/2]

Audio::IOscBase::IOscBase ( const IOscBase )
default

◆ ~IOscBase()

Audio::IOscBase::~IOscBase ( )
virtualdefault

Member Function Documentation

◆ Generate()

virtual float Audio::IOscBase::Generate ( float AuxOutput = nullptr)
pure virtual

Implemented in Audio::FOsc, and Audio::FLFO.

◆ GetFrequency()

float Audio::IOscBase::GetFrequency ( ) const
inline

◆ GetGain()

float Audio::IOscBase::GetGain ( ) const
inline

◆ GetModDestAdd()

FPatchDestination Audio::IOscBase::GetModDestAdd ( ) const
inline

◆ GetModDestFrequency()

FPatchDestination Audio::IOscBase::GetModDestFrequency ( ) const
inline

◆ GetModDestGain()

FPatchDestination Audio::IOscBase::GetModDestGain ( ) const
inline

◆ GetModDestPulseWidth()

FPatchDestination Audio::IOscBase::GetModDestPulseWidth ( ) const
inline

◆ GetModDestScale()

FPatchDestination Audio::IOscBase::GetModDestScale ( ) const
inline

◆ GetPhase()

float Audio::IOscBase::GetPhase ( ) const
inlineprotected

◆ GetQuadPhase()

float Audio::IOscBase::GetQuadPhase ( ) const
inlineprotected

◆ Init()

void Audio::IOscBase::Init ( const float  InSampleRate,
const int32  InVoiceId = 0,
FModulationMatrix InMatrix = nullptr,
const int32  ModMatrixStage = 1 
)
virtual

Reimplemented in Audio::FLFO.

◆ IsPlaying()

bool Audio::IOscBase::IsPlaying ( ) const
inline

◆ IsSync()

bool Audio::IOscBase::IsSync ( ) const
inline

◆ Reset()

void Audio::IOscBase::Reset ( )
virtual

Reimplemented in Audio::FLFO, and Audio::FOsc.

◆ ResetPhase()

void Audio::IOscBase::ResetPhase ( )
virtual

Reimplemented in Audio::FLFO.

◆ SetCents()

void Audio::IOscBase::SetCents ( const float  InCents)

◆ SetDetune()

void Audio::IOscBase::SetDetune ( const float  InDetune)

◆ SetFollowerOsc()

void Audio::IOscBase::SetFollowerOsc ( IOscBase InFollowerOsc)

◆ SetFreqScale()

void Audio::IOscBase::SetFreqScale ( const float  InFreqScale)

◆ SetFrequency()

void Audio::IOscBase::SetFrequency ( const float  InFreqBase)

◆ SetFrequencyMod()

void Audio::IOscBase::SetFrequencyMod ( const float  InFreqMod)

◆ SetGain()

void Audio::IOscBase::SetGain ( const float  InGain)
inline

◆ SetGainMod()

void Audio::IOscBase::SetGainMod ( const float  InGainMod)
inline

◆ SetNote()

void Audio::IOscBase::SetNote ( const float  InNote)

◆ SetOctave()

void Audio::IOscBase::SetOctave ( const float  InOctave)

◆ SetPitchBend()

void Audio::IOscBase::SetPitchBend ( const float  InPitchBend)

◆ SetPulseWidth()

void Audio::IOscBase::SetPulseWidth ( const float  InPulseWidth)

◆ SetSampleRate()

void Audio::IOscBase::SetSampleRate ( const float  InSampleRate)

◆ SetSemitones()

void Audio::IOscBase::SetSemitones ( const float  InSemiTone)

◆ SetSlaveOsc()

void Audio::IOscBase::SetSlaveOsc ( IOscBase InSlaveOsc)

◆ SetSync()

void Audio::IOscBase::SetSync ( const bool  bInSync)
inline

◆ Start()

virtual void Audio::IOscBase::Start ( )
pure virtual

Implemented in Audio::FLFO, and Audio::FOsc.

◆ Stop()

virtual void Audio::IOscBase::Stop ( )
pure virtual

Implemented in Audio::FLFO, and Audio::FOsc.

◆ Update()

void Audio::IOscBase::Update ( )
virtual

Reimplemented in Audio::FOsc.

◆ UpdatePhase()

void Audio::IOscBase::UpdatePhase ( )
inlineprotected

◆ WrapPhase()

bool Audio::IOscBase::WrapPhase ( )
inlineprotected

Member Data Documentation

◆ BaseFreq

float Audio::IOscBase::BaseFreq
protected

◆ bChanged

bool Audio::IOscBase::bChanged
protected

◆ bIsPlaying

bool Audio::IOscBase::bIsPlaying
protected

◆ bIsSync

bool Audio::IOscBase::bIsSync
protected

◆ ExternalGainMod

float Audio::IOscBase::ExternalGainMod
protected

◆ FollowerOsc

IOscBase* Audio::IOscBase::FollowerOsc
protected

◆ Freq

float Audio::IOscBase::Freq
protected

◆ FreqData

FOscFrequencyMod Audio::IOscBase::FreqData
protected

◆ Gain

float Audio::IOscBase::Gain
protected

◆ ModAddDest

FPatchDestination Audio::IOscBase::ModAddDest
protected

◆ ModFrequencyDest

FPatchDestination Audio::IOscBase::ModFrequencyDest
protected

◆ ModGainDest

FPatchDestination Audio::IOscBase::ModGainDest
protected

◆ ModMatrix

FModulationMatrix* Audio::IOscBase::ModMatrix
protected

◆ ModPulseWidthDest

FPatchDestination Audio::IOscBase::ModPulseWidthDest
protected

◆ ModScaleDest

FPatchDestination Audio::IOscBase::ModScaleDest
protected

◆ Nyquist

float Audio::IOscBase::Nyquist
protected

◆ Phase

float Audio::IOscBase::Phase
protected

◆ PhaseInc

float Audio::IOscBase::PhaseInc
protected

◆ PulseWidth

float Audio::IOscBase::PulseWidth
protected

◆ PulseWidthBase

float Audio::IOscBase::PulseWidthBase
protected

◆ PulseWidthMod

float Audio::IOscBase::PulseWidthMod
protected

◆ SampleRate

float Audio::IOscBase::SampleRate
protected

◆ VoiceId

int32 Audio::IOscBase::VoiceId
protected

The documentation for this class was generated from the following files: