UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UQuartzClockHandle Class Reference

#include <AudioMixerClockHandle.h>

+ Inheritance diagram for UQuartzClockHandle:

Public Member Functions

AUDIOMIXER_API UQuartzClockHandle ()
 
AUDIOMIXER_API ~UQuartzClockHandle ()
 
AUDIOMIXER_API void BeginDestroy () override
 
AUDIOMIXER_API void StartClock (const UObject *WorldContextObject, UQuartzClockHandle *&ClockHandle)
 
AUDIOMIXER_API void StopClock (const UObject *WorldContextObject, bool CancelPendingEvents, UQuartzClockHandle *&ClockHandle)
 
AUDIOMIXER_API void PauseClock (const UObject *WorldContextObject, UQuartzClockHandle *&ClockHandle)
 
AUDIOMIXER_API void ResumeClock (const UObject *WorldContextObject, UQuartzClockHandle *&ClockHandle)
 
AUDIOMIXER_API void ResetTransport (const UObject *WorldContextObject, const FOnQuartzCommandEventBP &InDelegate)
 
AUDIOMIXER_API void ResetTransportQuantized (const UObject *WorldContextObject, FQuartzQuantizationBoundary InQuantizationBoundary, const FOnQuartzCommandEventBP &InDelegate, UQuartzClockHandle *&ClockHandle)
 
AUDIOMIXER_API bool IsClockRunning (const UObject *WorldContextObject)
 
AUDIOMIXER_API void NotifyOnQuantizationBoundary (const UObject *WorldContextObject, FQuartzQuantizationBoundary InQuantizationBoundary, const FOnQuartzCommandEventBP &InDelegate, float InMsOffset=0.f)
 
AUDIOMIXER_API float GetDurationOfQuantizationTypeInSeconds (const UObject *WorldContextObject, const EQuartzCommandQuantization &QuantizationType, float Multiplier=1.0f)
 
AUDIOMIXER_API FQuartzTransportTimeStamp GetCurrentTimestamp (const UObject *WorldContextObject)
 
AUDIOMIXER_API float GetEstimatedRunTime (const UObject *WorldContextObject)
 
AUDIOMIXER_API void StartOtherClock (const UObject *WorldContextObject, FName OtherClockName, FQuartzQuantizationBoundary InQuantizationBoundary, const FOnQuartzCommandEventBP &InDelegate)
 
AUDIOMIXER_API void SubscribeToQuantizationEvent (const UObject *WorldContextObject, EQuartzCommandQuantization InQuantizationBoundary, const FOnQuartzMetronomeEventBP &OnQuantizationEvent, UQuartzClockHandle *&ClockHandle)
 
AUDIOMIXER_API void SubscribeToAllQuantizationEvents (const UObject *WorldContextObject, const FOnQuartzMetronomeEventBP &OnQuantizationEvent, UQuartzClockHandle *&ClockHandle)
 
AUDIOMIXER_API void UnsubscribeFromTimeDivision (const UObject *WorldContextObject, EQuartzCommandQuantization InQuantizationBoundary, UQuartzClockHandle *&ClockHandle)
 
AUDIOMIXER_API void UnsubscribeFromAllTimeDivisions (const UObject *WorldContextObject, UQuartzClockHandle *&ClockHandle)
 
AUDIOMIXER_API void SetMillisecondsPerTick (const UObject *WorldContextObject, UPARAM(ref) const FQuartzQuantizationBoundary &QuantizationBoundary, const FOnQuartzCommandEventBP &Delegate, UQuartzClockHandle *&ClockHandle, float MillisecondsPerTick=100.f)
 
AUDIOMIXER_API void SetTicksPerSecond (const UObject *WorldContextObject, UPARAM(ref) const FQuartzQuantizationBoundary &QuantizationBoundary, const FOnQuartzCommandEventBP &Delegate, UQuartzClockHandle *&ClockHandle, float TicksPerSecond=10.f)
 
AUDIOMIXER_API void SetSecondsPerTick (const UObject *WorldContextObject, UPARAM(ref) const FQuartzQuantizationBoundary &QuantizationBoundary, const FOnQuartzCommandEventBP &Delegate, UQuartzClockHandle *&ClockHandle, float SecondsPerTick=0.25f)
 
AUDIOMIXER_API void SetThirtySecondNotesPerMinute (const UObject *WorldContextObject, UPARAM(ref) const FQuartzQuantizationBoundary &QuantizationBoundary, const FOnQuartzCommandEventBP &Delegate, UQuartzClockHandle *&ClockHandle, float ThirtySecondsNotesPerMinute=960.f)
 
