1. Epic GamesDeveloper
  3. FQuartzClock

FQuartzClock

[FQuartzClock](API\Runtime\AudioMixer\Quartz\FQuartzClock): This class receives, schedules, and fires quantized commands.

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 FQuartzClock

Remarks

FQuartzClock: This class receives, schedules, and fires quantized commands. The underlying FQuartzMetronome handles all counting / timing logic.

This class gets ticked externally (i.e. by some Clock Manager) and counts down the time-to-fire the commands in audio frames.

UpdateCachedState() updates a game-thread copy of data accessed via FQuartzClockProxy (see FQuartzClockState)

Constructors

  Type Name Description
Public function  

FQuartzClock ( const FName& InName,
const FQuartzClockSettings& InClockSettings,
FQuartzClockManager* InOwningClockManagerPtr
)

 Ctor

Destructors

  Type Name Description
Public function   Dtor

Functions

  Type Name Description
Public function void

AddQuantizedCommand ( FQuartzQuantizedCommandInitInfo& InQuantizationCommandInitInfo
)

 Quantized Command Management:
Public function void

AddQuantizedCommand ( FQuartzQuantizedRequestData& InQuantizedRequestData
)

 Quantized Command Management:
Public function void  
Public function void

AddToTickDelay ( int32 NumFramesOfDelayToAdd
)

 (used for StartOtherClock command to handle the sub-tick as the target clock)
Public function bool  
Public function void

ChangeTickRate ( FQuartzClockTickRate InNewTickRate,
int32 NumFramesLeft
)

 Transport Control: alter the tick rate (take by-value to make sample-rate adjustments in-place)
Public function void

ChangeTimeSignature ( const FQuartzTimeSignature& InNewTimeSignature
)

  
Public function Const bool

DoesMatchSettings ( const FQuartzClockSettings& InClockSettings
)

  
Public function Const float

GetBeatProgressPercent ( const EQuartzCommandQuantization& QuantizationType
)

  
Public function FQuartzClockManager *  
Public function Const FQuartzClockCommandQueueWeakPtr  
Public function FQuartzTransportTimeStamp  
Public function float

GetDurationOfQuantizationTypeInSeconds ( const EQuartzCommandQuantization& QuantizationType,
float Multiplier
)

  
Public function float  
Public function FMixerDevice *  
Public function Const FName

GetName ()

  
Public function FMixerSourceManager *  
Public function FQuartzClockTickRate Getters:
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void

LowResolutionTick ( float InDeltaTimeSeconds
)

 Low-resolution clock update (not sample-accurate!, useful when running without an Audio Device)
Public function Const int32  
Public function void

Pause ()

  
Public function void  
Public function void

Restart ( bool bPause
)

  
Public function void

Resume ()

  
Public function void

SetSampleRate ( float InNewSampleRate
)

  
Public function void

SetTickDelay ( int32 NumFramesOfDelay
)

 (used for StartOtherClock command to handle the sub-tick as the target clock)
Public function void  
Public function void

Stop ( bool CancelPendingEvents
)

  
Public function void  
Public function void

SubscribeToTimeDivision ( FQuartzGameThreadSubscriber InSubscriber,
EQuartzCommandQuantization InQuantizationBoundary
)

 Metronome Event Subscription:
Public function void

Tick ( int32 InNumFramesUntilNextTick
)

 Sample accurate clock update
Public function void  
Public function void

UnsubscribeFromTimeDivision ( FQuartzGameThreadSubscriber InSubscriber,
EQuartzCommandQuantization InQuantizationBoundary
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page