UMusicClock

A read-only view into a music source's time.

API > API/Plugins > API/Plugins/HarmonixMetasound

A read-only view into a music source's time.

UMusicClock does not own or control playback. It observes an IMusicSource and provides:

  • Current/previous musical position (FMidiSongPos)
  • Tempo, time signature, BPM queries
  • Beat/bar/section event broadcasting
  • Song map delegation for time conversions

A single UMusicClock represents a single time stream with no ECalibratedMusicTimebase parameter. For calibrated offsets (experienced, video render, etc.) use UOffsetMusicSource feeding into a separate UMusicClock.

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

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UMusicClock : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMusicClock()

   HarmonixMetasound/MusicClock/MusicClock.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BarEvent FMusicClockBarEvent   HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintAssignable
  • Category="MusicClock"
BeatEvent FMusicClockBeatEvent   HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintAssignable
  • Category="MusicClock"
PlayStateEvent FMusicClockPlayStateEvent   HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintAssignable
  • Category="MusicClock"
SectionEvent FMusicClockSectionEvent   HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintAssignable
  • Category="MusicClock"

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetBarsIncludingCountIn()

 Fractional total bars from the beginning, including count-in. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetBeatsIncludingCountIn()

 Fractional total beats from the beginning, including count-in. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentBarsPerSecond()

 Current bars per second, accounting for tempo, time signature, and speed. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentBeatsPerMinute()

 Current BPM in true beats (not quarter notes). HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentBeatsPerSecond()

 Current beats per second, accounting for tempo, time signature, and speed. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentClockAdvanceRate()

 Current playback speed multiplier from the source. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

int32 GetCurrentSectionIndex()

 Index of the current section in the section map. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentSectionLengthMs()

 Length of the current section in milliseconds. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

FString GetCurrentSectionName()

 Name of the current song section (from MIDI section markers). HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentSectionStartMs()

 Start time of the current section in milliseconds. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

const FMidiSongPos & GetCurrentSongPos()

 Get the current musical position for this frame. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetCurrentTempo()

 Current tempo in MIDI quarter notes per minute. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

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

 Get the current time signature as numerator and denominator. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"
Get the current musical timestamp (Bar + Beat). HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetDeltaBar()

 Fractional bars advanced this frame. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetDeltaBeat()

 Fractional beats advanced this frame. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

FString GetDisplayName()

   HarmonixMetasound/MusicClock/MusicClock.h  

float GetDistanceFromCurrentBar()

 Fractional distance past the most recent bar (0.0 = exactly on bar). HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"
- Beat/Bar Distance - All distance values are fractional: 0.0 = on the beat/bar, 0.5 = halfway to the next. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetDistanceToClosestBar()

 Fractional distance to the closest bar (past or future), always <= 0.5. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetDistanceToClosestBeat()

 Fractional distance to the closest beat (past or future), always <= 0.5. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetDistanceToNextBar()

 Fractional distance until the next bar. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetDistanceToNextBeat()

 Fractional distance until the next beat (0.0 = exactly on next beat). HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

const FMidiSongPos & GetPreviousSongPos()

 Get the previous frame's musical position. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetSecondsFromBarOne()

 Time from Bar 1 Beat 1 (the classic "start of the song"), excluding count-in/pickup. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetSecondsIncludingCountIn()

 Time from the beginning of the authored music content, including count-in/pickup bars. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetSongLengthMs()

 Total length of the song in milliseconds. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

float GetSongRemainingMs()

 Remaining time until the end of the song in milliseconds. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"
Get the source this clock is bound to. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

bool LoopedThisFrame()

 Whether the source crossed a loop boundary this frame. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

bool SeekedThisFrame()

 Whether the source performed a non-contiguous time jump this frame. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

void SetSource ( const TScriptInterface< IMusicSource >& InSource
)

 Bind this clock to a music source. The clock becomes a read-only view into that source. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintCallable
  • Category="MusicClock"

TOptional< FVector > TryGetAudioSourceLocation()

 Get the world-space location of the audio source, if available. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual float GetLoopLengthMs()

 Length of loop region in ms. Only meaningful if IsLooping(). HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

virtual float GetLoopStartMs()

 Start of loop region in ms. Only meaningful if IsLooping(). HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

virtual const ISongMapEvaluator * GetSongMaps()

 Get the song maps from the bound source, for time<->beat conversions. HarmonixMetasound/MusicClock/MusicClock.h  

virtual EMusicClockState GetState()

 Get the current clock state (Stopped, Paused, Running). HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

virtual bool IsLooping()

 Whether the source is looping. HarmonixMetasound/MusicClock/MusicClock.h
  • BlueprintPure
  • Category="MusicClock"

virtual void UpdateForGameFrame ()

 Update the clock for the current game frame. HarmonixMetasound/MusicClock/MusicClock.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   HarmonixMetasound/MusicClock/MusicClock.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BroadcastSongPosChanges()

 Broadcast beat, bar, and section events if thresholds were crossed this frame. HarmonixMetasound/MusicClock/MusicClock.h  

IMusicSource * GetValidSource()

 Get the source if still alive, or nullptr. HarmonixMetasound/MusicClock/MusicClock.h  

void UpdatePlaybackRate ( const FMidiSongPos& SongPos,
float InClockAdvanceRate
)

 Update cached tempo, time signature, and derived rates when the song position changes. HarmonixMetasound/MusicClock/MusicClock.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page