Navigation
API > API/Runtime > API/Runtime/Engine
Base class for quantized commands. Virtual methods called by owning clock.
| Name | IQuartzQuantizedCommand |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Sound/QuartzQuantizationUtilities.h |
| Include Path | #include "Sound/QuartzQuantizationUtilities.h" |
Syntax
class IQuartzQuantizedCommand : public Audio::FQuartzCrossThreadMessage
Inheritance Hierarchy
- FQuartzLatencyTimer → FQuartzCrossThreadMessage → IQuartzQuantizedCommand
Derived Classes
IQuartzQuantizedCommand derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IQuartzQuantizedCommand() |
Ctor | Sound/QuartzQuantizationUtilities.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IQuartzQuantizedCommand() |
Dtor | Sound/QuartzQuantizationUtilities.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GameThreadDelegateID | int32 | Sound/QuartzQuantizationUtilities.h | ||
| GameThreadSubscribers | TArray< FQuartzGameThreadSubscriber > | Sound/QuartzQuantizationUtilities.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AboutToStart() |
Called 2x Assumed thread latency before OnFinalCallback() | Sound/QuartzQuantizationUtilities.h | |
void AddSubscriber
(
FQuartzGameThreadSubscriber InSubscriber |
Sound/QuartzQuantizationUtilities.h | ||
void Cancel() |
Called if the event is cancelled before OnFinalCallback() is called. | Sound/QuartzQuantizationUtilities.h | |
void FailedToQueue
(
FQuartzQuantizedRequestData& InGameThreadData |
Perhaps the associated sound failed concurrency and will not be playing. | Sound/QuartzQuantizationUtilities.h | |
FName GetCommandName() |
Sound/QuartzQuantizationUtilities.h | ||
EQuartzCommandType GetCommandType() |
Sound/QuartzQuantizationUtilities.h | ||
virtual TSharedPtr< IQuartzQuantizedCommand > GetDeepCopyOfDerivedObject() |
Allocate a copy of the derived class | Sound/QuartzQuantizationUtilities.h | |
virtual bool IsClockAltering() |
Sound/QuartzQuantizationUtilities.h | ||
void OnClockPaused() |
Called if the owning clock gets stopped. | Sound/QuartzQuantizationUtilities.h | |
void OnClockStarted() |
Called if the owning clock gets started. | Sound/QuartzQuantizationUtilities.h | |
void OnFinalCallback
(
int32 InNumFramesLeft |
Called on the final callback of this event boundary. | Sound/QuartzQuantizationUtilities.h | |
void OnQueued
(
const FQuartzQuantizedCommandInitInfo& InCommandInitInfo |
Command has reached the AudioRenderThread. | Sound/QuartzQuantizationUtilities.h | |
void OnScheduled
(
const FQuartzClockTickRate& InTickRate |
Scheduled (finalize subscriber offsets) - called by FQuartzClock | Sound/QuartzQuantizationUtilities.h | |
virtual int32 OverrideFramesUntilExec
(
int32 NumFramesUntilExec |
Called if the event type uses an altered amount of frames. | Sound/QuartzQuantizationUtilities.h | |
virtual bool RequiresAudioDevice() |
Sound/QuartzQuantizationUtilities.h | ||
virtual bool ShouldDeadlineIgnoresBpmChanges() |
Sound/QuartzQuantizationUtilities.h | ||
void Update
(
int32 NumFramesUntilDeadline |
Called during FQuartzClock::Tick() to let us call AboutToStart at different times for different subscribers | Sound/QuartzQuantizationUtilities.h |