UQuartzClockHandle

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

Constructors

Name Description

Public function

UQuartzClockHandle()

Ctor

Destructors

Name Description

Public function

~UQuartzClockHandle()

Dtor

Functions

Name Description

Public function

int32

 

AddCommandDelegate

(
    const FOnQuartzCommandEventBP& InD...,
    TSharedPtr< Audio::FShareableQuartz...
)

Public function Const

bool

 

DoesClockExist

(
    const UObject* WorldContextObj...
)

Public function Const

float

 

GetBeatsPerMinute

(
    const UObject* WorldContextObj...
)

Public function Const

FName

 

GetClockName()

Public function

TSharedPtr< ...

 

GetCommandQueue()

Public function

float

 

GetDurationOfQuantizationTypeInSeconds

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

Returns the duration in seconds of the given Quantization Type

Public function Const

FName

 

GetHandleName()

Public function Const

float

 

GetMillisecondsPerTick

(
    const UObject* WorldContextObj...
)

Metronome getters.

Public function Const

UQuartzSubsy...

 

GetQuartzSubsystem()

Access to the associated QuartzSubsystem

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

UQuartzClock...

 

Init

(
    UWorld* InWorldPtr
)

Public function

bool

 

IsClockRunning

(
    const UObject* WorldContextObj...
)

Public function

void

 

PauseClock

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

Public function

void

 

ProcessCommand

Public function

void

 

ProcessCommand

Public function Const

bool

 

QuartzIsTickable()

Public function

void

 

QuartzTick

(
    float DeltaTime
)

Called by the associated QuartzSubsystem

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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss