1. Epic GamesDeveloper
  3. UMusicClockComponent

UMusicClockComponent

API > API/Plugins > API/Plugins/HarmonixMetasound

   
Name UMusicClockComponent
Type class
Header File /Engine/Plugins/Runtime/Harmonix/Source/HarmonixMetasound/Public/HarmonixMetasound/Components/MusicClockComponent.h
Include Path #include "HarmonixMetasound/Components/MusicClockComponent.h"

Syntax

UCLASS (MinimalAPI, ClassGroup=(MetaSoundMusic), prioritizeCategories="MusicClock",  
       Meta=(BlueprintSpawnableComponent, DisplayName="Music Clock", ScriptName=MusicClockComponent))  
class UMusicClockComponent :  
    public UActorComponent ,  
    public IMusicEnvironmentClockSource

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UMusicClockComponent()

 Sets default values for this component's properties. HarmonixMetasound/Components/MusicClockComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AudioRenderMusicTimeDiscontinuityEvent FMusicTimeDiscontinuityEvent   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintAssignable
  • Category="MusicClock"
BarEvent FBarEvent   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintAssignable
  • Category="MusicClock"
BeatEvent FBeatEvent   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintAssignable
  • Category="MusicClock"
DriveMethod EMusicClockDriveMethod   HarmonixMetasound/Components/MusicClockComponent.h
  • EditAnywhere
  • Category="MusicClock"
MetasoundOutputName FName   HarmonixMetasound/Components/MusicClockComponent.h
  • EditAnywhere
  • Category="MusicClock"
  • Meta=(EditCondition="DriveMethod == EMusicClockDriveMethod::MetaSound", EditConditionHides)
MetasoundsAudioComponent TObjectPtr< UAudioComponent >   HarmonixMetasound/Components/MusicClockComponent.h
  • VisibleAnywhere
  • BlueprintReadWrite
  • Category="MusicClock"
  • Meta=(EditCondition="DriveMethod == EMusicClockDriveMethod::MetaSound", EditConditionHides)
MusicClockConnectedEvent FMusicClockConnected   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintAssignable
  • Category="MusicClock"
MusicClockDisconnectedEvent FMusicClockDisconnected   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintAssignable
  • Category="MusicClock"
MusicClockSettings TInstancedStruct< FMusicClockSettingsBase >   HarmonixMetasound/Components/MusicClockComponent.h
  • EditAnywhere
  • Category="MusicClock"
  • NoClear
  • Meta=(EditCondition="DriveMethod == EMusicClockDriveMethod::Custom")
PlayerExperienceMusicTimeDiscontinuityEvent FMusicTimeDiscontinuityEvent   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintAssignable
  • Category="MusicClock"
PlayStateEvent FPlayStateEvent   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintAssignable
  • Category="MusicClock"
SectionEvent FSectionEvent   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintAssignable
  • Category="MusicClock"
TempoMap TObjectPtr< UMidiFile >   HarmonixMetasound/Components/MusicClockComponent.h
  • EditAnywhere
  • Category="MusicClock"
  • Meta=(EditCondition="DriveMethod == EMusicClockDriveMethod::WallClock", EditConditionHides)
TimebaseForBarAndBeatEvents ECalibratedMusicTimebase   HarmonixMetasound/Components/MusicClockComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="MusicClock"
VideoRenderMusicTimeDiscontinuityEvent FMusicTimeDiscontinuityEvent   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintAssignable
  • Category="MusicClock"

Protected

