Navigation
API > API/Plugins > API/Plugins/HarmonixDsp
| Name | FVirtualInstrument |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixDsp/Public/HarmonixDsp/Instruments/VirtualInstrument.h |
| Include Path | #include "HarmonixDsp/Instruments/VirtualInstrument.h" |
Syntax
class FVirtualInstrument : public FMusicalAudioBus
Inheritance Hierarchy
- FMusicalAudioBus → FVirtualInstrument
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVirtualInstrument
(
FName InName |
HarmonixDsp/Instruments/VirtualInstrument.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FVirtualInstrument() |
HarmonixDsp/Instruments/VirtualInstrument.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| bShouldPrintMidiActivity | bool | HarmonixDsp/Instruments/VirtualInstrument.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AllNotesOff() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void AllNotesOffWithFrameOffset
(
int32 InNumFrames |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
virtual void CallPreProcessCallbacks
(
int32 NumSamples, |
Implementation of AudioBus virtual. | HarmonixDsp/Instruments/VirtualInstrument.h | |
virtual void ChannelPressure
(
int8 InData1, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void ClearPeakProcessingTime() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void ClearPeakVoiceUsage() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
virtual float GetController
(
Harmonix::Midi::Constants::EControllerID InController, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void GetController
(
Harmonix::Midi::Constants::EControllerID InController, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
virtual int32 GetMaxNumVoices () |
Get the max number of note-ons this baby can handle before auto-release. | HarmonixDsp/Instruments/VirtualInstrument.h | |
float GetMidiChannelGain
(
int8 InMidiChannel |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
bool GetMidiChannelMute
(
int8 InMidiChannel |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
float GetMidiChannelVolume
(
int8 InMidiChannel |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
FName GetName() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
int32 GetNumVoicesInUse() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
float GetPitchBend
(
int8 InMidiChannel |
Pitch bend value, on range [-1.0, 1.0] | HarmonixDsp/Instruments/VirtualInstrument.h | |
void GetProcessingTimeMs
(
double& OutCurrent, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
float GetRawPitchMultiplier() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
int32 GetRawTransposition() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
float GetSpeed
(
bool* MaintainPitch |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void GetVoiceUsage
(
int32& OutCurrent, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
virtual void HandleMidiMessage
(
FMidiVoiceId InVoiceId, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void KillAllVoices() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
bool NoteIsOn
(
int8 MidiNoteNumber, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void NoteOff
(
FMidiVoiceId InVoiceId, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void NoteOffWithFrameOffset
(
FMidiVoiceId InVoiceId, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void NoteOn
(
FMidiVoiceId InVoiceId, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void NoteOnWithFrameOffset
(
FMidiVoiceId InVoiceId, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
double PeekAtPeakProcessingTime() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
virtual void PolyPressure
(
FMidiVoiceId InVoiceId, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
virtual bool ProcessCallWillProduceSilence() |
Override this (as an optimization) if calling process may only produce zero samples | HarmonixDsp/Instruments/VirtualInstrument.h | |
void ResetInstrumentState() |
Pure virtuals that deal with instrument state and MIDI message handling... | HarmonixDsp/Instruments/VirtualInstrument.h | |
void ResetMidiState() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void Set14BitController
(
Harmonix::Midi::Constants::EControllerID InController, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void Set7BitController
(
Harmonix::Midi::Constants::EControllerID InController, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void SetController
(
Harmonix::Midi::Constants::EControllerID InController, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
virtual void SetExtraPitchBend
(
float Semitones, |
Code-driven pitch bend, in semitones | HarmonixDsp/Instruments/VirtualInstrument.h | |
void SetHighOrLowControllerByte
(
Harmonix::Midi::Constants::EControllerID InController, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void SetMidiChannelGain
(
float InGain, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void SetMidiChannelMute
(
bool InMute, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void SetMidiChannelVolume
(
float InVolume, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void SetName
(
FName InName |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void SetPitchBend
(
float InValue, |
Pitch bend value, on range [-1.0, 1.0] | HarmonixDsp/Instruments/VirtualInstrument.h | |
virtual void SetQuarterNote
(
float QuarterNote |
Update the effect with the current beat/tempo | HarmonixDsp/Instruments/VirtualInstrument.h | |
void SetRawPitchMultiplier
(
float RawPitch |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void SetRawTransposition
(
int32 SemiTones |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void SetSpeed
(
float InSpeed, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
virtual void SetTempo
(
float Bpm |
HarmonixDsp/Instruments/VirtualInstrument.h |
Overridden from FMusicalAudioBus
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetSampleRate
(
float InSampleRateHz |
HarmonixDsp/Instruments/VirtualInstrument.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ResetInstrumentStateImpl() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void ResetMidiStateImpl() |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void Set14BitControllerImpl
(
Harmonix::Midi::Constants::EControllerID InController, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
void Set7BitControllerImpl
(
Harmonix::Midi::Constants::EControllerID InController, |
HarmonixDsp/Instruments/VirtualInstrument.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static float ConvertCCValue
(
Harmonix::Midi::Constants::EControllerID InController, |
Convert a value in [0,127] to the range expected by SetController | HarmonixDsp/Instruments/VirtualInstrument.h | |
static bool GetMsbLsbIndexes
(
Harmonix::Midi::Constants::EControllerID ControllerId, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
static bool IsHighResController
(
Harmonix::Midi::Constants::EControllerID ControllerId, |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
static void SetShouldPrintMidiActivity
(
bool bInShouldPrint |
HarmonixDsp/Instruments/VirtualInstrument.h | ||
static bool ShouldPrintMidiActivity() |
HarmonixDsp/Instruments/VirtualInstrument.h |