UMusicTimerManager

API > API/Plugins > API/Plugins/HarmonixMetasound

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

Syntax

UCLASS (Blueprintable, BlueprintType)  
class UMusicTimerManager : public UObject

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
NextTimerId std::atomic< uint64 >   HarmonixMetasound/Components/MusicTimerManager.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveTimers TArray< TUniquePtr< FMusicTimer > >   HarmonixMetasound/Components/MusicTimerManager.h  
LastUpdateFrame uint64   HarmonixMetasound/Components/MusicTimerManager.h  
LastUpdateFrameSongPositions TStaticArray< FMidiSongPos,(int32) ECalibratedMusicTimebase::Count > Used so pause doesn't need to pass in this info. HarmonixMetasound/Components/MusicTimerManager.h  
PendingTimers TArray< TUniquePtr< FMusicTimer > >   HarmonixMetasound/Components/MusicTimerManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FMusicTimerHandle AddTimerNative ( const FMusicTimeInterval& TimerInterval,
FMusicTimestamp StartTime,
ECalibratedMusicTimebase Timebase,
bool bLooping,
FSimpleDelegate TimerDelegate
)

 Adds a musical timer. HarmonixMetasound/Components/MusicTimerManager.h  

FMusicTimerHandle BP_AddTimer ( const FMusicTimeInterval& TimerInterval,
FMusicTimestamp StartTime,
ECalibratedMusicTimebase Timebase,
bool bLooping,
FOnMusicalTimerExecute TimerDelegate
)

 Adds a musical timer. HarmonixMetasound/Components/MusicTimerManager.h
  • BlueprintCallable
  • Category="Music|Timer"

uint64 GetUniqueTimerId()

   HarmonixMetasound/Components/MusicTimerManager.h  

void PauseTimer ( const FMusicTimerHandle& Handle,
bool bPause
)

   HarmonixMetasound/Components/MusicTimerManager.h
  • BlueprintCallable
  • Category="Music|Timer"

FMusicTimestamp Quantize ( const UMusicClockComponent* MusicClock,
const FMusicTimestamp& Time,
EMidiClockSubdivisionQuantization QuantizationInterval,
EMidiFileQuantizeDirection InDirection
) const

   HarmonixMetasound/Components/MusicTimerManager.h
  • BlueprintCallable
  • Category="Music|Timer"

void RemoveTimer ( const FMusicTimerHandle& Handle
)

   HarmonixMetasound/Components/MusicTimerManager.h
  • BlueprintCallable
  • Category="Music|Timer"

void UpdateForGameFrame ( const TStaticArray< FMidiSongPos,(int32) ECalibratedMusicTimebase::Count >& CurrentSongPositions
)

 We need the MidiSongPosition in each calibrated time, because each timer can be operating on their own timebase. HarmonixMetasound/Components/MusicTimerManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page