AUDIOMIXER_API void SetBeatsPerMinute (const UObject *WorldContextObject, UPARAM(ref) const FQuartzQuantizationBoundary &QuantizationBoundary, const FOnQuartzCommandEventBP &Delegate, UQuartzClockHandle *&ClockHandle, float BeatsPerMinute=60.f)
 
AUDIOMIXER_API float GetMillisecondsPerTick (const UObject *WorldContextObject) const
 
AUDIOMIXER_API float GetTicksPerSecond (const UObject *WorldContextObject) const
 
AUDIOMIXER_API float GetSecondsPerTick (const UObject *WorldContextObject) const
 
AUDIOMIXER_API float GetThirtySecondNotesPerMinute (const UObject *WorldContextObject) const
 
AUDIOMIXER_API float GetBeatsPerMinute (const UObject *WorldContextObject) const
 
AUDIOMIXER_API float GetBeatProgressPercent (EQuartzCommandQuantization QuantizationBoundary=EQuartzCommandQuantization::Beat, float PhaseOffset=0.f, float MsOffset=0.f)
 
AUDIOMIXER_API void QueueQuantizedSound (const UObject *WorldContextObject, UQuartzClockHandle *&ClockHandle, const FAudioComponentCommandInfo &AudioComponentData, const FOnQuartzCommandEventBP &InDelegate, const FQuartzQuantizationBoundary &InTargetBoundary)
 
AUDIOMIXER_API UQuartzClockHandleSubscribeToClock (const UObject *WorldContextObject, FName ClockName, Audio::FQuartzClockProxy const *InHandlePtr=nullptr)
 
FName GetClockName () const
 
bool DoesClockExist (const UObject *WorldContextObject) const
 
virtual void ProcessCommand (const Audio::FQuartzQuantizedCommandDelegateData &Data) override
 
virtual void ProcessCommand (const Audio::FQuartzMetronomeDelegateData &Data) override
 
AUDIOMIXER_API bool GetCurrentTickRate (const UObject *WorldContextObject, Audio::FQuartzClockTickRate &OutTickRate) const
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 
- Public Member Functions inherited from FQuartzTickableObject
UE_API FQuartzTickableObject ()
 
 FQuartzTickableObject (const FQuartzTickableObject &Other)=default
 
FQuartzTickableObjectoperator= (const FQuartzTickableObject &)=default
 
virtual UE_API ~FQuartzTickableObject () override
 
UE_API FQuartzTickableObjectInit (UWorld *InWorldPtr)
 
UE_API void QuartzTick (float DeltaTime)
 
UE_API bool QuartzIsTickable () const
 
UE_API void AddMetronomeBpDelegate (EQuartzCommandQuantization InQuantizationBoundary, const FOnQuartzMetronomeEventBP &OnQuantizationEvent)
 
bool IsInitialized () const
 
UE_API Audio::FQuartzGameThreadSubscriber GetQuartzSubscriber ()
 
UE_API int32 AddCommandDelegate (const FOnQuartzCommandEventBP &InDelegate)
 
void ExecCommand (const Audio::FQuartzQuantizedCommandDelegateData &Data)
 
void ExecCommand (const Audio::FQuartzMetronomeDelegateData &Data)
 
void ExecCommand (const Audio::FQuartzQueueCommandData &Data)
 
virtual UE_API void OnCommandEvent (const Audio::FQuartzQuantizedCommandDelegateData &Data) override
 
virtual UE_API void OnMetronomeEvent (const Audio::FQuartzMetronomeDelegateData &Data) override
 
virtual UE_API void OnQueueCommandEvent (const Audio::FQuartzQueueCommandData &Data) override
 
virtual void ProcessCommand (const Audio::FQuartzQueueCommandData &Data)
 
const Audio::FQuartzOffset & GetQuartzOffset () const
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 
- Protected Member Functions inherited from FQuartzTickableObject
UE_API void SetNotificationAnticipationAmountMilliseconds (const double Milliseconds)
 
UE_API void SetNotificationAnticipationAmountMusicalDuration (const EQuartzCommandQuantization Duration, const double Multiplier)
 
UE_API void QuartzUnsubscribe ()
 

Detailed Description

This class is a BP / Game thread wrapper around FQuartzClockProxy (to talk to the underlying clock)

...and inherits from FQuartzTickableObject (to listen to the underlying clock)

It can subscribe to Quantized Event & Metronome delegates to synchronize gameplay & VFX to Quartz events fired from the Audio Engine

