UAtomQuartzSubsystem Class Reference

#include <AtomQuartzSubsystem.h>

Inheritance diagram for UAtomQuartzSubsystem:

Public Member Functions
	UAtomQuartzSubsystem ()=default
virtual	~UAtomQuartzSubsystem () override=default
CRI_API void	AddProxyForExternalClock (const Atom::FQuartzClockProxy &InProxy)
CRI_API virtual void	BeginDestroy () override
CRI_API UAtomQuartzClockHandle *	CreateNewClock (const UObject *WorldContextObject, FName ClockName, FQuartzClockSettings InSettings, bool bOverrideSettingsIfClockExists=false, bool bUseAtomAudioEngineClockManager=true)
virtual CRI_API void	Deinitialize () override
CRI_API void	DeleteClockByHandle (const UObject *WorldContextObject, UPARAM(ref) UAtomQuartzClockHandle *&InClockHandle)
CRI_API void	DeleteClockByName (const UObject *WorldContextObject, FName ClockName)
CRI_API bool	DoesClockExist (const UObject *WorldContextObject, FName ClockName)
virtual CRI_API bool	DoesSupportWorldType (EWorldType::Type WorldType) const override
CRI_API float	GetAtomRenderThreadToGameThreadAverageLatency ()
CRI_API float	GetAtomRenderThreadToGameThreadMaxLatency ()
CRI_API float	GetAtomRenderThreadToGameThreadMinLatency ()
CRI_API FQuartzTransportTimeStamp	GetCurrentClockTimestamp (const UObject *WorldContextObject, const FName &InClockName)
CRI_API float	GetDurationOfQuantizationTypeInSeconds (const UObject *WorldContextObject, FName ClockName, const EQuartzCommandQuantization &QuantizationType, float Multiplier=1.0f)
CRI_API float	GetEstimatedClockRunTime (const UObject *WorldContextObject, const FName &InClockName)
CRI_API float	GetGameThreadToAtomRenderThreadAverageLatency (const UObject *WorldContextObject)
CRI_API float	GetGameThreadToAtomRenderThreadMaxLatency (const UObject *WorldContextObject)
CRI_API float	GetGameThreadToAtomRenderThreadMinLatency (const UObject *WorldContextObject)
CRI_API UAtomQuartzClockHandle *	GetHandleForClock (const UObject *WorldContextObject, FName ClockName)
CRI_API Atom::FQuartzClockProxy	GetProxyForClock (FName ClockName) const
CRI_API float	GetRoundTripAverageLatency (const UObject *WorldContextObject)
CRI_API float	GetRoundTripMaxLatency (const UObject *WorldContextObject)
CRI_API float	GetRoundTripMinLatency (const UObject *WorldContextObject)
virtual CRI_API TStatId	GetStatId () const override
CRI_API TWeakPtr< FAtomQuartzTickableObjectsManager >	GetTickableObjectManager () const
virtual CRI_API void	Initialize (FSubsystemCollectionBase &Collection) override
CRI_API bool	IsClockRunning (const UObject *WorldContextObject, FName ClockName)
CRI_API bool	IsQuartzEnabled ()
virtual CRI_API bool	IsTickable () const override
virtual CRI_API bool	IsTickableWhenPaused () const override
CRI_API void	SetQuartzSubsystemTickableWhenPaused (const bool bInTickableWhenPaused)
CRI_API void	SubscribeToQuartzTick (FQuartzTickableObject *InObjectToTick)
virtual CRI_API void	Tick (float DeltaTime) override
CRI_API void	UnsubscribeFromQuartzTick (FQuartzTickableObject *InObjectToTick)

