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 > API/Runtime/AudioMixer/Quartz

Inheritance Hierarchy

  • UObject
  • FQuartzTickableObject
  • UQuartzClockHandle

References

   
Module AudioMixer
Header /Engine/Source/Runtime/AudioMixer/Public/Quartz/AudioMixerClockHandle.h
Include #include "Quartz/AudioMixerClockHandle.h"

Syntax

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

Remarks

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

Constructors

  Type Name Description
Public function   Ctor

Destructors

  Type Name Description
Public function   Dtor

Functions

  Type Name Description
Public function void  
Public function Const bool

DoesClockExist ( const UObject* WorldContextObject
)

  
Public function UFunction BlueprintCallable, Category, Meta 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).
Public function Const UFunction BlueprintCallable, Category, Meta float

GetBeatsPerMinute ( const UObject* WorldContextObject
)

  
Public function Const FName  
Public function Const bool

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

  
Public function UFunction BlueprintCallable, Category, Meta FQuartzTransportTimeStamp

GetCurrentTimestamp ( const UObject* WorldContextObject
)

 Retrieves a timestamp for the clock.
Public function UFunction BlueprintCallable, Category, Meta float

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

 Returns the duration in seconds of the given Quantization Type
Public function UFunction BlueprintCallable, Category, Meta 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.
Public function Const UFunction BlueprintCallable, Category, Meta float

GetMillisecondsPerTick ( const UObject* WorldContextObject
)

 Metronome getters.
Public function Const UFunction BlueprintCallable, Category, Meta float

GetSecondsPerTick ( const UObject* WorldContextObject
)

  
Public function Const UFunction BlueprintCallable, Category, Meta float

GetThirtySecondNotesPerMinute ( const UObject* WorldContextObject
)

  
Public function Const UFunction BlueprintCallable, Category, Meta float

GetTicksPerSecond ( const UObject* WorldContextObject
)

  
Public function UFunction BlueprintCallable, Category, Meta bool

IsClockRunning ( const UObject* WorldContextObject
)

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function Virtual void

ProcessCommand ( const Audio::FQuartzQuantizedCommandDelegateData& Data
)

  
Public function Virtual void

ProcessCommand ( const Audio::FQuartzMetronomeDelegateData& Data
)

  
Public function 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)
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

 Metronome Alteration (setters)
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

 Clock manipulation.
Public function UFunction BlueprintCallable, Category, Meta void

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

 "other" clock manipulation
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UQuartzClockHandle *

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

 Metronome subscription.
Public function UFunction BlueprintCallable, Category, Meta void

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

  
Public function UFunction BlueprintCallable, Category, Meta void

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

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page