1. Epic GamesDeveloper
  3. HarmonixMetasound

HarmonixMetasound

API > API/Plugins

   
Name HarmonixMetasound
Type Runtime
Part of Plugins Harmonix
Location /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMetasound/
Module Build Rules HarmonixMetasound.Build.cs

Classes

Name Remarks
FBarEvent  
FBeatEvent  
FFFTAnalyzerResultVertexAnalyzer  
FFusionPatchAsset  
FHarmonixMetasoundModule  
FMetronomeOperatorBase  
FMidiAsset  
FMidiChannelFilter Includes MIDI events from enabled channels only
FMidiClock  
FMidiClockVertexAnalyzer  
FMidiNoteFilter Filters MIDI note events based on note number and velocity
FMidiPulseGenerator  
FMidiSongPosVertexAnalyzer  
FMidiStepSequenceAsset  
FMidiStream  
FMidiStreamVertexAnalyzer  
FMidiStreamWriter Write the midi events from a midi stream into a midi file
FMidiTrackFilter Filters MIDI events based on which track they're on
FMusicClockConnected  
FMusicClockDisconnected  
FMusicClockDriverBase  
FMusicTimeDiscontinuityEvent  
FMusicTransportControllable  
FMusicTransportEventStreamVertexAnalyzer  
FPeakTamer Takes a raw peak value from an audio analyzer and outputs a smoothed, compressed value in range [0, 1]
FPlayStateEvent  
FPulseGenerator  
FSectionEvent  
FSimpleSamplerNodeOperatorData  
FSpmcAnalysisResultQueue  
FStuckNoteGuard Tracks incoming note messages and sends note offs when a note would become "stuck" because of a filter change
FStutterSequenceAsset  
FTapeSSNodeOperatorData  
UHarmonixMetasoundMusicAsset UHarmonixMetasoundMusicAsset: In this case, the music asset is comprised of a MetaSound that uses the Harmonix MetaSound nodes to generate musical time, and a midi file which maps the tempo and time signatures that define the music's form.
UHarmonixMusicAsset UHarmonixMusicAsset An implementation of the pure virtual IMusicalAsset interface that will act as a base class for UHarmonixMetasoundMusicAsset and UHarmonixWaveMusicAsset.
UHarmonixMusicHandle UHarmonixMusicHandle
UHarmonixPeakTamer Takes a raw peak value from an audio analyzer and outputs a smoothed, compressed value in range [0, 1]
UHarmonixWaveMusicAsset  
UMetasoundOfflinePlayerComponent  
UMidiClockUpdateSubsystem Handles updating low-resolution play cursors associated with a MIDI clock.
UMidiEventInfoBlueprintLibrary  
UMusicClockComponent  
UMusicParameterBlueprintLibrary  
UMusicTempometerComponent UMusicTempometerComponent provides playback properties of a UMusicClockComponent on its actor and optionally updates a UMaterialParameterCollection.
UMusicTimestampBlueprintLibrary  
UTimeSignatureBlueprintLibrary  

Structs

Name Remarks
FAdvance  
FHarmonixPeakTamerSettings  
FHarmonixSimpleSamplerNodeConfiguration  
FHarmonixTapeSSNodeConfiguration  
FLoop  
FMetasoundMusicClockSettings  
FMidiClockEvent  
FMidiClockSongPosition  
FMidiEventInfo  
FMidiStreamEvent  
FMusicClockSettingsBase  
FMusicLoopConfiguration  
FMusicSeekRequest  
FMusicSeekTarget  
FMusicTempometerMPCParameterNames  
FMusicTempometerMPCParameters Parameters used when creating/updating the corresponding Material Parameter Collection
FMusicTimeInterval  
FMusicTransportEvent  
FSeek  
FSettings  
FSongMapChain  
FSpeedChange  
FStepSequenceCell First, the USTRUCT(s) that make up the user facing data for this asset...
FStepSequenceNote  
FStepSequencePage  
FStepSequenceRow  
FStepSequenceTable  
FStutterSequenceEntry  
FStutterSequenceTable  
FTempoChange  
FTimeSignatureChange  
FTransportChange  
FWallClockMusicClockSettings  

