Navigation
API > API/Plugins > API/Plugins/HarmonixMidi
FSongMaps encapsulates a number of other musical/midi map types that are very useful for musical gameplay and interactivity.
With this class and the current playback position of a piece of music you can do things like determine the current Bar | Beat | Tick, song section, tempo, chord, etc.
| Name | FSongMaps |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMidi/Public/HarmonixMidi/SongMaps.h |
| Include Path | #include "HarmonixMidi/SongMaps.h" |
Syntax
USTRUCT (BlueprintType )
struct FSongMaps : public ISongMapEvaluator
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSongMaps
(
float Bpm, |
HarmonixMidi/SongMaps.h | ||
FSongMaps
(
const ISongMapEvaluator& Other |
HarmonixMidi/SongMaps.h | ||
FSongMaps () |
HarmonixMidi/SongMaps.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSongMaps() |
HarmonixMidi/SongMaps.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| LengthData | FSongLengthData | HarmonixMidi/SongMaps.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddTempoChange
(
int32 Tick, |
HarmonixMidi/SongMaps.h | ||
bool AddTempoInfoPoint
(
int32 MicrosecondsPerQuarterNote, |
HarmonixMidi/SongMaps.h | ||
void AddTimeSigChange
(
int32 Tick, |
HarmonixMidi/SongMaps.h | ||
bool AddTimeSignatureAtBarIncludingCountIn
(
int32 BarIndex, |
HarmonixMidi/SongMaps.h | ||
void Copy
(
const ISongMapEvaluator& Other, |
HarmonixMidi/SongMaps.h | ||
void EmptyAllMaps() |
HarmonixMidi/SongMaps.h | ||
void EmptyBarMap() |
HarmonixMidi/SongMaps.h | ||
void EmptyBeatMap() |
HarmonixMidi/SongMaps.h | ||
void EmptyChordMap() |
HarmonixMidi/SongMaps.h | ||
void EmptySectionMap() |
HarmonixMidi/SongMaps.h | ||
void EmptyTempoMap() |
HarmonixMidi/SongMaps.h | ||
void EmptyTrackNames() |
HarmonixMidi/SongMaps.h | ||
void FillInFrameBasedMusicMap
(
UFrameBasedMusicMap* Map |
HarmonixMidi/SongMaps.h | ||
void FinalizeBarMap
(
int32 InLastTick |
HarmonixMidi/SongMaps.h | ||
| HarmonixMidi/SongMaps.h | |||
FBeatMap & GetBeatMap () |
HarmonixMidi/SongMaps.h | ||
| HarmonixMidi/SongMaps.h | |||
FTimeSignaturePoint * GetMutableTimeSignaturePoint
(
int32 PointIndex |
HarmonixMidi/SongMaps.h | ||
FSectionMap & GetSectionMap () |
HarmonixMidi/SongMaps.h | ||
| HarmonixMidi/SongMaps.h | |||
FTempoMap & GetTempoMap () |
HarmonixMidi/SongMaps.h | ||
int32 GetTicksPerQuarterNote() |
HarmonixMidi/SongMaps.h | ||
FString GetTrackName
(
int32 Index |
HarmonixMidi/SongMaps.h | ||
TArray< FString > & GetTrackNames () |
Tracks | HarmonixMidi/SongMaps.h | |
const TArray< FString > & GetTrackNames () |
HarmonixMidi/SongMaps.h | ||
void Init
(
int32 InTicksPerQuarterNote |
HarmonixMidi/SongMaps.h | ||
bool IsEmpty() |
HarmonixMidi/SongMaps.h | ||
bool LoadFromStdMidiFile
(
const FString& FilePath |
For importing... | HarmonixMidi/SongMaps.h | |
bool LoadFromStdMidiFile
(
void* Buffer, |
HarmonixMidi/SongMaps.h | ||
bool LoadFromStdMidiFile
(
TSharedPtr< FArchive > Archive, |
HarmonixMidi/SongMaps.h | ||
void SetLengthTotalBars
(
int32 Bars |
HarmonixMidi/SongMaps.h | ||
void SetSongLengthTicks
(
int32 NewLengthTicks |
HarmonixMidi/SongMaps.h | ||
void SetStartBar
(
int32 StartBar |
HarmonixMidi/SongMaps.h | ||
bool TrackNamesIsEmpty() |
HarmonixMidi/SongMaps.h |
Overridden from ISongMapEvaluator
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| HarmonixMidi/SongMaps.h | |||
virtual const FBeatMap & GetBeatMap () |
HarmonixMidi/SongMaps.h | ||
virtual const FChordProgressionMap & GetChordMap () |
HarmonixMidi/SongMaps.h | ||
virtual const FSectionMap & GetSectionMap () |
HarmonixMidi/SongMaps.h | ||
virtual const FSongLengthData & GetSongLengthData () |
HarmonixMidi/SongMaps.h | ||
virtual const FTempoMap & GetTempoMap () |
BEGIN ISongMapEvaluator overrides (Immutable access to maps) | HarmonixMidi/SongMaps.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FSongMaps& Other |
HarmonixMidi/SongMaps.h |