Navigation
API > API/Runtime > API/Runtime/SignalProcessing
Oscillator base class.
| Name | IOscBase |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/Osc.h |
| Include Path | #include "DSP/Osc.h" |
Syntax
class IOscBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IOscBase () |
DSP/Osc.h | ||
| DSP/Osc.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IOscBase() |
DSP/Osc.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float Generate
(
float* AuxOutput |
Generates the next sample of audio, optionally passes out the auxillary output (supported in some oscillators) | DSP/Osc.h | |
float GetFrequency() |
Returns the frequency of the oscillator. | DSP/Osc.h | |
float GetGain() |
Returns the frequency of the oscillator. | DSP/Osc.h | |
FPatchDestination GetModDestAdd() |
DSP/Osc.h | ||
FPatchDestination GetModDestFrequency() |
Return patch destinations for various modulatable parameters. | DSP/Osc.h | |
FPatchDestination GetModDestGain() |
DSP/Osc.h | ||
FPatchDestination GetModDestPulseWidth() |
DSP/Osc.h | ||
FPatchDestination GetModDestScale() |
DSP/Osc.h | ||
virtual void Init
(
const float InSampleRate, |
Initializes the oscillator. | DSP/Osc.h | |
bool IsPlaying() |
Returns whether or not this oscillator is playing. | DSP/Osc.h | |
bool IsSync() |
Returns if this oscillator should be synced to a leader oscillator. | DSP/Osc.h | |
virtual void Reset() |
Resets the oscillator. | DSP/Osc.h | |
virtual void ResetPhase() |
Resets the phase of this oscillator to 0.0f. | DSP/Osc.h | |
void SetCents
(
const float InCents |
DSP/Osc.h | ||
void SetDetune
(
const float InDetune |
DSP/Osc.h | ||
void SetFollowerOsc
(
IOscBase* InFollowerOsc |
Sets the input oscillator as the follower of this oscillator. | DSP/Osc.h | |
void SetFreqScale
(
const float InFreqScale |
DSP/Osc.h | ||
void SetFrequency
(
const float InFreqBase |
Sets the base frequency of the oscillator. | DSP/Osc.h | |
void SetFrequencyMod
(
const float InFreqMod |
Sets a frequency modulation value. | DSP/Osc.h | |
void SetGain
(
const float InGain |
Sets the gain of the oscillator. | DSP/Osc.h | |
void SetGainMod
(
const float InGainMod |
Sets the gain modulator of the oscillator. | DSP/Osc.h | |
void SetNote
(
const float InNote |
Sets the base frequency of the oscillator from the midi note number. | DSP/Osc.h | |
void SetOctave
(
const float InOctave |
DSP/Osc.h | ||
void SetPitchBend
(
const float InPitchBend |
DSP/Osc.h | ||
void SetPulseWidth
(
const float InPulseWidth |
Sets the LFO pulse width for square-wave type oscillators. | DSP/Osc.h | |
void SetSampleRate
(
const float InSampleRate |
DSP/Osc.h | ||
void SetSemitones
(
const float InSemiTone |
DSP/Osc.h | ||
void SetSlaveOsc
(
IOscBase* InSlaveOsc |
Deprecated: use SetFollowerOsc | DSP/Osc.h | |
void SetSync
(
const bool bInSync |
Sets whether or not this oscillator should be synced to a leader oscillator. leader oscillator needs to have set this oscillator as its follower. | DSP/Osc.h | |
void Start() |
Starts the oscillator. | DSP/Osc.h | |
void Stop() |
Stops the oscillator. | DSP/Osc.h | |
virtual void Update() |
Updates oscillator state. | DSP/Osc.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetPhase() |
Returns the current phase of the oscillator. | DSP/Osc.h | |
float GetQuadPhase() |
Returns the quadrature phase, wrapped. | DSP/Osc.h | |
void UpdatePhase() |
Updates the phase based on the phase increment. | DSP/Osc.h | |
bool WrapPhase() |
Returns true if there was a phase wrap this update. | DSP/Osc.h |