Static Public Member Functions
static CRI_API Atom::FQuartzQuantizedRequestData	CreateRequestDataForQuantizedNotify (UAtomQuartzClockHandle *InClockHandle, const FQuartzQuantizationBoundary &InQuantizationBoundary, const FOnQuartzCommandEventBP &InDelegate, float InMsOffset=0.f)
static CRI_API Atom::FQuartzQuantizedRequestData	CreateRequestDataForSchedulePlaySound (UAtomQuartzClockHandle *InClockHandle, const FOnQuartzCommandEventBP &InDelegate, const FQuartzQuantizationBoundary &InQuantizationBoundary)
static CRI_API Atom::FQuartzQuantizedRequestData	CreateRequestDataForStartOtherClock (UAtomQuartzClockHandle *InClockHandle, FName InClockToStart, const FQuartzQuantizationBoundary &InQuantizationBoundary, const FOnQuartzCommandEventBP &InDelegate)
static CRI_API Atom::FQuartzQuantizedRequestData	CreateRequestDataForTickRateChange (UAtomQuartzClockHandle *InClockHandle, const FOnQuartzCommandEventBP &InDelegate, const Audio::FQuartzClockTickRate &InNewTickRate, const FQuartzQuantizationBoundary &InQuantizationBoundary)
static CRI_API Atom::FQuartzQuantizedRequestData	CreateRequestDataForTransportReset (UAtomQuartzClockHandle *InClockHandle, const FQuartzQuantizationBoundary &InQuantizationBoundary, const FOnQuartzCommandEventBP &InDelegate)
static CRI_API UAtomQuartzSubsystem *	Get (const UWorld *const World)

Private Member Functions
CRI_API Atom::FQuartzClockProxy *	FindProxyByName (const FName &ClockName)
CRI_API Atom::FQuartzClockProxy const *	FindProxyByName (const FName &ClockName) const
CRI_API Atom::FQuartzClockManager *	GetClockManager (const UObject *WorldContextObject, bool bUseAtomAudioEngineClockManager=true)
CRI_API void	PruneStaleProxies ()

Static Private Member Functions
static CRI_API void	PruneStaleProxiesInternal (TArray< Atom::FQuartzClockProxy > &ContainerToPrune)

Private Attributes
bool	bTickEvenWhenPaused = false
TSharedPtr< Atom::FPersistentQuartzSubsystemData >	ClockManagerDataPtr { nullptr }
TSharedPtr< FAtomQuartzTickableObjectsManager >	TickableObjectManagerPtr { MakeShared<FAtomQuartzTickableObjectsManager>() }

Constructor & Destructor Documentation

UAtomQuartzSubsystem()

UAtomQuartzSubsystem::UAtomQuartzSubsystem ( )

default

~UAtomQuartzSubsystem()

virtual UAtomQuartzSubsystem::~UAtomQuartzSubsystem ( )

overridevirtualdefault

Member Function Documentation

AddProxyForExternalClock()

void UAtomQuartzSubsystem::AddProxyForExternalClock

(

const Atom::FQuartzClockProxy &

InProxy

)

BeginDestroy()

void UAtomQuartzSubsystem::BeginDestroy ( )

overridevirtual

CreateNewClock()

UAtomQuartzClockHandle * UAtomQuartzSubsystem::CreateNewClock	(	const UObject *	WorldContextObject,
		FName	ClockName,
		FQuartzClockSettings	InSettings,
		bool	bOverrideSettingsIfClockExists = false,
		bool	bUseAtomAudioEngineClockManager = true )

CreateRequestDataForQuantizedNotify()

Atom::FQuartzQuantizedRequestData UAtomQuartzSubsystem::CreateRequestDataForQuantizedNotify ( UAtomQuartzClockHandle * InClockHandle, const FQuartzQuantizationBoundary & InQuantizationBoundary, const FOnQuartzCommandEventBP & InDelegate, float InMsOffset = 0.f )

static

CreateRequestDataForSchedulePlaySound()

Atom::FQuartzQuantizedRequestData UAtomQuartzSubsystem::CreateRequestDataForSchedulePlaySound ( UAtomQuartzClockHandle * InClockHandle, const FOnQuartzCommandEventBP & InDelegate, const FQuartzQuantizationBoundary & InQuantizationBoundary )

