1. Epic GamesDeveloper
  3. UFrameBasedMusicMap

UFrameBasedMusicMap

API > API/Plugins > API/Plugins/MusicEnvironment

   
Name UFrameBasedMusicMap
Type class
Header File /Engine/Plugins/Runtime/MusicEnvironment/Source/MusicEnvironment/Public/FrameBasedMusicMap.h
Include Path #include "FrameBasedMusicMap.h"

Syntax

UCLASS (MinimalAPI)  
class UFrameBasedMusicMap : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  FrameBasedMusicMap.h  

UFrameBasedMusicMap ( const FFrameRate& InFrameResolution
)

   FrameBasedMusicMap.h  

UFrameBasedMusicMap ( const FFrameRate& InFrameResolution,
float InBpm,
const FFrameBasedTimeSignature& TimeSignature
)

   FrameBasedMusicMap.h  

Enums

Public

Name Remarks
EQuantizeDirection  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BarMap TArray< FFrameBasedTimeSignaturePoint >   FrameBasedMusicMap.h  
FrameResolution FFrameRate   FrameBasedMusicMap.h  
TempoMap TArray< FFrameBasedTempoPoint >   FrameBasedMusicMap.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FMusicalTime Add ( const FMusicalTime& MusicalTime,
int32 QuantizationInterval
) const

 FMusicalTimeAdd(const FMusicalTime& MusicalTime, int32 QuantizationInterval) const; FrameBasedMusicMap.h  

void AddTempo ( int32 AtTick,
float AtMs,
float Bpm
)

 Appends a tempo change to the end of the Ensures that this tempo change's tick is after the last one in the map FrameBasedMusicMap.h  

void AddTimeSignature ( int32 AtTick,
int32 AtBar,
int16 Numerator,
int16 Denominator
)

 Appends a time signature change to the end of the Bar Map. FrameBasedMusicMap.h  

FMusicalTime BarsToMusicalTime ( double BarsFromStart
) const

   FrameBasedMusicMap.h  

void Clear()

   FrameBasedMusicMap.h  

void ComputeGridSpacingAtTick ( int32 TickToCompute,
float DesiredMajorTickSeconds,
int32& OutMajorIntervalTicks
) const

   FrameBasedMusicMap.h  

void ComputeMinorGridSpacing ( int32 StartTick,
int32 EndTick,
TArray< FGridInterval >& OutMinorIntervals
) const

   FrameBasedMusicMap.h  

void GatherBarsForTimespan ( int32 StartBar,
int32 EndBar,
int32 QuantizationInterval,
TArray< FGridInterval >& OutBars
) const

   FrameBasedMusicMap.h  

void GatherSubdivisonsForTimespan ( int32 StartTick,
int32 EndTick,
int32 QuantizationInterval,
TArray< FGridInterval >& OutSubdivisions
) const

   FrameBasedMusicMap.h  

int32 GetBeatsInBar ( int32 Bar
) const

   FrameBasedMusicMap.h  

double GetFrame ( int32 AtBar
) const

   FrameBasedMusicMap.h  

double GetFrame ( const FMusicalTime& MusicalTime
) const

   FrameBasedMusicMap.h  

FFrameTime GetFrameTime ( int32 AtTick
) const

   FrameBasedMusicMap.h  

FFrameTime GetFrameTime ( double FractionalBar
) const

   FrameBasedMusicMap.h  

FFrameTime GetFrameTime ( const FMusicalTime& MusicalTime
) const

   FrameBasedMusicMap.h  

FFrameTime GetFrameTime ( int32 AtBar,
float AtBeat
) const

   FrameBasedMusicMap.h  

void GetGridMetricsMusic ( float InViewStartSeconds,
float InViewEndSeconds,
float PixelsPerSecond,
float MinTickPx,
float DesiredMajorTickPx,
TArray< FGridInterval >& OutMajorIntervals,
TArray< FGridInterval >& OutMinorIntervals
) const

   FrameBasedMusicMap.h  

float GetInitialTempo()

   FrameBasedMusicMap.h  

FFrameBasedTimeSignature GetInitialTimeSignature()

   FrameBasedMusicMap.h  

FMusicalTime GetMusicalTime ( const FFrameTime& FrameTime
) const

   FrameBasedMusicMap.h  

FMusicalTime GetMusicalTime ( int32 Tick
) const

   FrameBasedMusicMap.h  

double GetSeconds ( const FMusicalTime& MusicalTime
) const

   FrameBasedMusicMap.h  

double GetSeconds ( int32 AtBar,
float AtBeat
) const

   FrameBasedMusicMap.h  

float GetTempoForFrame ( double DecimalFrame
) const

   FrameBasedMusicMap.h  

float GetTempoForFrameTime ( const FFrameTime& FrameTime
) const

   FrameBasedMusicMap.h  

float GetTempoForSeconds ( double Seconds
) const

   FrameBasedMusicMap.h  