Name Type Remarks Include Path Unreal Specifiers
ClockDriver TSharedPtr< FMusicClockDriverBase >   HarmonixMetasound/Components/MusicClockComponent.h  
DefaultMaps FSongMaps   HarmonixMetasound/Components/MusicClockComponent.h  
LastBroadcastBar int32   HarmonixMetasound/Components/MusicClockComponent.h  
LastBroadcastBeat int32   HarmonixMetasound/Components/MusicClockComponent.h  
LastBroadcastSongSection FSongSection   HarmonixMetasound/Components/MusicClockComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float BarToMs ( float Bar
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Bar"

float BeatToMs ( float Beat
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Beat"

FMidiSongPos CalculateSongPosWithOffset ( float MsOffset,
ECalibratedMusicTimebase Timebase
) const

   HarmonixMetasound/Components/MusicClockComponent.h  

void ConnectToCustomClockWithSettings ( const MusicClockSettingsType& InMusicClockSettings
)

   HarmonixMetasound/Components/MusicClockComponent.h  
  HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="MusicClock"

bool ConnectToMetasoundOnAudioComponent ( UAudioComponent* InAudioComponent
)

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="MusicClock"

void ConnectToWallClockForMidi ( UMidiFile* InTempoMap
)

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="MusicClock"

void Continue()

 Continue the clock from paused HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="MusicClock"
Returns the fractional total bars from the beginning of the authored music content. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetBeatInBarAtMs ( float Ms
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Beat"
Returns the fractional total beats from the beginning of the authored music content. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetCountInSeconds()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Count In"
Get The Current Bars per Second. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"
Get The Current BPM of the running clock 0 if the clock is stopped This is in units of our Beats, not Quarter notes. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"
Get The Current Beats per Second. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentClockAdvanceRate()

 Get The Current Clock advance rate0 if the clock is stopped HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

FMidiSongPos GetCurrentPlayerExperiencedSongPos()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="MusicClock"

FMidiSongPos GetCurrentRawAudioRenderSongPos()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="MusicClock"
Get The Current Seconds per Bar Based on the current tempo, advance rate and time signature HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"
Get The Current Seconds per Beat Based on the current tempo, advance rate and time signature HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

int32 GetCurrentSectionIndex ( ECalibratedMusicTimebase Timebase
) const

 Returns the index of the current section for the provided time base. [0, Num-1] HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentSectionLengthMs ( ECalibratedMusicTimebase Timebase
) const

 Returns the length of the current section in milliseconds HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

FString GetCurrentSectionName ( ECalibratedMusicTimebase Timebase
) const

 Returns the name of the section that we're currently in (intro, chorus, outro) HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentSectionStartMs ( ECalibratedMusicTimebase Timebase
) const

 Returns the start time of the current section in milliseconds HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

FMidiSongPos GetCurrentSmoothedAudioRenderSongPos()

 Getter functions for the Blueprint properties exposed above... HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentTempo ()

 Get The Current Tempo of the running clock 0 if the clock is stopped This is Midi Tempo, which is QuarterNotesPerMinute. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

void GetCurrentTimeSignature ( int& OutNumerator,
int& OutDenominator
) const

 Get The Current Time Signature0 if the clock is stopped HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"
Returns the "classic" musical timestamp in the form Bar (int) & Beat (float). HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

FMidiSongPos GetCurrentVideoRenderSongPos()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="MusicClock"

float GetDeltaBar ( ECalibratedMusicTimebase Timebase
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetDeltaBeat ( ECalibratedMusicTimebase Timebase
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetDistanceFromCurrentBar ( ECalibratedMusicTimebase Timebase
) const

 Gets a value expressed in bars between 0-1 that indicates how much progress we made towards the current bar to the next one. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetDistanceFromCurrentBeat ( ECalibratedMusicTimebase Timebase
) const

 Gets a value expressed in beats between 0-1 that indicates how much progress we made in the current beat HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetDistanceToClosestBar ( ECalibratedMusicTimebase Timebase
) const

 Gets value expressed in bars between 0-1 that indicates how close we are to the closest bar (current bar or next bar). HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetDistanceToClosestBeat ( ECalibratedMusicTimebase Timebase
) const

 Gets a value expressed in beats between 0-1 that indicates how close we are to the closest beat (current beat or next beat). HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetDistanceToNextBar ( ECalibratedMusicTimebase Timebase
) const

 Gets a value expressed in bars between 0-1 that indicates how close we are to the next bar. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetDistanceToNextBeat ( ECalibratedMusicTimebase Timebase
) const

 Gets a value expressed in beats between 0-1 that indicates how close we are to the next beat. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetMsPerBarAtMs ( float Ms
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Bar"

float GetMsPerBeatAtMs ( float Ms
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Beat"

float GetNumBeatsInBarAtMs ( float Ms
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Beat"

int32 GetNumSections()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Section"

FMidiSongPos GetPreviousPlayerExperiencedSongPos()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="MusicClock"

FMidiSongPos GetPreviousSmoothedAudioRenderSongPos()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="MusicClock"

const FMidiSongPos & GetPreviousSongPos ( ECalibratedMusicTimebase Timebase
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

FMidiSongPos GetPreviousVideoRenderSongPos()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="MusicClock"

const FMidiSongPos & GetRawUnsmoothedAudioRenderPos()

   HarmonixMetasound/Components/MusicClockComponent.h  

bool GetRunPastMusicEnd()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"
Time from Bar 1 Beat 1. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"
Time from the beginning of the authored music content. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetSectionEndMsAtMs ( float Ms
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Section"

float GetSectionLengthMsAtMs ( float Ms
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Section"

FString GetSectionNameAtMs ( float Ms
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Section"

float GetSectionStartMsAtMs ( float Ms
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Section"

float GetSongLengthBars()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Song Data"

float GetSongLengthBeats()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Song Data"

float GetSongLengthMs()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Song Data"

const ISongMapEvaluator & GetSongMaps()

   HarmonixMetasound/Components/MusicClockComponent.h  

const FMidiSongPos & GetSongPos ( ECalibratedMusicTimebase Timebase
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetSongRemainingMs ( ECalibratedMusicTimebase Timebase
) const

 Returns the remaining time until the end of the MIDI in milliseconds based on the timestamp corresponding to the passed Timebase HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

const TArray< FSongSection > & GetSongSections()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

EMusicClockState GetState()

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float GetTicksFromBarOne ( ECalibratedMusicTimebase Timebase
) const

 NOTE: Working in ticks is a little risky. HarmonixMetasound/Components/MusicClockComponent.h  

float GetTicksIncludingCountIn ( ECalibratedMusicTimebase Timebase
) const

   HarmonixMetasound/Components/MusicClockComponent.h  

bool LoopedThisFrame ( ECalibratedMusicTimebase Timebase
) const

 Returns true if there was a seek in the specified timebase HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

float MeasureSpanProgress ( const FMusicalTimeSpan& Span,
ECalibratedMusicTimebase Timebase
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

void Pause()

 Pause the clock at the current running time HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="MusicClock"

bool SeekedThisFrame ( ECalibratedMusicTimebase Timebase
) const

 Returns true if there was a seek in the specified timebase HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="MusicClock"

void SetDefaultTempo ( float TempoBpm
)

 Set the default tempo, only call when there's no tempo map. HarmonixMetasound/Components/MusicClockComponent.h  

void SetDefaultTimeSignatureDenom ( int Denom
)

 Set the default time signature denominator, only call when there's no tempo map. HarmonixMetasound/Components/MusicClockComponent.h  

void SetDefaultTimeSignatureNum ( int Num
)

 Set the default time signature numerator, only call when there's no tempo map. HarmonixMetasound/Components/MusicClockComponent.h  

void SetRunPastMusicEnd ( bool bRunPastMusicEnd
)

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="MusicClock"

void SetTempoMapForWallClock ( UMidiFile* InTempoMap
)

 Set the tempo map when running off of wall clock. HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="MusicClock"

void Start()

 Start the clock ticking and tracking music time Same as "Activate" HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="MusicClock"

void Stop()

 Stop this clock ticking and no longer track music time Same as "Deactivate" HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="MusicClock"

void TickComponentInternal()

   HarmonixMetasound/Components/MusicClockComponent.h  

float TickToMs ( float Tick
) const

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintPure
  • Category="Tick"

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void Activate ( bool bReset
)

 Start this clock ticking and start tracking music time Same as "Start()" HarmonixMetasound/Components/MusicClockComponent.h  

virtual void BeginPlay()

   HarmonixMetasound/Components/MusicClockComponent.h  

virtual void Deactivate()

 Stop this clock ticking and stop tracking music time Same as "Stop()" HarmonixMetasound/Components/MusicClockComponent.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   HarmonixMetasound/Components/MusicClockComponent.h  

virtual void TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   HarmonixMetasound/Components/MusicClockComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   HarmonixMetasound/Components/MusicClockComponent.h  

Overridden from IMusicEnvironmentClockSource

Name Remarks Include Path Unreal Specifiers

virtual bool CanAuditionInEditor()

   HarmonixMetasound/Components/MusicClockComponent.h  

virtual int32 GetPositionAbsoluteTick ( const FMusicalTime& SourceSpaceOffset
) const

   HarmonixMetasound/Components/MusicClockComponent.h  

virtual int32 GetPositionAbsoluteTick ()

   HarmonixMetasound/Components/MusicClockComponent.h  

virtual FMusicalTime GetPositionMusicalTime ( const FMusicalTime& SourceSpaceOOffset
) const

   HarmonixMetasound/Components/MusicClockComponent.h  
  HarmonixMetasound/Components/MusicClockComponent.h  

virtual float GetPositionSeconds()

 Vvv BEGIN IMusicEnvironmentClockSource Implementation vvv HarmonixMetasound/Components/MusicClockComponent.h  

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

   HarmonixMetasound/Components/MusicClockComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static UMusicClockComponent * CreateMetasoundDrivenMusicClock ( UObject* WorldContextObject,
UAudioComponent* InAudioComponent,
FName MetasoundOuputPinName,
bool Start
)

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="Audio|MusicClock"
  • Meta=(WorldContext="WorldContextObject", DefaultToSelf="WorldContextObject")

static UMusicClockComponent * CreateMusicClockWithSettings ( UObject* WorldContextObject,
const MusicClockSettingsType& InMusicClockSettings,
bool Start
)

   HarmonixMetasound/Components/MusicClockComponent.h  

static UMusicClockComponent * CreateMusicClockWithSettings ( UObject* WorldContextObject,
TInstancedStruct< FMusicClockSettingsBase > MusicClockSettings,
bool Start
)

   HarmonixMetasound/Components/MusicClockComponent.h  

static UMusicClockComponent * CreateWallClockDrivenMusicClock ( UObject* WorldContextObject,
UMidiFile* WithTempoMap,
bool Start
)

   HarmonixMetasound/Components/MusicClockComponent.h
  • BlueprintCallable
  • Category="Audio|MusicClock"
  • Meta=(WorldContext="WorldContextObject", DefaultToSelf="WorldContextObject")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page