static

CreateRequestDataForStartOtherClock()

Atom::FQuartzQuantizedRequestData UAtomQuartzSubsystem::CreateRequestDataForStartOtherClock ( UAtomQuartzClockHandle * InClockHandle, FName InClockToStart, const FQuartzQuantizationBoundary & InQuantizationBoundary, const FOnQuartzCommandEventBP & InDelegate )

static

CreateRequestDataForTickRateChange()

Atom::FQuartzQuantizedRequestData UAtomQuartzSubsystem::CreateRequestDataForTickRateChange ( UAtomQuartzClockHandle * InClockHandle, const FOnQuartzCommandEventBP & InDelegate, const Audio::FQuartzClockTickRate & InNewTickRate, const FQuartzQuantizationBoundary & InQuantizationBoundary )

static

CreateRequestDataForTransportReset()

Atom::FQuartzQuantizedRequestData UAtomQuartzSubsystem::CreateRequestDataForTransportReset ( UAtomQuartzClockHandle * InClockHandle, const FQuartzQuantizationBoundary & InQuantizationBoundary, const FOnQuartzCommandEventBP & InDelegate )

static

Deinitialize()

void UAtomQuartzSubsystem::Deinitialize ( )

overridevirtual

DeleteClockByHandle()

void UAtomQuartzSubsystem::DeleteClockByHandle	(	const UObject *	WorldContextObject,
		UPARAM(ref) UAtomQuartzClockHandle *&	InClockHandle )

DeleteClockByName()

void UAtomQuartzSubsystem::DeleteClockByName	(	const UObject *	WorldContextObject,
		FName	ClockName )

DoesClockExist()

bool UAtomQuartzSubsystem::DoesClockExist	(	const UObject *	WorldContextObject,
		FName	ClockName )

DoesSupportWorldType()

bool UAtomQuartzSubsystem::DoesSupportWorldType ( EWorldType::Type WorldType ) const

overridevirtual

FindProxyByName() [1/2]

Atom::FQuartzClockProxy * UAtomQuartzSubsystem::FindProxyByName ( const FName & ClockName )

private

FindProxyByName() [2/2]

Atom::FQuartzClockProxy const * UAtomQuartzSubsystem::FindProxyByName ( const FName & ClockName ) const

private

Get()

UAtomQuartzSubsystem * UAtomQuartzSubsystem::Get ( const UWorld *const World )

static

GetAtomRenderThreadToGameThreadAverageLatency()

float UAtomQuartzSubsystem::GetAtomRenderThreadToGameThreadAverageLatency

(

)

GetAtomRenderThreadToGameThreadMaxLatency()

float UAtomQuartzSubsystem::GetAtomRenderThreadToGameThreadMaxLatency

(

)

GetAtomRenderThreadToGameThreadMinLatency()

float UAtomQuartzSubsystem::GetAtomRenderThreadToGameThreadMinLatency

(

)

GetClockManager()

Atom::FQuartzClockManager * UAtomQuartzSubsystem::GetClockManager ( const UObject * WorldContextObject, bool bUseAtomAudioEngineClockManager = true )

private

GetCurrentClockTimestamp()

FQuartzTransportTimeStamp UAtomQuartzSubsystem::GetCurrentClockTimestamp	(	const UObject *	WorldContextObject,
		const FName &	InClockName )

GetDurationOfQuantizationTypeInSeconds()

float UAtomQuartzSubsystem::GetDurationOfQuantizationTypeInSeconds	(	const UObject *	WorldContextObject,
		FName	ClockName,
		const EQuartzCommandQuantization &	QuantizationType,
		float	Multiplier = 1.0f )

GetEstimatedClockRunTime()

float UAtomQuartzSubsystem::GetEstimatedClockRunTime	(	const UObject *	WorldContextObject,
		const FName &	InClockName )

GetGameThreadToAtomRenderThreadAverageLatency()