Constructor & Destructor Documentation

◆ UQuartzClockHandle()

UQuartzClockHandle::UQuartzClockHandle ( )

◆ ~UQuartzClockHandle()

UQuartzClockHandle::~UQuartzClockHandle ( )

Member Function Documentation

◆ BeginDestroy()

void UQuartzClockHandle::BeginDestroy ( )
overridevirtual

Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

Reimplemented from UObject.

◆ DoesClockExist()

bool UQuartzClockHandle::DoesClockExist ( const UObject WorldContextObject) const
inline

◆ GetBeatProgressPercent()

float UQuartzClockHandle::GetBeatProgressPercent ( EQuartzCommandQuantization  QuantizationBoundary = EQuartzCommandQuantization::Beat,
float  PhaseOffset = 0.f,
float  MsOffset = 0.f 
)

Returns the current progress until the next occurrence of the provided musical duration as a float value from 0 (previous beat) to 1 (next beat). This is useful for indexing into curves to animate parameters to musical time. Ms and Phase offsets are combined internally.

◆ GetBeatsPerMinute()

float UQuartzClockHandle::GetBeatsPerMinute ( const UObject WorldContextObject) const

◆ GetClockName()

FName UQuartzClockHandle::GetClockName ( ) const
inline

◆ GetCurrentTickRate()

bool UQuartzClockHandle::GetCurrentTickRate ( const UObject WorldContextObject,
Audio::FQuartzClockTickRate &  OutTickRate 
) const

◆ GetCurrentTimestamp()

FQuartzTransportTimeStamp UQuartzClockHandle::GetCurrentTimestamp ( const UObject WorldContextObject)

◆ GetDurationOfQuantizationTypeInSeconds()

float UQuartzClockHandle::GetDurationOfQuantizationTypeInSeconds ( const UObject WorldContextObject,
const EQuartzCommandQuantization QuantizationType,
float  Multiplier = 1.0f 
)

Returns the duration in seconds of the given Quantization Type

Parameters
TheQuantization type to measure
Thequantity of the Quantization Type to calculate the time of
Returns
The duration, in seconds, of a multiplier amount of the Quantization Type, or -1 in the case the clock is invalid

◆ GetEstimatedRunTime()

float UQuartzClockHandle::GetEstimatedRunTime ( const UObject WorldContextObject)

◆ GetMillisecondsPerTick()

float UQuartzClockHandle::GetMillisecondsPerTick ( const UObject WorldContextObject) const

◆ GetSecondsPerTick()

float UQuartzClockHandle::GetSecondsPerTick ( const UObject WorldContextObject) const

◆ GetThirtySecondNotesPerMinute()

float UQuartzClockHandle::GetThirtySecondNotesPerMinute ( const UObject WorldContextObject) const

◆ GetTicksPerSecond()

float UQuartzClockHandle::GetTicksPerSecond ( const UObject WorldContextObject) const

◆ IsClockRunning()

bool UQuartzClockHandle::IsClockRunning ( const UObject WorldContextObject)

◆ NotifyOnQuantizationBoundary()

void UQuartzClockHandle::NotifyOnQuantizationBoundary ( const UObject WorldContextObject,
FQuartzQuantizationBoundary  InQuantizationBoundary,
const FOnQuartzCommandEventBP InDelegate,
float  InMsOffset = 0.f 
)

◆ PauseClock()

void UQuartzClockHandle::PauseClock ( const UObject WorldContextObject,
UQuartzClockHandle *&  ClockHandle 
)

◆ ProcessCommand() [1/2]

virtual void UQuartzClockHandle::ProcessCommand ( const Audio::FQuartzMetronomeDelegateData Data)
inlineoverridevirtual

Reimplemented from FQuartzTickableObject.

◆ ProcessCommand() [2/2]

virtual void UQuartzClockHandle::ProcessCommand ( const Audio::FQuartzQuantizedCommandDelegateData Data)
inlineoverridevirtual

Reimplemented from FQuartzTickableObject.

◆ QueueQuantizedSound()

void UQuartzClockHandle::QueueQuantizedSound ( const UObject WorldContextObject,
UQuartzClockHandle *&  ClockHandle,
const FAudioComponentCommandInfo AudioComponentData,
const FOnQuartzCommandEventBP InDelegate,
const FQuartzQuantizationBoundary InTargetBoundary 
)

◆ ResetTransport()

void UQuartzClockHandle::ResetTransport ( const UObject WorldContextObject,
const FOnQuartzCommandEventBP InDelegate 
)

