1. Epic GamesDeveloper
  3. FQuartzClockProxy

FQuartzClockProxy

[FQuartzClockProxy](API\Runtime\AudioMixer\Quartz\FQuartzClockProxy): This class is a C++ handle to the underlying clock.

API > API/Runtime > API/Runtime/AudioMixer > API/Runtime/AudioMixer/Quartz

References

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

Syntax

class FQuartzClockProxy

Remarks

FQuartzClockProxy: This class is a C++ handle to the underlying clock.

It is mostly a wrapper around a TWeakPtr and TSharedPtr.

The getters query the underlying FQuartzClock directly, which returns values updated during the last audio-engine tick

If you need to add more getters, add copies of the members in question to FQuartzClock::FQuartzClockState and update FQuartzClock::UpdateCachedState() for thread-safe access (or manually protect access w/ CachedClockStateCritSec)

SendCommandToClock() can be used to execute lambdas at the beginning of the next clock tick. These lambdas can call FQuartzClock's public methods safely.

Your lambda will take an FQuartzClock* as an argument, which will be passed in by the FQuartzClock itself when it pumps the command queue.

Variables

  Type Name Description
Protected variable TWeakPtr< FQuartzClock, ESPMode::ThreadSafe > ClockWeakPtr  

Constructors

  Type Name Description
Public function   Ctor
Public function  

FQuartzClockProxy ( const FName& Name
)

  
Public function  

FQuartzClockProxy ( TSharedPtr< FQuartzClock, ESPMode::ThreadSafe > InClock
)

  

Functions

  Type Name Description
Public function Const bool  
Public function Const float

GetBeatProgressPercent ( const EQuartzCommandQuantization& QuantizationType
)

  
Public function Const FName  
Public function Const FQuartzTransportTimeStamp  
Public function Const float

GetDurationOfQuantizationTypeInSeconds ( const EQuartzCommandQuantization& QuantizationType,
float Multiplier
)

  
Public function Const float  
Public function Const Audio::FQuartzClockTickRate  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function bool

SendCommandToClock ( TFunction< void(FQuartzClock*)> InCommand
)

 Returns false if the clock is not valid or has shut down

Operators

  Type Name Description
Public function Const    
Public function Const   Implicit cast to underlying ID (FName)
Public function Const bool

operator== ( const FName& Name
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page