unreal.QuartzSubsystem

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

Bases: unreal.WorldSubsystem

Quartz Subsystem

C++ Source:

  • Module: AudioMixer

  • File: QuartzSubsystem.h

create_new_clock(world_context_object, clock_name, settings, override_settings_if_clock_exists=False)QuartzClockHandle

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

Parameters
Returns

Return type

QuartzClockHandle

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_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