◆ ResetTransportQuantized()

void UQuartzClockHandle::ResetTransportQuantized ( const UObject WorldContextObject,
FQuartzQuantizationBoundary  InQuantizationBoundary,
const FOnQuartzCommandEventBP InDelegate,
UQuartzClockHandle *&  ClockHandle 
)

◆ ResumeClock()

void UQuartzClockHandle::ResumeClock ( const UObject WorldContextObject,
UQuartzClockHandle *&  ClockHandle 
)

◆ SetBeatsPerMinute()

void UQuartzClockHandle::SetBeatsPerMinute ( const UObject WorldContextObject,
UPARAM(ref) const FQuartzQuantizationBoundary QuantizationBoundary,
const FOnQuartzCommandEventBP Delegate,
UQuartzClockHandle *&  ClockHandle,
float  BeatsPerMinute = 60.f 
)

◆ SetMillisecondsPerTick()

void UQuartzClockHandle::SetMillisecondsPerTick ( const UObject WorldContextObject,
UPARAM(ref) const FQuartzQuantizationBoundary QuantizationBoundary,
const FOnQuartzCommandEventBP Delegate,
UQuartzClockHandle *&  ClockHandle,
float  MillisecondsPerTick = 100.f 
)

◆ SetSecondsPerTick()

void UQuartzClockHandle::SetSecondsPerTick ( const UObject WorldContextObject,
UPARAM(ref) const FQuartzQuantizationBoundary QuantizationBoundary,
const FOnQuartzCommandEventBP Delegate,
UQuartzClockHandle *&  ClockHandle,
float  SecondsPerTick = 0.25f 
)

◆ SetThirtySecondNotesPerMinute()

void UQuartzClockHandle::SetThirtySecondNotesPerMinute ( const UObject WorldContextObject,
UPARAM(ref) const FQuartzQuantizationBoundary QuantizationBoundary,
const FOnQuartzCommandEventBP Delegate,
UQuartzClockHandle *&  ClockHandle,
float  ThirtySecondsNotesPerMinute = 960.f 
)

◆ SetTicksPerSecond()

void UQuartzClockHandle::SetTicksPerSecond ( const UObject WorldContextObject,
UPARAM(ref) const FQuartzQuantizationBoundary QuantizationBoundary,
const FOnQuartzCommandEventBP Delegate,
UQuartzClockHandle *&  ClockHandle,
float  TicksPerSecond = 10.f 
)

◆ StartClock()

void UQuartzClockHandle::StartClock ( const UObject WorldContextObject,
UQuartzClockHandle *&  ClockHandle 
)

◆ StartOtherClock()

void UQuartzClockHandle::StartOtherClock ( const UObject WorldContextObject,
FName  OtherClockName,
FQuartzQuantizationBoundary  InQuantizationBoundary,
const FOnQuartzCommandEventBP InDelegate 
)

◆ StopClock()

void UQuartzClockHandle::StopClock ( const UObject WorldContextObject,
bool  CancelPendingEvents,
UQuartzClockHandle *&  ClockHandle 
)

◆ SubscribeToAllQuantizationEvents()

void UQuartzClockHandle::SubscribeToAllQuantizationEvents ( const UObject WorldContextObject,
const FOnQuartzMetronomeEventBP OnQuantizationEvent,
UQuartzClockHandle *&  ClockHandle 
)

◆ SubscribeToClock()

UQuartzClockHandle * UQuartzClockHandle::SubscribeToClock ( const UObject WorldContextObject,
FName  ClockName,
Audio::FQuartzClockProxy const *  InHandlePtr = nullptr 
)

◆ SubscribeToQuantizationEvent()

void UQuartzClockHandle::SubscribeToQuantizationEvent ( const UObject WorldContextObject,
EQuartzCommandQuantization  InQuantizationBoundary,
const FOnQuartzMetronomeEventBP OnQuantizationEvent,
UQuartzClockHandle *&  ClockHandle 
)

◆ UnsubscribeFromAllTimeDivisions()

void UQuartzClockHandle::UnsubscribeFromAllTimeDivisions ( const UObject WorldContextObject,
UQuartzClockHandle *&  ClockHandle 
)

◆ UnsubscribeFromTimeDivision()

void UQuartzClockHandle::UnsubscribeFromTimeDivision ( const UObject WorldContextObject,
EQuartzCommandQuantization  InQuantizationBoundary,
UQuartzClockHandle *&  ClockHandle 
)

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