Navigation
API > API/Plugins > API/Plugins/HarmonixMidi
A concrete IMidiReader implementation that can read standard midi files.
You rarely have to interact with this class, as FMidiFile uses it internally when you use its LoadStdMidiFile functions.
| Name | FStdMidiFileReader |
| Type | class |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMidi/Public/HarmonixMidi/MidiReader.h |
| Include Path | #include "HarmonixMidi/MidiReader.h" |
Syntax
class FStdMidiFileReader : public IMidiReader
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStdMidiFileReader
(
const FString& FilePath, |
HarmonixMidi/MidiReader.h | ||
FStdMidiFileReader
(
TSharedPtr< FArchive > Archive, |
HarmonixMidi/MidiReader.h | ||
FStdMidiFileReader
(
void* Buffer, |
HarmonixMidi/MidiReader.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FStdMidiFileReader() |
HarmonixMidi/MidiReader.h |
Structs
| Name | Remarks |
|---|---|
| FRawMidiMsg | Stuff for sorting Midi messages on the same tick |
| RawMidiLess |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FRawMidiList | TArray< FRawMidiMsg > | HarmonixMidi/MidiReader.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| kMaxSupportedMidiStringSize | int32 | HarmonixMidi/MidiReader.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Archive | TSharedRef< FArchive > | HarmonixMidi/MidiReader.h | ||
| BarMap | TSharedPtr< FBarMap > | We'll keep track of our own bar map so we can display more meaningful error/warning messages | HarmonixMidi/MidiReader.h | |
| CurrentFileTick | int32 | HarmonixMidi/MidiReader.h | ||
| CurrentTick | int32 | HarmonixMidi/MidiReader.h | ||
| CurrentTrackIndex | int32 | HarmonixMidi/MidiReader.h | ||
| CurrentTrackName | FString | HarmonixMidi/MidiReader.h | ||
| DestinationTicksPerQuarterNote | int32 | HarmonixMidi/MidiReader.h | ||
| EventsOnSameTick | FRawMidiList | HarmonixMidi/MidiReader.h | ||
| Filename | FString | HarmonixMidi/MidiReader.h | ||
| Format | int16 | HarmonixMidi/MidiReader.h | ||
| LastTick | int32 | HarmonixMidi/MidiReader.h | ||
| LastTracksFilePosition | int64 | HarmonixMidi/MidiReader.h | ||
| MidiListTick | int32 | HarmonixMidi/MidiReader.h | ||
| NumTracks | int16 | HarmonixMidi/MidiReader.h | ||
| PrevStatus | uint8 | HarmonixMidi/MidiReader.h | ||
| Receiver | IMidiReceiver * | HarmonixMidi/MidiReader.h | ||
| State | EState | HarmonixMidi/MidiReader.h | ||
| TextEncoding | Harmonix::Midi::Constants::EMidiTextEventEncoding | HarmonixMidi/MidiReader.h | ||
| TickConversionFactor | float | HarmonixMidi/MidiReader.h | ||
| TrackEndPos | int32 | HarmonixMidi/MidiReader.h | ||
| TrackFilteringMode | ETrackFilteringMode | HarmonixMidi/MidiReader.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ReadAllTracks() |
HarmonixMidi/MidiReader.h | ||
bool ReadEvents
(
int32 Count |
HarmonixMidi/MidiReader.h | ||
bool ReadSomeEvents
(
int32 NumEvents |
HarmonixMidi/MidiReader.h | ||
bool ReadTrack() |
HarmonixMidi/MidiReader.h |
Overridden from IMidiReader
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const TSharedPtr< FBarMap > GetBarMap() |
Called by a receiver when it wants to format a tick into an MBT for error messaging | HarmonixMidi/MidiReader.h | |
virtual int32 GetCurrentTrackIndex() |
HarmonixMidi/MidiReader.h | ||
virtual const FString & GetCurrentTrackName() |
HarmonixMidi/MidiReader.h | ||
virtual const FString & GetFilename() |
Used by error reporting system | HarmonixMidi/MidiReader.h | |
virtual int32 GetLastTick() |
HarmonixMidi/MidiReader.h | ||
virtual bool IsFailed() |
HarmonixMidi/MidiReader.h | ||
virtual void SkipCurrentTrack() |
Called by a receiver when it wants to skip to the next track | HarmonixMidi/MidiReader.h |
See Also
- FMidiFile