1. Epic GamesDeveloper
  3. UQuartzClockHandle

UQuartzClockHandle

This class is a BP / Game thread wrapper around FQuartzClockProxy (to talk to the underlying clock)

API > API/Runtime > API/Runtime/AudioMixer

This class is a BP / Game thread wrapper around FQuartzClockProxy (to talk to the underlying clock)

...and inherits from FQuartzTickableObject (to listen to the underlying clock)

It can subscribe to Quantized Event & Metronome delegates to synchronize gameplay & VFX to Quartz events fired from the Audio Engine

   
Name UQuartzClockHandle
Type class
Header File /Engine/Source/Runtime/AudioMixer/Public/Quartz/AudioMixerClockHandle.h
Include Path #include "Quartz/AudioMixerClockHandle.h"

Syntax

UCLASS (BlueprintType, Blueprintable, Transient, ClassGroup=Quartz,  
       Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UQuartzClockHandle :  
    public UObject ,  
    public FQuartzTickableObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UQuartzClockHandle()

 Ctor Quartz/AudioMixerClockHandle.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UQuartzClockHandle()

 Dtor Quartz/AudioMixerClockHandle.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentClockId FName   Quartz/AudioMixerClockHandle.h  
RawHandle Audio::FQuartzClockProxy   Quartz/AudioMixerClockHandle.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool DoesClockExist ( const UObject* WorldContextObject
) const

   Quartz/AudioMixerClockHandle.h  

float GetBeatProgressPercent ( EQuartzCommandQuantization QuantizationBoundary,
float PhaseOffset,
float MsOffset
)

 Returns the current progress until the next occurrence of the provided musical duration as a float value from 0 (previous beat) to 1 (next beat). Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(AutoCreateRefTerm="PhaseOffset", Keywords="BPM, Tempo")

float GetBeatsPerMinute ( const UObject* WorldContextObject
) const

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(WorldContext="WorldContextObject", AutoCreateRefTerm="InDelegate", Keywords="BPM, Tempo")

FName GetClockName()

   Quartz/AudioMixerClockHandle.h  

bool GetCurrentTickRate ( const UObject* WorldContextObject,
Audio::FQuartzClockTickRate& OutTickRate
) const

   Quartz/AudioMixerClockHandle.h  

FQuartzTransportTimeStamp GetCurrentTimestamp ( const UObject* WorldContextObject
)

 Retrieves a timestamp for the clock. Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock Handle"
  • Meta=(WorldContext="WorldContextObject")

float GetDurationOfQuantizationTypeInSeconds ( const UObject* WorldContextObject,
const EQuartzCommandQuantization& QuantizationType,
float Multiplier
)

 Returns the duration in seconds of the given Quantization Type Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject")

float GetEstimatedRunTime ( const UObject* WorldContextObject
)

 Returns the amount of time, in seconds, the clock has been running. Caution: due to latency, this will not be perfectly accurate. Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock Handle"
  • Meta=(WorldContext="WorldContextObject")

float GetMillisecondsPerTick ( const UObject* WorldContextObject
) const

 Metronome getters. Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(WorldContext="WorldContextObject", AutoCreateRefTerm="InDelegate", Keywords="BPM, Tempo")

float GetSecondsPerTick ( const UObject* WorldContextObject
) const

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(WorldContext="WorldContextObject", AutoCreateRefTerm="InDelegate", Keywords="BPM, Tempo")

float GetThirtySecondNotesPerMinute ( const UObject* WorldContextObject
) const

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(WorldContext="WorldContextObject", AutoCreateRefTerm="InDelegate", Keywords="BPM, Tempo")

float GetTicksPerSecond ( const UObject* WorldContextObject
) const

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(WorldContext="WorldContextObject", AutoCreateRefTerm="InDelegate", Keywords="BPM, Tempo")

bool IsClockRunning ( const UObject* WorldContextObject
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject", Keywords="Transport, Counter")

void NotifyOnQuantizationBoundary ( const UObject* WorldContextObject,
FQuartzQuantizationBoundary InQuantizationBoundary,
const FOnQuartzCommandEventBP& InDelegate,
float InMsOffset
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject", AutoCreateRefTerm="InDelegate", Keywords="Transport, Counter")

void PauseClock ( const UObject* WorldContextObject,
UQuartzClockHandle*& ClockHandle
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Subsystem"
  • Meta=(WorldContext="WorldContextObject")

virtual void ProcessCommand ( const Audio::FQuartzQuantizedCommandDelegateData& Data
)

   Quartz/AudioMixerClockHandle.h  

virtual void ProcessCommand ( const Audio::FQuartzMetronomeDelegateData& Data
)

   Quartz/AudioMixerClockHandle.h  

void QueueQuantizedSound ( const UObject* WorldContextObject,
UQuartzClockHandle*& ClockHandle,
const FAudioComponentCommandInfo& AudioComponentData,
const FOnQuartzCommandEventBP& InDelegate,
const FQuartzQuantizationBoundary& InTargetBoundary
)

 // Set how early we would like to receive Metronome (not yet supported) and "About To Start" Delegates. (all other command delegates will execute as normal) Quartz/AudioMixerClockHandle.h  

void ResetTransport ( const UObject* WorldContextObject,
const FOnQuartzCommandEventBP& InDelegate
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject", AutoCreateRefTerm="InDelegate", Keywords="Transport, Counter")

void ResetTransportQuantized ( const UObject* WorldContextObject,
FQuartzQuantizationBoundary InQuantizationBoundary,
const FOnQuartzCommandEventBP& InDelegate,
UQuartzClockHandle*& ClockHandle
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject", AutoCreateRefTerm="InDelegate", Keywords="Transport, Counter")

void ResumeClock ( const UObject* WorldContextObject,
UQuartzClockHandle*& ClockHandle
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject")

void SetBeatsPerMinute ( const UObject* WorldContextObject,
const FQuartzQuantizationBoundary& QuantizationBoundary,
const FOnQuartzCommandEventBP& Delegate,
UQuartzClockHandle*& ClockHandle,
float BeatsPerMinute
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay="QuantizationBoundary, Delegate", AutoCreateRefTerm="QuantizationBoundary, Delegate", Keywords="BPM, Tempo")

void SetMillisecondsPerTick ( const UObject* WorldContextObject,
const FQuartzQuantizationBoundary& QuantizationBoundary,
const FOnQuartzCommandEventBP& Delegate,
UQuartzClockHandle*& ClockHandle,
float MillisecondsPerTick
)

 Metronome Alteration (setters) Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay="QuantizationBoundary, Delegate", AutoCreateRefTerm="QuantizationBoundary, Delegate", Keywords="BPM, Tempo")

void SetSecondsPerTick ( const UObject* WorldContextObject,
const FQuartzQuantizationBoundary& QuantizationBoundary,
const FOnQuartzCommandEventBP& Delegate,
UQuartzClockHandle*& ClockHandle,
float SecondsPerTick
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay="QuantizationBoundary, Delegate", AutoCreateRefTerm="QuantizationBoundary, Delegate", Keywords="BPM, Tempo")

void SetThirtySecondNotesPerMinute ( const UObject* WorldContextObject,
const FQuartzQuantizationBoundary& QuantizationBoundary,
const FOnQuartzCommandEventBP& Delegate,
UQuartzClockHandle*& ClockHandle,
float ThirtySecondsNotesPerMinute
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay="QuantizationBoundary, Delegate", AutoCreateRefTerm="QuantizationBoundary, Delegate", Keywords="BPM, Tempo")

void SetTicksPerSecond ( const UObject* WorldContextObject,
const FQuartzQuantizationBoundary& QuantizationBoundary,
const FOnQuartzCommandEventBP& Delegate,
UQuartzClockHandle*& ClockHandle,
float TicksPerSecond
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quantization"
  • Meta=(WorldContext="WorldContextObject", AdvancedDisplay="QuantizationBoundary, Delegate", AutoCreateRefTerm="QuantizationBoundary, Delegate", Keywords="BPM, Tempo")

void StartClock ( const UObject* WorldContextObject,
UQuartzClockHandle*& ClockHandle
)

 Clock manipulation. Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject")

void StartOtherClock ( const UObject* WorldContextObject,
FName OtherClockName,
FQuartzQuantizationBoundary InQuantizationBoundary,
const FOnQuartzCommandEventBP& InDelegate
)

 "other" clock manipulation Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject", AutoCreateRefTerm="InDelegate", Keywords="Transport, Counter")

void StopClock ( const UObject* WorldContextObject,
bool CancelPendingEvents,
UQuartzClockHandle*& ClockHandle
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Subsystem"
  • Meta=(WorldContext="WorldContextObject")

void SubscribeToAllQuantizationEvents ( const UObject* WorldContextObject,
const FOnQuartzMetronomeEventBP& OnQuantizationEvent,
UQuartzClockHandle*& ClockHandle
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject")

UQuartzClockHandle * SubscribeToClock ( const UObject* WorldContextObject,
FName ClockName,
Audio::FQuartzClockProxy const* InHandlePtr
)

   Quartz/AudioMixerClockHandle.h  

void SubscribeToQuantizationEvent ( const UObject* WorldContextObject,
EQuartzCommandQuantization InQuantizationBoundary,
const FOnQuartzMetronomeEventBP& OnQuantizationEvent,
UQuartzClockHandle*& ClockHandle
)

 Metronome subscription. Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject")

void UnsubscribeFromAllTimeDivisions ( const UObject* WorldContextObject,
UQuartzClockHandle*& ClockHandle
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject")

void UnsubscribeFromTimeDivision ( const UObject* WorldContextObject,
EQuartzCommandQuantization InQuantizationBoundary,
UQuartzClockHandle*& ClockHandle
)

   Quartz/AudioMixerClockHandle.h
  • BlueprintCallable
  • Category="Quartz Clock"
  • Meta=(WorldContext="WorldContextObject")

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Quartz/AudioMixerClockHandle.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page