Typedefs

Name Type Remarks Include Path
FConstSharedMidiClockPtr TSharedPtr< const FMidiClock, ESPMode::NotThreadSafe >   HarmonixMetasound/DataTypes/MidiClock.h
FMidiClockEvents TArray< FMidiClockEvent >   HarmonixMetasound/DataTypes/MidiClock.h
FMidiClockMsg TVariant< MidiClockMessageTypes::FLoop, MidiClockMessageTypes::FSeek, MidiClockMessageTypes::FAdvance, MidiClockMessageTypes::FTempoChange, MidiClockMessageTypes::FTimeSignatureChange, MidiClockMessageTypes::FTransportChange, MidiClockMessageTypes::FSpeedChange >   HarmonixMetasound/DataTypes/MidiClockEvent.h
FMidiTrackIndex uint16   HarmonixMetasound/MidiOps/MidiOps.h
FStepSequenceTableProxy Harmonix::TAudioRenderableProxy< FStepSequenceTable, Harmonix::TGameThreadToAudioRenderThreadSettingQueue< FStepSequenceTable > >   HarmonixMetasound/DataTypes/MidiStepSequence.h
FStutterSequenceTableProxy Harmonix::TAudioRenderableProxy< FStutterSequenceTable, Harmonix::TGameThreadToAudioRenderThreadSettingQueue< FStutterSequenceTable > >   HarmonixMetasound/DataTypes/MidiStutterSequence.h

Enums

Public

Name Remarks
EMusicClockDriveMethod  
EMusicClockState  
EMusicTimeDiscontinuityType  
ESeekPointType  
EStdMidiControllerID Standard Midi Controller ID according to the MIDI Association reference: https://www.midi.org/specifications-old/item/table-3-control-change-messages-data-bytes-2
HarmonixMetasound::EMusicPlayerTransportRequest Copyright Epic Games, Inc. All Rights Reserved.
MidiClockUpdateSubsystem::EUpdateMethod TODO: Cleanup task - UE-205069 - Settle on one of these methods while testing Fortnite and then delete this enum, the int32, and the CVar as they will no longer need to be switchable.

Constants

Name Type Remarks Include Path
HarmonixMetasound::Nodes::MidiPlayerNode::kMaxClockSpeed float   HarmonixMetasound/Nodes/MidiPlayerNode.h
HarmonixMetasound::Nodes::MidiPlayerNode::kMinClockSpeed float   HarmonixMetasound/Nodes/MidiPlayerNode.h
HarmonixMetasound::SimpleSamplerNode::kMaxChannels int32   HarmonixMetasound/Nodes/SimpleSamplerNode.h
HarmonixMetasound::SimpleSamplerNode::kNumFadeFrames int32   HarmonixMetasound/Nodes/SimpleSamplerNode.h
HarmonixMetasound::TapeSSNode::kMaxChannels int32   HarmonixMetasound/Nodes/TapeSSNode.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AllChannelsOff uint16   HarmonixMetasound/MidiOps/MidiOps.h  
AllChannelsOn uint16   HarmonixMetasound/MidiOps/MidiOps.h  
AudibleDurationDisplayName const FText   HarmonixMetasound/Nodes/StutterControllerNode.h  
AudibleDurationName const TCHAR *   HarmonixMetasound/Nodes/StutterControllerNode.h  
AudibleDurationTooltip const FText   HarmonixMetasound/Nodes/StutterControllerNode.h  
CaptureDurationDisplayName const FText   HarmonixMetasound/Nodes/StutterControllerNode.h  
CaptureDurationName const TCHAR *   HarmonixMetasound/Nodes/StutterControllerNode.h  
CaptureDurationTooltip const FText   HarmonixMetasound/Nodes/StutterControllerNode.h  
FMusicSeekTargetReadRef     HarmonixMetasound/DataTypes/MusicSeekRequest.h  
FMusicSeekTargetTypeInfo     HarmonixMetasound/DataTypes/MusicSeekRequest.h  
HARMONIXMETASOUND_API     HarmonixMetasound/DataTypes/MusicSeekRequest.h  
kMaxTempoBpm float   HarmonixMetasound/Nodes/MetronomeNode.h  
kMaxTimeSigDenominator int32   HarmonixMetasound/Nodes/MetronomeNode.h  
kMaxTimeSigNumerator int32   HarmonixMetasound/Nodes/MetronomeNode.h  
kMinTempoBpm float   HarmonixMetasound/Nodes/MetronomeNode.h  
kMinTimeSigDenominator int32   HarmonixMetasound/Nodes/MetronomeNode.h  
kMinTimeSigNumerator int32   HarmonixMetasound/Nodes/MetronomeNode.h  
MaxDelayTime float   HarmonixMetasound/Nodes/DelayNode.h  
MusicTimestampDisplayName const FText   HarmonixMetasound/Nodes/MusicSeekTargetBuilder.h  
MusicTimestampName const TCHAR *   HarmonixMetasound/Nodes/MusicSeekTargetBuilder.h  
MusicTimestampTooltip const FText   HarmonixMetasound/Nodes/MusicSeekTargetBuilder.h  
NumChannels int32   HarmonixMetasound/Nodes/DelayNode.h  
ReverseDisplayName const FText   HarmonixMetasound/Nodes/StutterControllerNode.h  
ReverseName const TCHAR *   HarmonixMetasound/Nodes/StutterControllerNode.h  
ReverseTooltip const FText   HarmonixMetasound/Nodes/StutterControllerNode.h  
SeekTargetDisplayName const FText &   HarmonixMetasound/Nodes/MusicSeekTargetBuilder.h  
SeekTargetName const TCHAR *   HarmonixMetasound/Nodes/MusicSeekTargetBuilder.h  
SeekTargetTooltip const FText &   HarmonixMetasound/Nodes/MusicSeekTargetBuilder.h  
SpacingDisplayName const FText   HarmonixMetasound/Nodes/StutterControllerNode.h  
SpacingName const TCHAR *   HarmonixMetasound/Nodes/StutterControllerNode.h  
SpacingTooltip const FText   HarmonixMetasound/Nodes/StutterControllerNode.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

