Atom Quartz

Functions
SetQuartzSubsystemTickableWhenPaused
IsQuartzEnabled
IsClockRunning
GetRoundTripMinLatency
GetRoundTripMaxLatency
GetRoundTripAverageLatency
GetHandleForClock
GetGameThreadToAtomRenderThreadMinLatency
GetGameThreadToAtomRenderThreadMaxLatency
GetGameThreadToAtomRenderThreadAverageLatency
GetEstimatedClockRunTime
GetDurationOfQuantizationTypeInSeconds
GetCurrentClockTimestamp
GetAtomRenderThreadToGameThreadMinLatency
GetAtomRenderThreadToGameThreadMaxLatency
GetAtomRenderThreadToGameThreadAverageLatency
DoesClockExist
DeleteClockByName
DeleteClockByHandle
CreateNewClock

---

AtomQuartzSubsystem SetQuartzSubsystemTickableWhenPaused

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

SetQuartzSubsystemTickableWhenPaused

Set Quartz Subsystem Tickable when Paused

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target
Boolean	In Tickable when Paused

Outputs

Type	Name	Description
Exec	Out

AtomQuartzSubsystem IsQuartzEnabled

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

IsQuartzEnabled

Is Quartz Enabled

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target

Outputs

Type	Name	Description
Exec	Out
Boolean	Return Value

AtomQuartzSubsystem IsClockRunning

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

IsClockRunning

returns true if the clock is running

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target
Name	Clock Name

Outputs

Type	Name	Description
Exec	Out
Boolean	Return Value

AtomQuartzSubsystem GetRoundTripMinLatency

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetRoundTripMinLatency

Get Round Trip Min Latency

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem GetRoundTripMaxLatency

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetRoundTripMaxLatency

Get Round Trip Max Latency

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem GetRoundTripAverageLatency

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetRoundTripAverageLatency

latency data (Round trip)

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem GetHandleForClock

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetHandleForClock

get handle for existing clock

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target
Name	Clock Name

Outputs

Type	Name	Description
Exec	Out
Atom Quartz Clock Handle Object Reference	Return Value

AtomQuartzSubsystem GetGameThreadToAtomRenderThreadMinLatency

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetGameThreadToAtomRenderThreadMinLatency

Get Game Thread to Atom Render Thread Min Latency

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem GetGameThreadToAtomRenderThreadMaxLatency

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetGameThreadToAtomRenderThreadMaxLatency

Get Game Thread to Atom Render Thread Max Latency

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem GetGameThreadToAtomRenderThreadAverageLatency

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetGameThreadToAtomRenderThreadAverageLatency

latency data (Game thread -> Audio Render Thread)

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem GetEstimatedClockRunTime

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetEstimatedClockRunTime

Returns the amount of time, in seconds, the clock has been running. Caution: due to latency, this will not be perfectly accurate

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target
Name (by ref)	In Clock Name

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem GetDurationOfQuantizationTypeInSeconds

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetDurationOfQuantizationTypeInSeconds

Returns the duration in seconds of the given Quantization Type

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target
Name	Clock Name
EQuartzCommandQuantization Enum (by ref)	Quantization Type
Float (single-precision)	Multiplier

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem GetCurrentClockTimestamp

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetCurrentClockTimestamp

Retrieves a timestamp for the clock

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target
Name (by ref)	In Clock Name

Outputs

Type	Name	Description
Exec	Out
Quartz Transport Time Stamp Structure	Return Value

AtomQuartzSubsystem GetAtomRenderThreadToGameThreadMinLatency

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetAtomRenderThreadToGameThreadMinLatency

Get Atom Render Thread to Game Thread Min Latency

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem GetAtomRenderThreadToGameThreadMaxLatency

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetAtomRenderThreadToGameThreadMaxLatency

Get Atom Render Thread to Game Thread Max Latency

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem GetAtomRenderThreadToGameThreadAverageLatency

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

GetAtomRenderThreadToGameThreadAverageLatency

latency data (Audio Render Thread -> Game thread)

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target

Outputs

Type	Name	Description
Exec	Out
Float (single-precision)	Return Value

AtomQuartzSubsystem DoesClockExist

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

DoesClockExist

returns true if the clock exists

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target
Name	Clock Name

Outputs

Type	Name	Description
Exec	Out
Boolean	Return Value

AtomQuartzSubsystem DeleteClockByName

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

DeleteClockByName

delete an existing clock given its name

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target
Name	Clock Name

Outputs

Type	Name	Description
Exec	Out

AtomQuartzSubsystem DeleteClockByHandle

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

DeleteClockByHandle

delete an existing clock given its clock handle

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target
Atom Quartz Clock Handle Object Reference (by ref)	In Clock Handle

Outputs

Type	Name	Description
Exec	Out

AtomQuartzSubsystem CreateNewClock

Navigation

CriWare > BlueprintAPI > AtomQuartzSubsystem

CreateNewClock

Clock Creation
create a new clock (or return handle if clock already exists)

Target is Atom Quartz

Inputs

Type	Name	Description
Exec	In
Atom Quartz Object Reference	Target
Name	Clock Name
Quartz Clock Settings Structure	In Settings
Boolean	Override Settings if Clock Exists
Boolean	Use Atom Audio Engine Clock Manager

Outputs

Type	Name	Description
Exec	Out
Atom Quartz Clock Handle Object Reference	Return Value