Navigation
API > API/Plugins > API/Plugins/HarmonixMidi
A map of time signatures changes in a song.
| Name | FBarMap |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMidi/Public/HarmonixMidi/BarMap.h |
| Include Path | #include "HarmonixMidi/BarMap.h" |
Syntax
USTRUCT ()
struct FBarMap
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBarMap() |
HarmonixMidi/BarMap.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| sDefaultTimeSignature | const FTimeSignaturePoint | HarmonixMidi/BarMap.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddTimeSignatureAtBarIncludingCountIn
(
int32 BarIndex, |
Adds a time signature at the specified position, in this case a bar index indicating the bar index from the beginning of the raw midi data. | HarmonixMidi/BarMap.h | |
bool AddTimeSignatureAtMusicTimestampBar
(
int32 BarNumber, |
Adds a time signature at the specified position, in this case a bar number as one would find in an FMusicTimestamp. | HarmonixMidi/BarMap.h | |
int32 BarBeatTickIncludingCountInToTick
(
int32 BarIndex, |
Take a bar, beat (1 based) within that bar, and tick (0 based) within that beat and computes the absolute (raw) total tick from the beginning of the midi data. | HarmonixMidi/BarMap.h | |
int32 BarIncludingCountInToTick
(
int32 BarIndex, |
Takes a bar index and computes the absolute (raw) total tick from the beginning of the midi data. | HarmonixMidi/BarMap.h | |
int32 CalculateMidiTick
(
const FMusicTimestamp& Timestamp, |
HarmonixMidi/BarMap.h | ||
void Copy
(
const FBarMap& Other, |
HarmonixMidi/BarMap.h | ||
void Empty() |
HarmonixMidi/BarMap.h | ||
void Finalize
(
int32 InLastTick |
HarmonixMidi/BarMap.h | ||
float FractionalBarIncludingCountInToTick
(
float FractionalBarIndex |
Takes a fractional bar and returns the absolute tick. | HarmonixMidi/BarMap.h | |
float FractionalBeatIncludingCountInToTick
(
float FractionalBeatIndex |
Takes a fractional beat and returns the absolute tick. | HarmonixMidi/BarMap.h | |
int32 GetNumTimeSignaturePoints() |
HarmonixMidi/BarMap.h | ||
int32 GetPointIndexForTick
(
int32 Tick |
HarmonixMidi/BarMap.h | ||
int32 GetStartBar() |
HarmonixMidi/BarMap.h | ||
int32 GetTickOfBarOne() |
HarmonixMidi/BarMap.h | ||
int32 GetTicksInBarAfterPoint
(
int32 Index |
HarmonixMidi/BarMap.h | ||
int32 GetTicksInBeatAfterPoint
(
int32 Index |
HarmonixMidi/BarMap.h | ||
int32 GetTicksPerQuarterNote() |
HarmonixMidi/BarMap.h | ||
const FTimeSignature & GetTimeSignatureAtBar
(
int32 InBar |
HarmonixMidi/BarMap.h | ||
const FTimeSignature & GetTimeSignatureAtTick
(
int32 InTick |
HarmonixMidi/BarMap.h | ||
int32 GetTimeSignatureChangePointTick
(
int32 PointIndex |
HarmonixMidi/BarMap.h | ||
FTimeSignaturePoint & GetTimeSignaturePoint
(
int32 Index |
HarmonixMidi/BarMap.h | ||
const FTimeSignaturePoint & GetTimeSignaturePoint
(
int32 Index |
HarmonixMidi/BarMap.h | ||
const FTimeSignaturePoint * GetTimeSignaturePointForTick
(
int32 InTick |
HarmonixMidi/BarMap.h | ||
const TArray< FTimeSignaturePoint > & GetTimeSignaturePoints() |
Returns the time signature points for inspection. | HarmonixMidi/BarMap.h | |
bool IsEmpty() |
HarmonixMidi/BarMap.h | ||
int32 MusicTimestampBarBeatTickToTick
(
int32 BarNumber, |
Take a bar, beat (1 based) within that bar, and tick (0 based) within that beat and computes the absolute (raw) total tick from the beginning of the midi data. | HarmonixMidi/BarMap.h | |
int32 MusicTimestampBarToTick
(
int32 BarNumber, |
Takes a "music timestamp" bar and computes the absolute (raw) total tick from the beginning of the midi data. | HarmonixMidi/BarMap.h | |
float MusicTimestampToTick
(
const FMusicTimestamp& Timestamp |
Takes an FMusicTimestamp and computes the absolute (raw) total tick from the beginning of the midi data. | HarmonixMidi/BarMap.h | |
void SetStartBar
(
int32 InStartBar |
HarmonixMidi/BarMap.h | ||
void SetTicksPerQuarterNote
(
int32 InTicksPerQuarterNote |
Called by the midi file importer before map points are added to this map | HarmonixMidi/BarMap.h | |
int32 SubdivisionToMidiTicks
(
const EMidiClockSubdivisionQuantization Division, |
HarmonixMidi/BarMap.h | ||
void SupplyDefault() |
HarmonixMidi/BarMap.h | ||
FMusicTimestamp TickFromBarOneToMusicTimestamp
(
float Tick, |
Takes an tick relative to "bar 1 beat 1" and calculates a music timestamp. | HarmonixMidi/BarMap.h | |
void TickToBarBeatTickIncludingCountIn
(
int32 RawTick, |
Take "raw" tick (tick from the beginning of the midi data and in units of TicksPerQuarterNote) and return a bar (0 based), beat in bar (1 based) within that bar, and tick (0 based) within that beat. | HarmonixMidi/BarMap.h | |
int32 TickToBarIncludingCountIn
(
int32 Tick |
Takes an absolute tick (from the beginning of the midi data) and calculates the bar index, where bar 0 is the beginning of the raw midi data. | HarmonixMidi/BarMap.h | |
int32 TickToBeatIncludingCountIn
(
float Tick |
Takes an absolute tick (from the beginning of the midi data) and calculates the beat index, where beat 0 is the beginning of the raw midi data. | HarmonixMidi/BarMap.h | |
float TickToFractionalBarIncludingCountIn
(
float Tick |
Takes an absolute tick (from the beginning of the midi data) and calculates the fractional bar, where bar 0.0 is the beginning of the raw midi data. | HarmonixMidi/BarMap.h | |
float TickToFractionalBeatIncludingCountIn
(
float Tick |
Takes an absolute tick (from the beginning of the midi data) and calculates the fractional beat, where beat 0.0 is the beginning of the raw midi data. | HarmonixMidi/BarMap.h | |
FMusicTimestamp TickToMusicTimestamp
(
float Tick, |
Takes an absolute tick and calculates a music timestamp. | HarmonixMidi/BarMap.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FBarMap& Other |
HarmonixMidi/BarMap.h |