DECLARE_METASOUND_DATA_REFERENCE_TYPES ( FMidiEventInfo,
FMidiEventInfoTypeInfo,
FMidiEventInfoReadRef,
FMidiEventInfoWriteRef
)

   HarmonixMetasound/DataTypes/MidiEventInfo.h  

DECLARE_METASOUND_DATA_REFERENCE_TYPES ( FHarmonixFFTAnalyzerResults,
HARMONIXMETASOUND_API,
FHarmonixFFTAnalyzerResultsTypeInfo,
FHarmonixFFTAnalyzerResultsReadRef,
FHarmonixFFTAnalyzerResultsWriteRef
)

   HarmonixMetasound/DataTypes/FFTAnalyzerResult.h  

DECLARE_METASOUND_DATA_REFERENCE_TYPES ( FMusicSeekRequest,
HARMONIXMETASOUND_API,
FMusicSeekRequestTypeInfo,
FMusicSeekRequestReadRef,
FMusicSeekRequestWriteRef
)

 NOTE: Since there is no corresponding cpp file, the corresponding REGISTER_METASOUND_DATATYPE is in MidiClock.cpp. HarmonixMetasound/DataTypes/MusicSeekRequest.h  

DECLARE_METASOUND_DATA_REFERENCE_TYPES ( FTimeSignature,
HARMONIXMETASOUND_API,
FTimeSignatureTypeInfo,
FTimeSignatureReadRef,
FTimeSignatureWriteRef
)

   HarmonixMetasound/DataTypes/TimeSignature.h  

HarmonixMetasound::Analysis::DECLARE_METASOUND_DATA_REFERENCE_ALIAS_TYPES ( FMidiClockSongPosition,
FMidiClockSongPositionTypeInfo,
FMidiClockSongPositionReadRef,
FMidiClockSongPositionWriteRef
)

 Declare aliases IN the namespace... HarmonixMetasound/Analysis/MidiClockSongPos.h  

HarmonixMetasound::DECLARE_METASOUND_DATA_REFERENCE_ALIAS_TYPES ( FMidiClock,
FMidiClockTypeInfo,
FMidiClockReadRef,
FMidiClockWriteRef
)

 Declare aliases IN the namespace... HarmonixMetasound/DataTypes/MidiClock.h  