TArray< FFrameBasedTempoPoint > GetTempoMetrics ( float InViewStartSeconds,
float InViewEndSeconds
) const

   FrameBasedMusicMap.h  

void GetTempoTimeSignatureMarkers ( float InStartSeconds,
float InEndSeconds,
TArray< FTempoTimeSignatureMarker >& OutMarkers
) const

   FrameBasedMusicMap.h  

int32 GetTicksInBar ( int32 Bar
) const

   FrameBasedMusicMap.h  

FFrameBasedTimeSignature GetTimeSignatureForFrame ( double DecimalFrame
) const

   FrameBasedMusicMap.h  

FFrameBasedTimeSignature GetTimeSignatureForFrameTime ( const FFrameTime& FrameTime
) const

   FrameBasedMusicMap.h  

FFrameBasedTimeSignature GetTimeSignatureForSeconds ( double Seconds
) const

   FrameBasedMusicMap.h  

bool HasTempoChange ( FMusicalTime AtMusicalTime
)

   FrameBasedMusicMap.h  

bool HasTempoChange ( int32 AtTick
)

   FrameBasedMusicMap.h  

bool HasTimeSignatureChange ( FMusicalTime AtMusicalTime
)

   FrameBasedMusicMap.h  

bool HasTimeSignatureChange ( int32 AtBar
)

   FrameBasedMusicMap.h  

void Init ( float InBpm,
const FFrameBasedTimeSignature& InTimeSignature
)

   FrameBasedMusicMap.h  

void InsertTempo ( int32 AtTick,
float Bpm
)

 Inserts a Tempo Change at the specified tick, avoiding duplicates as needed. FrameBasedMusicMap.h  

void InsertTempo ( FMusicalTime AtMusicalTime,
float Bpm
)

 Inserts a Tempo Change at the specified MusicalTime, avoiding duplicates as needed. FrameBasedMusicMap.h  

void InsertTimeSignature ( int32 AtBar,
int16 Numerator,
int16 Denominator
)

 Inserts a Time Signature change at the specified Bar, avoiding duplicates as needed. FrameBasedMusicMap.h  

void InsertTimeSignature ( FMusicalTime AtMusicalTime,
const FFrameBasedTimeSignature& TimeSignature
)

 Inserts a Time Signature change at the specified Bar of the Musical Time (ignoring beats), avoiding duplicates as needed. FrameBasedMusicMap.h  

bool IsEmpty()

   FrameBasedMusicMap.h  

bool IsSimple()

   FrameBasedMusicMap.h  

FString MakeBarBeatStringForFrame ( double DecimalFrame,
FrameBasedMusicMap::EBarBeatFormat BarBeatFormat
) const

   FrameBasedMusicMap.h  

FString MakeBarBeatStringForFrameTime ( const FFrameTime& Frame,
FrameBasedMusicMap::EBarBeatFormat BarBeatFormat
) const

   FrameBasedMusicMap.h  

FString MakeBarBeatStringForMusicalTime ( const FMusicalTime& MusicalTime,
FrameBasedMusicMap::EBarBeatFormat BarBeatFormat
) const

   FrameBasedMusicMap.h  

FString MakeBarBeatStringForSeconds ( double Seconds,
FrameBasedMusicMap::EBarBeatFormat BarBeatFormat
) const

   FrameBasedMusicMap.h  

FMusicalTime Quantize ( const FMusicalTime& MusicalTime,
int32 QuantizationInterval,
EQuantizeDirection Direction
) const

   FrameBasedMusicMap.h  

int32 QuantizeToTick ( const FMusicalTime& MusicalTime,
int32 QuantizationInterval,
EQuantizeDirection Direction
) const

   FrameBasedMusicMap.h  

FFrameTime RemapFrameTime ( FFrameTime SourceTime,
const UFrameBasedMusicMap* OldMap
) const

   FrameBasedMusicMap.h  

bool RemoveTempo ( int32 AtTick
)

 Removes the tempo change at the specified tick, if it exists Time signature and tempo changes after this point will recalculate their frame times and ms respectively based on the new tempo change FrameBasedMusicMap.h  

bool RemoveTempo ( FMusicalTime AtMusicalTime
)

 Removes the tempo change at the specified Musical Time, if it exists FrameBasedMusicMap.h  

bool RemoveTimeSignature ( FMusicalTime AtMusicalTime
)

 Removes the time signature change at the specified Musical Time, if it exists FrameBasedMusicMap.h  

bool RemoveTimeSignature ( int32 AtBar
)

 Removes the time signature change at the specified bar, if it exists Time Signature changes after this point will recalculate their ticks and frame times to happen on the new bar lines based on the inserted time signature change FrameBasedMusicMap.h  

void SetFrameResolution ( const FFrameRate& NewFrameResolution
)

   FrameBasedMusicMap.h  

void SetInitialTempo ( float Bpm
)

   FrameBasedMusicMap.h  

void SetInitialTimeSignature ( const FFrameBasedTimeSignature& TimeSignature
)

   FrameBasedMusicMap.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page