Navigation
API > API/Runtime > API/Runtime/AudioMixer
FQuartzClockProxy: This class is a C++ handle to the underlying clock.
It is mostly a wrapper around a TWeakPtr
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.
| Name | FQuartzClockProxy |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioMixer/Public/Quartz/AudioMixerClock.h |
| Include Path | #include "Quartz/AudioMixerClock.h" |
Syntax
class FQuartzClockProxy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Ctor | Quartz/AudioMixerClock.h | ||
FQuartzClockProxy
(
const FName& Name |
Quartz/AudioMixerClock.h | ||
FQuartzClockProxy
(
TSharedPtr< FQuartzClock, ESPMode::ThreadSafe > InClock |
Quartz/AudioMixerClock.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClockId | FName | Quartz/AudioMixerClock.h | ||
| SharedQueue | FQuartzClockCommandQueueWeakPtr | Quartz/AudioMixerClock.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool DoesClockExist() |
Quartz/AudioMixerClock.h | ||
float GetBeatProgressPercent
(
const EQuartzCommandQuantization& QuantizationType |
Quartz/AudioMixerClock.h | ||
FName GetClockName() |
Quartz/AudioMixerClock.h | ||
FQuartzTransportTimeStamp GetCurrentClockTimestamp() |
Quartz/AudioMixerClock.h | ||
float GetDurationOfQuantizationTypeInSeconds
(
const EQuartzCommandQuantization& QuantizationType, |
Quartz/AudioMixerClock.h | ||
float GetEstimatedClockRunTimeSeconds() |
Quartz/AudioMixerClock.h | ||
Audio::FQuartzClockTickRate GetTickRate() |
Quartz/AudioMixerClock.h | ||
bool IsClockRunning() |
Quartz/AudioMixerClock.h | ||
bool IsValid() |
Quartz/AudioMixerClock.h | ||
bool SendCommandToClock
(
TFunction< void(FQuartzClock*)> InCommand |
Returns false if the clock is not valid or has shut down | Quartz/AudioMixerClock.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
Quartz/AudioMixerClock.h | ||
operator const FName &() |
Implicit cast to underlying ID (FName) | Quartz/AudioMixerClock.h | |
bool operator==
(
const FName& Name |
Quartz/AudioMixerClock.h |