Navigation
API > API/Runtime > API/Runtime/AudioMixer
Class to track the passage of musical time, and allow subscribers to be notified when these musical events take place.
| Name | FQuartzMetronome |
| Type | class |
| Header File | /Engine/Source/Runtime/AudioMixer/Public/Quartz/QuartzMetronome.h |
| Include Path | #include "Quartz/QuartzMetronome.h" |
Syntax
class FQuartzMetronome
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FQuartzMetronome
(
FName InClockName |
Ctor | Quartz/QuartzMetronome.h | |
FQuartzMetronome
(
const FQuartzTimeSignature& InTimeSignature, |
Quartz/QuartzMetronome.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FQuartzMetronome() |
Dtor | Quartz/QuartzMetronome.h |
Structs
| Name | Remarks |
|---|---|
| FFramesInTimeValue | Wrapper around our array so it can be indexed into by different Enums that represent musical time |
| FMetronomeEventEntry | |
| FPendingMetronomeEvents |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClockName | FName | Quartz/QuartzMetronome.h | ||
| CurrentTickRate | FQuartzClockTickRate | Quartz/QuartzMetronome.h | ||
| CurrentTimeSignature | FQuartzTimeSignature | Quartz/QuartzMetronome.h | ||
| CurrentTimeStamp | FQuartzTransportTimeStamp | Quartz/QuartzMetronome.h | ||
| FramesLeftInMusicalDuration | FFramesInTimeValue | Array of the number of audio frames left until the respective musical duration | Quartz/QuartzMetronome.h | |
| LastFramesOfLatency | int32 | Quartz/QuartzMetronome.h | ||
| LastTickCpuCycles64 | uint64 | Quartz/QuartzMetronome.h | ||
| ListenerFlags | int32 | Quartz/QuartzMetronome.h | ||
| MetronomeSubscriptionMatrix | TArray< MetronomeCommandQueuePtr > | Quartz/QuartzMetronome.h | ||
| MusicalDurationsInFrames | FFramesInTimeValue | Array of lengths of musical durations (in audio frames) | Quartz/QuartzMetronome.h | |
| PendingMetronomeEvents | Audio::FQuartzMetronome::FPendingMetronomeEvents | Quartz/QuartzMetronome.h | ||
| PulseDurationIndex | int32 | The index of the active pulse duration override | Quartz/QuartzMetronome.h | |
| PulseDurations | TArray< double > | Optional array of pulse duration overrides (for odd meters) | Quartz/QuartzMetronome.h | |
| TimeSinceStart | double | Keeps track of time in seconds since the Clock was last reset. | Quartz/QuartzMetronome.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CalculateDurationPhases
(
float(&) OutPhases |
Quartz/QuartzMetronome.h | ||
double GetFramesUntilBoundary
(
FQuartzQuantizationBoundary InQuantizationBoundary |
Quartz/QuartzMetronome.h | ||
uint64 GetLastTickCpuCycles64() |
Quartz/QuartzMetronome.h | ||
const FQuartzClockTickRate & GetTickRate() |
Getters. | Quartz/QuartzMetronome.h | |
const FQuartzTimeSignature & GetTimeSignature() |
Quartz/QuartzMetronome.h | ||
double GetTimeSinceStart() |
Quartz/QuartzMetronome.h | ||
FQuartzTransportTimeStamp GetTimeStamp() |
Quartz/QuartzMetronome.h | ||
void ResetTransport() |
Quartz/QuartzMetronome.h | ||
void SetSampleRate
(
float InNewSampleRate |
Quartz/QuartzMetronome.h | ||
void SetTickRate
(
FQuartzClockTickRate InNewTickRate, |
Quartz/QuartzMetronome.h | ||
void SetTimeSignature
(
const FQuartzTimeSignature& InNewTimeSignature |
Quartz/QuartzMetronome.h | ||
void SubscribeToAllTimeDivisions
(
MetronomeCommandQueuePtr InListenerQueue |
Quartz/QuartzMetronome.h | ||
void SubscribeToTimeDivision
(
MetronomeCommandQueuePtr InListenerQueue, |
Event Subscription. | Quartz/QuartzMetronome.h | |
void Tick
(
int32 InNumSamples, |
Transport Control: | Quartz/QuartzMetronome.h | |
void UnsubscribeFromAllTimeDivisions
(
MetronomeCommandQueuePtr InListenerQueue |
Quartz/QuartzMetronome.h | ||
void UnsubscribeFromTimeDivision
(
MetronomeCommandQueuePtr InListenerQueue, |
Quartz/QuartzMetronome.h |