1. Epic GamesDeveloper
  3. UQuartzSubsystem

UQuartzSubsystem

API > API/Runtime > API/Runtime/AudioMixer > API/Runtime/AudioMixer/Quartz

Inheritance Hierarchy

  • UTickableWorldSubsystem
  • UQuartzSubsystem

References

   
Module AudioMixer
Header /Engine/Source/Runtime/AudioMixer/Public/Quartz/QuartzSubsystem.h
Include #include "Quartz/QuartzSubsystem.h"

Syntax

UCLASS (DisplayName="Quartz", MinimalAPI)  
class UQuartzSubsystem : public UTickableWorldSubsystem

Constructors

  Type Name Description
Public function   Ctor/dtor

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Allow an external clock (not ticked by the Audio Mixer or QuartzSubsystem) to be accessible via this subsystem
Public function Virtual void  
Public function UFunction BlueprintCallable, Category, Meta UQuartzClockHandle *

CreateNewClock ( const UObject* WorldContextObject,
FName ClockName,
FQuartzClockSettings InSettings,
bool bOverrideSettingsIfClockExists,
bool bUseAudioEngineClockManager
)

 Clock Creation create a new clock (or return handle if clock already exists)
Public function Static Audio::FQuartzQuantizedRequestData

CreateRequestDataForQuantizedNotify ( UQuartzClockHandle* InClockHandle,
const FQuartzQuantizationBoundary& InQuantizationBoundary,
const FOnQuartzCommandEventBP& InDelegate,
float InMsOffset
)

  
Public function Static Audio::FQuartzQuantizedRequestData

CreateRequestDataForSchedulePlaySound ( UQuartzClockHandle* InClockHandle,
const FOnQuartzCommandEventBP& InDelegate,
const FQuartzQuantizationBoundary& InQuantizationBoundary
)

  
Public function Static Audio::FQuartzQuantizedRequestData

CreateRequestDataForStartOtherClock ( UQuartzClockHandle* InClockHandle,
FName InClockToStart,
const FQuartzQuantizationBoundary& InQuantizationBoundary,
const FOnQuartzCommandEventBP& InDelegate
)

  
Public function Static Audio::FQuartzQuantizedRequestData

CreateRequestDataForTickRateChange ( UQuartzClockHandle* InClockHandle,
const FOnQuartzCommandEventBP& InDelegate,
const Audio::FQuartzClockTickRate& InNewTickRate,
const FQuartzQuantizationBoundary& InQuantizationBoundary
)

 Helper functions for initializing quantized command initialization struct (to consolidate eyesore)
Public function Static Audio::FQuartzQuantizedRequestData

CreateRequestDataForTransportReset ( UQuartzClockHandle* InClockHandle,
const FQuartzQuantizationBoundary& InQuantizationBoundary,
const FOnQuartzCommandEventBP& InDelegate
)

  
Public function Virtual void  
Public function UFunction BlueprintCallable, Category, Meta void

DeleteClockByHandle ( const UObject* WorldContextObject,
UPARAM(ref) UQuartzClockHandle*& InClockHandle
)

 Delete an existing clock given its clock handle
Public function UFunction BlueprintCallable, Category, Meta void

DeleteClockByName ( const UObject* WorldContextObject,
FName ClockName
)

 Delete an existing clock given its name
Public function UFunction BlueprintCallable, Category, Meta bool

DoesClockExist ( const UObject* WorldContextObject,
FName ClockName
)

 Returns true if the clock exists
Public function Virtual Const bool

DoesSupportWorldType ( EWorldType::Type WorldType
)

  
Public function Static UQuartzSubsystem *

Get ( const UWorld*const World
)

 Static methods
Public function UFunction BlueprintCallable, Category float Latency data (Audio Render Thread -> Game thread)
Public function UFunction BlueprintCallable, Category float  
Public function UFunction BlueprintCallable, Category float  
Public function UFunction BlueprintCallable, Category, Meta FQuartzTransportTimeStamp

GetCurrentClockTimestamp ( const UObject* WorldContextObject,
const FName& InClockName
)

 Retrieves a timestamp for the clock.
Public function UFunction BlueprintCallable, Category, Meta float

GetDurationOfQuantizationTypeInSeconds ( const UObject* WorldContextObject,
FName ClockName,
const EQuartzCommandQuantization& QuantizationType,
float Multiplier
)

 Returns the duration in seconds of the given Quantization Type.
Public function UFunction BlueprintCallable, Category, Meta float

GetEstimatedClockRunTime ( const UObject* WorldContextObject,
const FName& InClockName
)

 Returns the amount of time, in seconds, the clock has been running. Caution: due to latency, this will not be perfectly accurate.
Public function UFunction BlueprintCallable, Category, Meta float

GetGameThreadToAudioRenderThreadAverageLatency ( const UObject* WorldContextObject
)

 Latency data (Game thread -> Audio Render Thread)
Public function UFunction BlueprintCallable, Category, Meta float

GetGameThreadToAudioRenderThreadMaxLatency ( const UObject* WorldContextObject
)

  
Public function UFunction BlueprintCallable, Category, Meta float

GetGameThreadToAudioRenderThreadMinLatency ( const UObject* WorldContextObject
)

  
Public function UFunction BlueprintCallable, Category, Meta UQuartzClockHandle *

GetHandleForClock ( const UObject* WorldContextObject,
FName ClockName
)

 Get handle for existing clock
Public function Const Audio::FQuartzClockProxy

GetProxyForClock ( FName ClockName
)

 Get C++ handle (proxy) to a clock if it exists
Public function UFunction BlueprintCallable, Category, Meta float

GetRoundTripAverageLatency ( const UObject* WorldContextObject
)

 Latency data (Round trip)
Public function UFunction BlueprintCallable, Category, Meta float

GetRoundTripMaxLatency ( const UObject* WorldContextObject
)

  
Public function UFunction BlueprintCallable, Category, Meta float

GetRoundTripMinLatency ( const UObject* WorldContextObject
)

  
Public function Virtual Const TStatId  
Public function Const TWeakPtr< FQuartzTickableObjectsManager > Sharable to allow non-UObjects to un-subscribe if the Subsystem is going to outlive them
Public function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

  
Public function UFunction BlueprintCallable, Category, Meta bool

IsClockRunning ( const UObject* WorldContextObject,
FName ClockName
)

 Returns true if the clock is running
Public function UFunction BlueprintCallable, Category bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function UFunction BlueprintCallable, Category void

SetQuartzSubsystemTickableWhenPaused ( const bool bInTickableWhenPaused
)

  
Public function void

SubscribeToQuartzTick ( FQuartzTickableObject* InObjectToTick
)

 These calls are forwarded to the internal FQuartzTickableObjectsManager
Public function Virtual void

Tick ( float DeltaTime
)

  
Public function void

UnsubscribeFromQuartzTick ( FQuartzTickableObject* InObjectToTick
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page