UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FQuartzMetronome Class Reference

#include <QuartzMetronome.h>

Public Member Functions

 FQuartzMetronome (FName InClockName={})
 
 FQuartzMetronome (const FQuartzTimeSignature &InTimeSignature, FName InClockName={})
 
 ~FQuartzMetronome ()
 
void Tick (int32 InNumSamples, int32 FramesOfLatency=0)
 
void SetTickRate (FQuartzClockTickRate InNewTickRate, int32 NumFramesLeft=0)
 
void SetSampleRate (float InNewSampleRate)
 
void SetTimeSignature (const FQuartzTimeSignature &InNewTimeSignature)
 
void ResetTransport ()
 
const FQuartzClockTickRate & GetTickRate () const
 
double GetFramesUntilBoundary (FQuartzQuantizationBoundary InQuantizationBoundary) const
 
const FQuartzTimeSignatureGetTimeSignature () const
 
FQuartzTransportTimeStamp GetTimeStamp () const
 
double GetTimeSinceStart () const
 
uint64 GetLastTickCpuCycles64 () const
 
void CalculateDurationPhases (float(&OutPhases)[static_cast< int32 >(EQuartzCommandQuantization::Count)]) const
 
void SubscribeToTimeDivision (MetronomeCommandQueuePtr InListenerQueue, EQuartzCommandQuantization InQuantizationBoundary)
 
void SubscribeToAllTimeDivisions (MetronomeCommandQueuePtr InListenerQueue)
 
void UnsubscribeFromTimeDivision (MetronomeCommandQueuePtr InListenerQueue, EQuartzCommandQuantization InQuantizationBoundary)
 
void UnsubscribeFromAllTimeDivisions (MetronomeCommandQueuePtr InListenerQueue)
 

Constructor & Destructor Documentation

◆ FQuartzMetronome() [1/2]

Audio::FQuartzMetronome::FQuartzMetronome ( FName  InClockName = {})

◆ FQuartzMetronome() [2/2]

Audio::FQuartzMetronome::FQuartzMetronome ( const FQuartzTimeSignature InTimeSignature,
FName  InClockName = {} 
)

◆ ~FQuartzMetronome()

Audio::FQuartzMetronome::~FQuartzMetronome ( )

Member Function Documentation

◆ CalculateDurationPhases()

void Audio::FQuartzMetronome::CalculateDurationPhases ( float(&)  OutPhases[static_cast< int32 >(EQuartzCommandQuantization::Count)]) const

◆ GetFramesUntilBoundary()

double Audio::FQuartzMetronome::GetFramesUntilBoundary ( FQuartzQuantizationBoundary  InQuantizationBoundary) const

◆ GetLastTickCpuCycles64()

uint64 Audio::FQuartzMetronome::GetLastTickCpuCycles64 ( ) const
inline

◆ GetTickRate()

const FQuartzClockTickRate & Audio::FQuartzMetronome::GetTickRate ( ) const
inline

◆ GetTimeSignature()

const FQuartzTimeSignature & Audio::FQuartzMetronome::GetTimeSignature ( ) const
inline

◆ GetTimeSinceStart()

double Audio::FQuartzMetronome::GetTimeSinceStart ( ) const
inline

◆ GetTimeStamp()

FQuartzTransportTimeStamp Audio::FQuartzMetronome::GetTimeStamp ( ) const
inline

◆ ResetTransport()

void Audio::FQuartzMetronome::ResetTransport ( )

◆ SetSampleRate()

void Audio::FQuartzMetronome::SetSampleRate ( float  InNewSampleRate)

◆ SetTickRate()

void Audio::FQuartzMetronome::SetTickRate ( FQuartzClockTickRate  InNewTickRate,
int32  NumFramesLeft = 0 
)

◆ SetTimeSignature()

void Audio::FQuartzMetronome::SetTimeSignature ( const FQuartzTimeSignature InNewTimeSignature)

◆ SubscribeToAllTimeDivisions()

void Audio::FQuartzMetronome::SubscribeToAllTimeDivisions ( MetronomeCommandQueuePtr  InListenerQueue)

◆ SubscribeToTimeDivision()

void Audio::FQuartzMetronome::SubscribeToTimeDivision ( MetronomeCommandQueuePtr  InListenerQueue,
EQuartzCommandQuantization  InQuantizationBoundary 
)

◆ Tick()

void Audio::FQuartzMetronome::Tick ( int32  InNumSamples,
int32  FramesOfLatency = 0 
)

◆ UnsubscribeFromAllTimeDivisions()

void Audio::FQuartzMetronome::UnsubscribeFromAllTimeDivisions ( MetronomeCommandQueuePtr  InListenerQueue)

◆ UnsubscribeFromTimeDivision()

void Audio::FQuartzMetronome::UnsubscribeFromTimeDivision ( MetronomeCommandQueuePtr  InListenerQueue,
EQuartzCommandQuantization  InQuantizationBoundary 
)

The documentation for this class was generated from the following files: