Navigation
API > API/Plugins > API/Plugins/HarmonixMidi
An FMidFile is primarily a container for FMidiTracks.
This class can handle loading and saving standard midi files, as well as serializing itself to standard Unreal Engine FArchives.
| Name | UMidiFile |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMidi/Public/HarmonixMidi/MidiFile.h |
| Include Path | #include "HarmonixMidi/MidiFile.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Category="Music", Meta=(DisplayName="Standard MIDI File"))
class UMidiFile :
public UObject ,
public IAudioProxyDataFactory ,
public IMusicMapSource
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMidiFile
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMidiFile() |
HarmonixMidi/MidiFile.h |
Enums
Public
| Name | Remarks |
|---|---|
| ELoadResult |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FMidiTrackList | TArray< FMidiTrack > | HarmonixMidi/MidiFile.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AssetImportData | TObjectPtr< UAssetImportData > | Import data for this MidiFileAsset updated during Import in MidiFile | HarmonixMidi/MidiFile.h |
|
| StartBar | int32 | The Start Bar of a Midi File. | HarmonixMidi/MidiFile.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMidiTrack * AddTrack
(
const FString& Name |
HarmonixMidi/MidiFile.h | ||
void BuildConductorTrack() |
HarmonixMidi/MidiFile.h | ||
bool ConformToLength
(
int32 NewLengthTicks |
HarmonixMidi/MidiFile.h | ||
bool ConformToLengthGivenLastEventTick
(
int32 NewLastEventTick |
HarmonixMidi/MidiFile.h | ||
void Empty() |
HarmonixMidi/MidiFile.h | ||
void FindAllTextEvents
(
const FString& EventText, |
HarmonixMidi/MidiFile.h | ||
TArray< int32 > FindAllTextEvents
(
const FString& EventText, |
Find all the ticks at which the text event occurs. | HarmonixMidi/MidiFile.h | |
int32 FindTextEvent
(
const FString& EventText, |
Find the text event and return the tick or -1 if not found. | HarmonixMidi/MidiFile.h | |
int32 FindTextEvent
(
const FString& EventText, |
Find the text event and return the tick or -1 if not found. | HarmonixMidi/MidiFile.h | |
const FMidiTrack * FindTrackByName
(
const FString& TrackName |
HarmonixMidi/MidiFile.h | ||
int32 FindTrackIndexByName
(
const FString& TrackName |
HarmonixMidi/MidiFile.h | ||
FString GetImportedSrcFilePath() |
HarmonixMidi/MidiFile.h | ||
int32 GetLastEventTick() |
HarmonixMidi/MidiFile.h | ||
int32 GetNumTracks() |
HarmonixMidi/MidiFile.h | ||
TSharedPtr< FMidiFileData > GetOrCreateRenderableCopy() |
HarmonixMidi/MidiFile.h | ||
FSongMaps * GetSongMaps () |
HarmonixMidi/MidiFile.h | ||
const FSongMaps * GetSongMaps () |
HarmonixMidi/MidiFile.h | ||
int32 GetStartBar() |
HarmonixMidi/MidiFile.h | ||
FMidiTrack * GetTrack
(
int32 Index |
HarmonixMidi/MidiFile.h | ||
const FMidiTrack * GetTrack
(
int32 Index |
HarmonixMidi/MidiFile.h | ||
const FMidiTrackList & GetTracks () |
HarmonixMidi/MidiFile.h | ||
FMidiTrackList & GetTracks () |
HarmonixMidi/MidiFile.h | ||
bool IsEmpty() |
HarmonixMidi/MidiFile.h | ||
bool LengthIsAPerfectSubdivision () |
This does a quick and dirty to check to see if the length of the midi is on a musical subdivision. | HarmonixMidi/MidiFile.h | |
ELoadResult LoadStdMidiFile
(
void* Buffer, |
A method for importing a standard midi file, with the option of providing a pointer to an FSongMaps instance that will be populated during the load. | HarmonixMidi/MidiFile.h | |
ELoadResult LoadStdMidiFile
(
TSharedPtr< FArchive > Archive, |
A method for importing a standard midi file, with the option of providing a pointer to an FSongMaps instance that will be populated during the load. | HarmonixMidi/MidiFile.h | |
ELoadResult LoadStdMidiFile
(
const FString& FilePath, |
A method for importing a standard midi file, with the option of providing a pointer to an FSongMaps instance that will be populated during the load. | HarmonixMidi/MidiFile.h | |
void QuantizeLengthToNearestPerfectSubdivision
(
const EMidiFileQuantizeDirection Direction |
HarmonixMidi/MidiFile.h | ||
void QuantizeLengthToSubdivision
(
const EMidiFileQuantizeDirection Direction, |
HarmonixMidi/MidiFile.h | ||
void SaveStdMidiFile
(
const FString& FilePath |
A method for exporting the midi track data to a standard midi file. | HarmonixMidi/MidiFile.h | |
void SaveStdMidiFile
(
TSharedPtr< FArchive > Archive, |
A method for exporting the midi track data to a standard midi file. | HarmonixMidi/MidiFile.h | |
void ScanTracksForSongLengthChange () |
This function must be called if any changes are made to any of the tracks of this midi file. | HarmonixMidi/MidiFile.h | |
void SortAllTracks() |
HarmonixMidi/MidiFile.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
UObject. | HarmonixMidi/MidiFile.h | |
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
HarmonixMidi/MidiFile.h | ||
virtual EDataValidationResult IsDataValid
(
FDataValidationContext& Context |
HarmonixMidi/MidiFile.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
StartBar UPROPERTY callback. | HarmonixMidi/MidiFile.h | |
virtual void PostInitProperties() |
HarmonixMidi/MidiFile.h |
Overridden from IAudioProxyDataFactory
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< Audio::IProxyData > CreateProxyData
(
const Audio::FProxyDataInitParams& InitParams |
IAudioProxyDataFactory. | HarmonixMidi/MidiFile.h |
Overridden from IMusicMapSource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CreateFrameBasedMusicMap
(
UFrameBasedMusicMap* Map |
HarmonixMidi/MidiFile.h | ||
virtual FMarkerProviderResults GatherMarkers
(
const UFrameBasedMusicMap* Map |
HarmonixMidi/MidiFile.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const UMidiFile& Other |
A comparison operator. | HarmonixMidi/MidiFile.h |