UQuartzClockHandle

Choose your operating system:

Windows

macOS

Linux

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

Constructors

Name Description

Public function

UQuartzClockHandle()

Ctor

Destructors

Name Description

Public function

~UQuartzClockHandle()

Dtor

Functions

Name Description

Public function Const

bool

 

DoesClockExist

(
    const UObject* WorldContextObj...
)

Public function Const

float

 

GetBeatsPerMinute

(
    const UObject* WorldContextObj...
)

Public function Const

FName

 

GetClockName()

Public function Const

bool

 

GetCurrentTickRate

(
    const UObject* WorldContextObj...,
    Audio::FQuartzClockTickRate& OutTi...
)

Public function

FQuartzTrans...

 

GetCurrentTimestamp

(
    const UObject* WorldContextObj...
)

Retrieves a timestamp for the clock.

Public function

float

 

GetDurationOfQuantizationTypeInSeconds

(
    const UObject* WorldContextObj...,
    const EQuartzCommandQuantization& ...,
    float Multiplier
)

Returns the duration in seconds of the given Quantization Type

Public function

float

 

GetEstimatedRunTime

(
    const UObject* WorldContextObj...
)

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

FName

 

GetHandleName()

Public function Const

float

 

GetMillisecondsPerTick

(
    const UObject* WorldContextObj...
)

Metronome getters.

Public function Const

float

 

GetSecondsPerTick

(
    const UObject* WorldContextObj...
)

Public function Const

float

 

GetThirtySecondNotesPerMinute

(
    const UObject* WorldContextObj...
)

Public function Const

float

 

GetTicksPerSecond

(
    const UObject* WorldContextObj...
)

Public function

bool

 

IsClockRunning

(
    const UObject* WorldContextObj...
)

Public function

void

 

PauseClock

(
    const UObject* WorldContextObj...,
    UQuartzClockHandle*& ClockHand...
)

Public function

void

 

QueueQuantizedSound

(
    const UObject* WorldContextObj...,
    UQuartzClockHandle*& ClockHand...,
    const FAudioComponentCommandInfo& ...,
    const FOnQuartzCommandEventBP& InD...,
    const FQuartzQuantizationBoundary&...
)

Public function

void

 

ResetTransport

(
    const UObject* WorldContextObj...,
    const FOnQuartzCommandEventBP& InD...
)

Public function

void

 

ResetTransportQuantized

(
    const UObject* WorldContextObj...,
    FQuartzQuantizationBoundary InQuant...,
    const FOnQuartzCommandEventBP& InD...,
    UQuartzClockHandle*& ClockHand...
)

Public function

void

 

ResumeClock

(
    const UObject* WorldContextObj...,
    UQuartzClockHandle*& ClockHand...
)

Public function

void

 

SetBeatsPerMinute

(
    const UObject* WorldContextObj...,
    const FQuartzQuantizationBoundary&...,
    const FOnQuartzCommandEventBP& Del...,
    UQuartzClockHandle*& ClockHand...,
    float BeatsPerMinute
)

Public function

void

 

SetMillisecondsPerTick

(
    const UObject* WorldContextObj...,
    const FQuartzQuantizationBoundary&...,
    const FOnQuartzCommandEventBP& Del...,
    UQuartzClockHandle*& ClockHand...,
    float MillisecondsPerTick
)

Metronome Alteration (setters)

Public function

void

 

SetSecondsPerTick

(
    const UObject* WorldContextObj...,
    const FQuartzQuantizationBoundary&...,
    const FOnQuartzCommandEventBP& Del...,
    UQuartzClockHandle*& ClockHand...,
    float SecondsPerTick
)

Public function

void

 

SetThirtySecondNotesPerMinute

(
    const UObject* WorldContextObj...,
    const FQuartzQuantizationBoundary&...,
    const FOnQuartzCommandEventBP& Del...,
    UQuartzClockHandle*& ClockHand...,
    float ThirtySecondsNotesPerMinute
)

Public function

void

 

SetTicksPerSecond

(
    const UObject* WorldContextObj...,
    const FQuartzQuantizationBoundary&...,
    const FOnQuartzCommandEventBP& Del...,
    UQuartzClockHandle*& ClockHand...,
    float TicksPerSecond
)

Public function

void

 

StartClock

(
    const UObject* WorldContextObj...,
    UQuartzClockHandle*& ClockHand...
)

Clock manipulation.

Public function

void

 

StartOtherClock

(
    const UObject* WorldContextObj...,
    FName OtherClockName,
    FQuartzQuantizationBoundary InQuant...,
    const FOnQuartzCommandEventBP& InD...
)

"other" clock manipulation

Public function

void

 

StopClock

(
    const UObject* WorldContextObj...,
    bool CancelPendingEvents,
    UQuartzClockHandle*& ClockHand...
)

Public function

void

 

SubscribeToAllQuantizationEvents

(
    const UObject* WorldContextObj...,
    const FOnQuartzMetronomeEventBP& O...,
    UQuartzClockHandle*& ClockHand...
)

Public function

UQuartzClock...

 

SubscribeToClock

(
    const UObject* WorldContextObj...,
    FName ClockName
)

Public function

void

 

SubscribeToQuantizationEvent

(
    const UObject* WorldContextObj...,
    EQuartzCommandQuantization InQuanti...,
    const FOnQuartzMetronomeEventBP& O...,
    UQuartzClockHandle*& ClockHand...
)

Metronome subscription.

Public function

void

 

UnsubscribeFromAllTimeDivisions

(
    const UObject* WorldContextObj...,
    UQuartzClockHandle*& ClockHand...
)

Public function

void

 

UnsubscribeFromTimeDivision

(
    const UObject* WorldContextObj...,
    EQuartzCommandQuantization InQuanti...,
    UQuartzClockHandle*& ClockHand...
)

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Overridden from FQuartzTickableObject

Name Description

Public function Virtual

void

 

ProcessCommand

(
    const Audio::FQuartzQuantizedComman...
)

Public function Virtual

void

 

ProcessCommand

(
    const Audio::FQuartzMetronomeDelega...
)