FQuartzTickableObject | Unreal Engine 5.2 Documentation

Inheritance Hierarchy


Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Sound/QuartzSubscription.h
Include	#include "Sound/QuartzSubscription.h"

class FQuartzTickableObject

FQuartzTickableObjectThis is the base class for non-Audio Render Thread objects that want to receive callbacks for Quartz events.

It is a wrapper around TQuartzShareableCommandQueue. (see UQuartzClockHandle or UAudioComponent as implementation examples)

	Type	Name	Description
		FQuartzTickableObject ()	Ctor
	PRAGMA_DISABLE_DEPRECATION_WARNINGS	FQuartzTickableObject ( const FQuartzTickableObject& Other )	Explicitly defaulted ctors (to disable deprecation warnings in compiler-generated functions)

	Type	Name	Description
		~FQuartzTickableObject ()	Dtor

Type	Name	Description
int32	AddCommandDelegate ( const FOnQuartzCommandEventBP& InDelegate )
void	AddMetronomeBpDelegate ( EQuartzCommandQuantization InQuantizationBoundary, const FOnQuartzMetronomeEventBP& OnQuantizationEvent )
void	ExecCommand ( const Audio::FQuartzQueueCommandData& Data )	Required by TQuartzShareableCommandQueue template
void	ExecCommand ( const Audio::FQuartzMetronomeDelegateData& Data )	Required by TQuartzShareableCommandQueue template
void	ExecCommand ( const Audio::FQuartzQuantizedCommandDelegateData& Data )	Required by TQuartzShareableCommandQueue template
const Audio::FQuartzOffset &	GetQuartzOffset ()
Audio::FQuartzGameThreadSubscriber	GetQuartzSubscriber ()
FQuartzTickableObject *	Init ( UWorld* InWorldPtr )
bool	IsInitialized ()
void	ProcessCommand ( const Audio::FQuartzQuantizedCommandDelegateData& Data )	Virtual interface (ExecCommand will forward the data to derived classes' ProcessCommand() call)
void	ProcessCommand ( const Audio::FQuartzQueueCommandData& Data )
void	ProcessCommand ( const Audio::FQuartzMetronomeDelegateData& Data )
bool	QuartzIsTickable ()
void	QuartzTick ( float DeltaTime )	Called by the associated QuartzSubsystem
void	QuartzUnsubscribe ()
void	SetNotificationAnticipationAmountMilliseconds ( const double Milliseconds )
void	SetNotificationAnticipationAmountMusicalDuration ( const EQuartzCommandQuantization Duration, const double Multiplier )

	Type	Name	Description
	FQuartzTickableObject &	operator= ( const FQuartzTickableObject& )

	Type	Name	Description
	TSharedPtr< Audio::TQuartzShareableCommandQueue< FQuartzTickableObject >, ESPMode::ThreadSafe >	CommandQueuePtr	FQuartzTickableObject::CommandQueuePtr should no longer be accessed directly. (This member will be private in a future engine version). Use GetQuartzSubscriber() instead

Type	Name	Description
int32	AddCommandDelegate ( const FOnQuartzCommandEventBP& InDelegate, TArray< FQuartzGameThreadCommandQueuePtr >& TargetSubscriberArray )	use FQuartzTickableObject::AddCommandDelegate(const FOnQuartzCommandEventBP& InDelegate) insead
UQuartzSubsystem *	GetQuartzSubsystem ()	This object no longer holds any UObject references. Caller should have their own UWorld* and use static 'UQuartzSubsystem::Get()' instead.
UWorld *	QuartzGetWorld ()	Derived classes should have access to their own UWorld, this function will always return null