HarmonixMetasound::DECLARE_METASOUND_DATA_REFERENCE_ALIAS_TYPES ( FMusicTransportEvent,
FMusicTransportEventTypeInfo,
FMusicTransportEventReadRef,
FMusicTransportEventWriteRef
)

 Declare aliases IN the namespace... HarmonixMetasound/DataTypes/MusicTransport.h  

DECLARE_METASOUND_DATA_REFERENCE_ALIAS_TYPES(FMusicTransportEventStream, FMusicTransportEventStreamTypeInfo, FMusicTransportEventStreamReadRef, FMusicTransportEventStreamWriteRef) enum class EMusicPlayerTransportState FString HarmonixMetasound::MusicPlayerTransportStateToString ( EMusicPlayerTransportState State
)

 Declare aliases IN the namespace... HarmonixMetasound/DataTypes/MusicTransport.h  

const Metasound::FNodeClassName & HarmonixMetasound::Nodes::MorphingLFO::GetClassName()

   HarmonixMetasound/Nodes/MorphingLfoNode.h  

const Metasound::FNodeClassName & HarmonixMetasound::Nodes::MusicTimeStampToSeekTarget::GetClassName()

   HarmonixMetasound/Nodes/MusicSeekTargetBuilder.h  

int32 HarmonixMetasound::Nodes::MusicTimeStampToSeekTarget::GetCurrentMajorVersion()

   HarmonixMetasound/Nodes/MusicSeekTargetBuilder.h  

void MusicTempometerUtilities::UpdateMaterialParameterCollectionFromClock ( const UObject* InWorldContextObject,
TWeakObjectPtr< UMaterialParameterCollectionInstance >& InOutMaterialParameterCollectionInstance,
const TObjectPtr< UMaterialParameterCollection >& InMaterialParameterCollection,
const FMusicTempometerMPCParameters& InMCPParameters,
const UMusicClockComponent* InClockComponent
)

 Update the supplied material parameter collection instance (create if null) with song position data extracted from the supplied clock HarmonixMetasound/Utils/MusicTempometerUtilities.h  

FMidiSongPos MusicTempometerUtilities::UpdateMaterialParameterCollectionFromClock ( const UMusicClockComponent* InClockComponent,
const FMidiSongPos& InPreviousFrameMidiSongPos,
const UMaterialParameterCollection* InMaterialParameterCollection,
const FMusicTempometerMPCParameters& InMPCParameters,
TWeakObjectPtr< UMaterialParameterCollectionInstance >& InOutMaterialParameterCollectionInstance
)

 Update the supplied material parameter collection instance (create from the supplied material parameter collection if null) from the supplied clock and song position, and return the current song position according to the supplied clock. HarmonixMetasound/Utils/MusicTempometerUtilities.h  

void MusicTempometerUtilities::UpdateMaterialParameterCollectionFromSongPos ( const UObject* InWorldContextObject,
TWeakObjectPtr< UMaterialParameterCollectionInstance >& InOutMaterialParameterCollectionInstance,
const TObjectPtr< UMaterialParameterCollection >& InMaterialParameterCollection,
const FMusicTempometerMPCParameters& InMCPParameters,
const FMidiSongPos& InMidiSongPos
)

 Update the supplied material parameter collection instance (create if null) with data from the supplied song position HarmonixMetasound/Utils/MusicTempometerUtilities.h  

void MusicTempometerUtilities::UpdateMaterialParameterCollectionFromSongPos ( const UObject* InWorldContextObject,
const FMidiSongPos& InCurrentFrameMidiSongPos,
const FMidiSongPos& InPreviousFrameMidiSongPos,
const UMaterialParameterCollection* InMaterialParameterCollection,
const FMusicTempometerMPCParameters& InMPCParameters,
TWeakObjectPtr< UMaterialParameterCollectionInstance >& InOutMaterialParameterCollectionInstance
)

 Update the supplied material parameter collection instance (create from the supplied material parameter collection if null) from the supplied song positions. HarmonixMetasound/Utils/MusicTempometerUtilities.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page