Audio::FQuartzClockManager Class Reference

#include <AudioMixerClockManager.h>

Inheritance diagram for Audio::FQuartzClockManager:

Public Member Functions
AUDIOMIXER_API	FQuartzClockManager (Audio::FMixerDevice *InOwner=nullptr)
AUDIOMIXER_API	~FQuartzClockManager ()
int32	GetNumClocks () const
AUDIOMIXER_API void	Update (int32 NumFramesUntilNextUpdate)
AUDIOMIXER_API void	UpdateClock (FName InClockToAdvance, int32 NumFramesToAdvance)
AUDIOMIXER_API void	LowResoultionUpdate (float DeltaTimeSeconds)
AUDIOMIXER_API FQuartzClockProxy	GetOrCreateClock (const FName &InClockName, const FQuartzClockSettings &InClockSettings, bool bOverrideTickRateIfClockExists=false)
AUDIOMIXER_API FQuartzClockProxy	GetClock (const FName &InClockName)
AUDIOMIXER_API bool	DoesClockExist (const FName &InClockName)
AUDIOMIXER_API bool	IsClockRunning (const FName &InClockName)
AUDIOMIXER_API float	GetDurationOfQuantizationTypeInSeconds (const FName &InClockName, const EQuartzCommandQuantization &QuantizationType, float Multiplier)
AUDIOMIXER_API FQuartzTransportTimeStamp	GetCurrentTimestamp (const FName &InClockName)
AUDIOMIXER_API float	GetEstimatedRunTime (const FName &InClockName)
AUDIOMIXER_API void	RemoveClock (const FName &InName, bool bForceSynchronous=false)
AUDIOMIXER_API FQuartzClockTickRate	GetTickRateForClock (const FName &InName)
AUDIOMIXER_API void	SetTickRateForClock (const FQuartzClockTickRate &InNewTickRate, const FName &InName)
AUDIOMIXER_API void	ResumeClock (const FName &InName, int32 NumFramesToDelayStart=0)
AUDIOMIXER_API void	StopClock (const FName &InName, bool CancelPendingEvents)
AUDIOMIXER_API void	PauseClock (const FName &InName)
AUDIOMIXER_API void	Flush ()
AUDIOMIXER_API void	Shutdown ()
AUDIOMIXER_API FQuartzQuantizedCommandHandle	AddCommandToClock (FQuartzQuantizedCommandInitInfo &InQuantizationCommandInitInfo)
AUDIOMIXER_API void	SubscribeToTimeDivision (FName InClockName, MetronomeCommandQueuePtr InListenerQueue, EQuartzCommandQuantization InQuantizationBoundary)
AUDIOMIXER_API void	SubscribeToAllTimeDivisions (FName InClockName, MetronomeCommandQueuePtr InListenerQueue)
AUDIOMIXER_API void	UnsubscribeFromTimeDivision (FName InClockName, MetronomeCommandQueuePtr InListenerQueue, EQuartzCommandQuantization InQuantizationBoundary)
AUDIOMIXER_API void	UnsubscribeFromAllTimeDivisions (FName InClockName, MetronomeCommandQueuePtr InListenerQueue)
AUDIOMIXER_API bool	CancelCommandOnClock (FName InOwningClockName, TSharedPtr< IQuartzQuantizedCommand > InCommandPtr)
AUDIOMIXER_API bool	HasClockBeenTickedThisUpdate (FName InClockName)
int32	GetLastUpdateSizeInFrames () const
AUDIOMIXER_API FMixerDevice *	GetMixerDevice () const
Public Member Functions inherited from FQuartLatencyTracker
ENGINE_API	FQuartLatencyTracker ()
ENGINE_API void	PushLatencyTrackerResult (const double &InResult)
ENGINE_API float	GetLifetimeAverageLatency ()
ENGINE_API float	GetMinLatency ()
ENGINE_API float	GetMaxLatency ()

Friends
void	FQuartzClock::AddQuantizedCommand (FQuartzQuantizedCommandInitInfo &InQuantizationCommandInitInfo)

Constructor & Destructor Documentation

FQuartzClockManager()

Audio::FQuartzClockManager::FQuartzClockManager

(

Audio::FMixerDevice *

InOwner = nullptr

)

~FQuartzClockManager()

Audio::FQuartzClockManager::~FQuartzClockManager

(

)

Member Function Documentation

AddCommandToClock()

FQuartzQuantizedCommandHandle Audio::FQuartzClockManager::AddCommandToClock

(

FQuartzQuantizedCommandInitInfo &

InQuantizationCommandInitInfo

)

CancelCommandOnClock()

bool Audio::FQuartzClockManager::CancelCommandOnClock	(	FName	InOwningClockName,
		TSharedPtr< IQuartzQuantizedCommand >	InCommandPtr
	)

