IQuartzQuantizedCommand

Base class for quantized commands. Virtual methods called by owning clock.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Sound/QuartzQuantizationUtilities.h

Include

#include "Sound/QuartzQuantizationUtilities.h"

Syntax

class IQuartzQuantizedCommand : public Audio::FQuartzCrossThreadMessage

Remarks

Base class for quantized commands. Virtual methods called by owning clock.

Constructors

Name Description

Public function

IQuartzQuantizedCommand()

Ctor

Destructors

Name Description

Public function Virtual

~IQuartzQuantizedCommand()

Dtor

Functions

Name Description

Public function

void

 

AboutToStart()

Called 2x Assumed thread latency before OnFinalCallback()

Protected function Virtual

void

 

AboutToStartCustom()

Public function

void

 

Cancel()

Called if the event is cancelled before OnFinalCallback() is called.

Protected function Virtual

void

 

CancelCustom()

Public function

void

 

FailedToQueue()

Perhaps the associated sound failed concurrency and will not be playing.

Protected function Virtual

void

 

FailedToQueueCustom()

Public function Const

FName

 

GetCommandName()

Public function Virtual Const

TSharedPtr< ...

 

GetDeepCopyOfDerivedObject()

Allocate a copy of the derived class

Public function Virtual

bool

 

IsClockAltering()

Public function Virtual

bool

 

IsLooping()

Public function

void

 

OnClockPaused()

Called if the owning clock gets stopped.

Protected function Virtual

void

 

OnClockPausedCustom()

Public function

void

 

OnClockStarted()

Called if the owning clock gets started.

Protected function Virtual

void

 

OnClockStartedCustom()

Public function

void

 

OnFinalCallback

(
    int32 InNumFramesLeft
)

Called on the final callback of this event boundary.

Protected function Virtual

void

 

OnFinalCallbackCustom

(
    int32 InNumFramesLeft
)

Public function

void

 

OnQueued

(
    const FQuartzQuantizedCommandInitIn...
)

Command has reached the AudioRenderThread.

Protected function Virtual

void

 

OnQueuedCustom

(
    const FQuartzQuantizedCommandInitIn...
)

Base classes can override these to add extra functionality

Public function Virtual Const

bool

 

RequiresAudioDevice()

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