unreal.QuartzSubsystem

class unreal.QuartzSubsystem(outer=None, name='None')

Bases: unreal.TickableWorldSubsystem

Quartz Subsystem

C++ Source:

• Module: AudioMixer

• File: QuartzSubsystem.h

create_new_clock(world_context_object, clock_name, settings, override_settings_if_clock_exists=False, use_audio_engine_clock_manager=True) → QuartzClockHandle

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

Parameters

• world_context_object (Object) –

• clock_name (Name) –

• settings (QuartzClockSettings) –

• override_settings_if_clock_exists (bool) –

• use_audio_engine_clock_manager (bool) –

Returns

Return type

QuartzClockHandle

delete_clock_by_handle(world_context_object, clock_handle) → QuartzClockHandle

delete an existing clock given its clock handle

Parameters

• world_context_object (Object) –

• clock_handle (QuartzClockHandle) –

Returns

clock_handle (QuartzClockHandle):

Return type

QuartzClockHandle

delete_clock_by_name(world_context_object, clock_name) → None

delete an existing clock given its name

Parameters

• world_context_object (Object) –

• clock_name (Name) –

does_clock_exist(world_context_object, clock_name) → bool

returns true if the clock exists

Parameters

• world_context_object (Object) –

• clock_name (Name) –

Returns

Return type

bool

get_audio_render_thread_to_game_thread_average_latency() → float

latency data (Audio Render Thread -> Game thread)

Returns

Return type

float

get_audio_render_thread_to_game_thread_max_latency() → float

Get Audio Render Thread to Game Thread Max Latency

Returns

Return type

float

get_audio_render_thread_to_game_thread_min_latency() → float

Get Audio Render Thread to Game Thread Min Latency

Returns

Return type

float

get_duration_of_quantization_type_in_seconds(world_context_object, clock_name, quantization_type, multiplier=1.0) → float

Returns the duration in seconds of the given Quantization Type

Parameters

• world_context_object (Object) –

• clock_name (Name) –

• quantization_type (QuartzCommandQuantization) –

• multiplier (float) –

Returns

The duration, in seconds, of a multiplier amount of the Quantization Type, or -1 in the case the clock is invalid

Return type

float

get_game_thread_to_audio_render_thread_average_latency(world_context_object) → float

latency data (Game thread -> Audio Render Thread)

Parameters

world_context_object (Object) –

Returns

Return type

float

get_game_thread_to_audio_render_thread_max_latency(world_context_object) → float

Get Game Thread to Audio Render Thread Max Latency

Parameters

world_context_object (Object) –

Returns

Return type

float

get_game_thread_to_audio_render_thread_min_latency(world_context_object) → float

Get Game Thread to Audio Render Thread Min Latency

Parameters

world_context_object (Object) –

Returns

Return type

float

get_handle_for_clock(world_context_object, clock_name) → QuartzClockHandle

get handle for existing clock

Parameters

• world_context_object (Object) –

• clock_name (Name) –

Returns

Return type

QuartzClockHandle

get_round_trip_average_latency(world_context_object) → float

latency data (Round trip)

Parameters

world_context_object (Object) –

Returns

Return type

float

get_round_trip_max_latency(world_context_object) → float

Get Round Trip Max Latency

Parameters

world_context_object (Object) –

Returns

Return type

float

get_round_trip_min_latency(world_context_object) → float

Get Round Trip Min Latency

Parameters

world_context_object (Object) –

Returns

Return type

float

is_clock_running(world_context_object, clock_name) → bool

returns true if the clock is running

Parameters

• world_context_object (Object) –

• clock_name (Name) –

Returns

Return type

bool

is_quartz_enabled() → bool

Is Quartz Enabled deprecated: This function will now always return true

Returns

Return type

bool