DoesClockExist()

bool Audio::FQuartzClockManager::DoesClockExist

(

const FName &

InClockName

)

Flush()

void Audio::FQuartzClockManager::Flush

(

)

GetClock()

FQuartzClockProxy Audio::FQuartzClockManager::GetClock

(

const FName &

InClockName

)

GetCurrentTimestamp()

FQuartzTransportTimeStamp Audio::FQuartzClockManager::GetCurrentTimestamp

(

const FName &

InClockName

)

GetDurationOfQuantizationTypeInSeconds()

float Audio::FQuartzClockManager::GetDurationOfQuantizationTypeInSeconds	(	const FName &	InClockName,
		const EQuartzCommandQuantization &	QuantizationType,
		float	Multiplier
	)

GetEstimatedRunTime()

float Audio::FQuartzClockManager::GetEstimatedRunTime

(

const FName &

InClockName

)

GetLastUpdateSizeInFrames()

int32 Audio::FQuartzClockManager::GetLastUpdateSizeInFrames ( ) const

inline

GetMixerDevice()

FMixerDevice * Audio::FQuartzClockManager::GetMixerDevice

(

)

const

GetNumClocks()

int32 Audio::FQuartzClockManager::GetNumClocks ( ) const

inline

GetOrCreateClock()

FQuartzClockProxy Audio::FQuartzClockManager::GetOrCreateClock	(	const FName &	InClockName,
		const FQuartzClockSettings &	InClockSettings,
		bool	bOverrideTickRateIfClockExists = false
	)

GetTickRateForClock()

FQuartzClockTickRate Audio::FQuartzClockManager::GetTickRateForClock

(

const FName &

InName

)

HasClockBeenTickedThisUpdate()

bool Audio::FQuartzClockManager::HasClockBeenTickedThisUpdate

(

FName

InClockName

)

IsClockRunning()

bool Audio::FQuartzClockManager::IsClockRunning

(

const FName &

InClockName

)

LowResoultionUpdate()

void Audio::FQuartzClockManager::LowResoultionUpdate

(

float

DeltaTimeSeconds

)

PauseClock()

void Audio::FQuartzClockManager::PauseClock

(

const FName &

InName

)

RemoveClock()

void Audio::FQuartzClockManager::RemoveClock	(	const FName &	InName,
		bool	bForceSynchronous = false
	)

ResumeClock()

void Audio::FQuartzClockManager::ResumeClock	(	const FName &	InName,
		int32	NumFramesToDelayStart = 0
	)

SetTickRateForClock()

void Audio::FQuartzClockManager::SetTickRateForClock	(	const FQuartzClockTickRate &	InNewTickRate,
		const FName &	InName
	)

Shutdown()

void Audio::FQuartzClockManager::Shutdown

(

)

StopClock()

void Audio::FQuartzClockManager::StopClock	(	const FName &	InName,
		bool	CancelPendingEvents
	)

SubscribeToAllTimeDivisions()

void Audio::FQuartzClockManager::SubscribeToAllTimeDivisions	(	FName	InClockName,
		MetronomeCommandQueuePtr	InListenerQueue
	)

SubscribeToTimeDivision()

void Audio::FQuartzClockManager::SubscribeToTimeDivision	(	FName	InClockName,
		MetronomeCommandQueuePtr	InListenerQueue,
		EQuartzCommandQuantization	InQuantizationBoundary
	)

UnsubscribeFromAllTimeDivisions()

void Audio::FQuartzClockManager::UnsubscribeFromAllTimeDivisions	(	FName	InClockName,
		MetronomeCommandQueuePtr	InListenerQueue
	)

UnsubscribeFromTimeDivision()

void Audio::FQuartzClockManager::UnsubscribeFromTimeDivision	(	FName	InClockName,
		MetronomeCommandQueuePtr	InListenerQueue,
		EQuartzCommandQuantization	InQuantizationBoundary
	)

Update()

void Audio::FQuartzClockManager::Update

(

int32

NumFramesUntilNextUpdate

)

UpdateClock()

void Audio::FQuartzClockManager::UpdateClock	(	FName	InClockToAdvance,
		int32	NumFramesToAdvance
	)

Friends And Related Symbol Documentation

FQuartzClock::AddQuantizedCommand

void FQuartzClock::AddQuantizedCommand ( FQuartzQuantizedCommandInitInfo &  InQuantizationCommandInitInfo )

friend

---

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

• Engine/Source/Runtime/AudioMixer/Public/Quartz/AudioMixerClockManager.h
• Engine/Source/Runtime/AudioMixer/Private/Quartz/AudioMixerClockManager.cpp