1. Epic GamesDeveloper
  3. UQuartzClockHandle

UQuartzClockHandle

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

Unreal Engine C++ API Reference > Runtime > AudioMixer > Quartz

Inheritance Hierarchy

References

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

Syntax

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 Const bool

DoesClockExist ( const UObject* WorldContextObject
)

  
Public function 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 float

GetBeatsPerMinute ( const UObject* WorldContextObject
)

  
Public function Const FName  
Public function Const bool

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

  
Public function FQuartzTransportTimeStamp

GetCurrentTimestamp ( const UObject* WorldContextObject
)

 Retrieves a timestamp for the clock.
Public function float

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

 Returns the duration in seconds of the given Quantization Type
Public function 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 float

GetMillisecondsPerTick ( const UObject* WorldContextObject
)

 Metronome getters.
Public function Const float

GetSecondsPerTick ( const UObject* WorldContextObject
)

  
Public function Const float

GetThirtySecondNotesPerMinute ( const UObject* WorldContextObject
)

  
Public function Const float

GetTicksPerSecond ( const UObject* WorldContextObject
)

  
Public function bool

IsClockRunning ( const UObject* WorldContextObject
)

  
Public function void

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

  
Public function void

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

  
Public function void

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

 Void SetNotificationAnticipationAmountInMilliseconds(const UObject* WorldContextObject, UQuartzClockHandle*& ClockHandle, const double Milliseconds = 0.0);
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

 Metronome Alteration (setters)
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

 Clock manipulation.
Public function void

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

 "other" clock manipulation
Public function void

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

  
Public function 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 void

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

 Metronome subscription.
Public function void

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

  
Public function void

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

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.

Deprecated Functions

  Type Name Description
Public function Virtual void This function should not be called directly, and the original functionality has been moved into FQuartzTickable
Public function Virtual void This function should not be called directly, and the original functionality has been moved into FQuartzTickable

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page