float UAtomQuartzSubsystem::GetGameThreadToAtomRenderThreadAverageLatency

(

const UObject *

WorldContextObject

)

GetGameThreadToAtomRenderThreadMaxLatency()

float UAtomQuartzSubsystem::GetGameThreadToAtomRenderThreadMaxLatency

(

const UObject *

WorldContextObject

)

GetGameThreadToAtomRenderThreadMinLatency()

float UAtomQuartzSubsystem::GetGameThreadToAtomRenderThreadMinLatency

(

const UObject *

WorldContextObject

)

GetHandleForClock()

UAtomQuartzClockHandle * UAtomQuartzSubsystem::GetHandleForClock	(	const UObject *	WorldContextObject,
		FName	ClockName )

GetProxyForClock()

Atom::FQuartzClockProxy UAtomQuartzSubsystem::GetProxyForClock

(

FName

ClockName

)

const

GetRoundTripAverageLatency()

float UAtomQuartzSubsystem::GetRoundTripAverageLatency

(

const UObject *

WorldContextObject

)

GetRoundTripMaxLatency()

float UAtomQuartzSubsystem::GetRoundTripMaxLatency

(

const UObject *

WorldContextObject

)

GetRoundTripMinLatency()

float UAtomQuartzSubsystem::GetRoundTripMinLatency

(

const UObject *

WorldContextObject

)

GetStatId()

TStatId UAtomQuartzSubsystem::GetStatId ( ) const

overridevirtual

GetTickableObjectManager()

TWeakPtr< FAtomQuartzTickableObjectsManager > UAtomQuartzSubsystem::GetTickableObjectManager

(

)

const

Initialize()

void UAtomQuartzSubsystem::Initialize ( FSubsystemCollectionBase & Collection )

overridevirtual

IsClockRunning()

bool UAtomQuartzSubsystem::IsClockRunning	(	const UObject *	WorldContextObject,
		FName	ClockName )

IsQuartzEnabled()

bool UAtomQuartzSubsystem::IsQuartzEnabled

(

)

IsTickable()

bool UAtomQuartzSubsystem::IsTickable ( ) const

overridevirtual

IsTickableWhenPaused()

bool UAtomQuartzSubsystem::IsTickableWhenPaused ( ) const

overridevirtual

PruneStaleProxies()

void UAtomQuartzSubsystem::PruneStaleProxies ( )

private

PruneStaleProxiesInternal()

void UAtomQuartzSubsystem::PruneStaleProxiesInternal ( TArray< Atom::FQuartzClockProxy > & ContainerToPrune )

staticprivate

SetQuartzSubsystemTickableWhenPaused()

void UAtomQuartzSubsystem::SetQuartzSubsystemTickableWhenPaused

(

const bool

bInTickableWhenPaused

)

SubscribeToQuartzTick()

void UAtomQuartzSubsystem::SubscribeToQuartzTick

(

FQuartzTickableObject *

InObjectToTick

)

Tick()

void UAtomQuartzSubsystem::Tick ( float DeltaTime )

overridevirtual

UnsubscribeFromQuartzTick()

void UAtomQuartzSubsystem::UnsubscribeFromQuartzTick

(

FQuartzTickableObject *

InObjectToTick

)

Member Data Documentation

bTickEvenWhenPaused

bool UAtomQuartzSubsystem::bTickEvenWhenPaused = false

private

ClockManagerDataPtr

TSharedPtr<Atom::FPersistentQuartzSubsystemData> UAtomQuartzSubsystem::ClockManagerDataPtr { nullptr }

private

TickableObjectManagerPtr

TSharedPtr<FAtomQuartzTickableObjectsManager> UAtomQuartzSubsystem::TickableObjectManagerPtr { MakeShared<FAtomQuartzTickableObjectsManager>() }

private

---

The documentation for this class was generated from the following files:

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/Mixer/Quartz/AtomQuartzSubsystem.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/Mixer/Quartz/AtomQuartzSubsystem.cpp