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) –
- Return type
- 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
- delete_clock_by_name(world_context_object, clock_name) None ¶
delete an existing clock given its name
- get_audio_render_thread_to_game_thread_average_latency() float ¶
latency data (Audio Render Thread -> Game thread)
- Return type
- get_audio_render_thread_to_game_thread_max_latency() float ¶
Get Audio Render Thread to Game Thread Max Latency
- Return type
- get_audio_render_thread_to_game_thread_min_latency() float ¶
Get Audio Render Thread to Game Thread Min Latency
- Return type
- get_current_clock_timestamp(world_context_object, clock_name) QuartzTransportTimeStamp ¶
Retrieves a timestamp for the clock
- Parameters
- Return type
- get_duration_of_quantization_type_in_seconds(world_context_object, clock_name, quantization_type, multiplier=1.000000) 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
- get_estimated_clock_run_time(world_context_object, clock_name) float ¶
Returns the amount of time, in seconds, the clock has been running. Caution: due to latency, this will not be perfectly accurate
- get_game_thread_to_audio_render_thread_average_latency(world_context_object) float ¶
latency data (Game thread -> Audio Render Thread)
- get_game_thread_to_audio_render_thread_max_latency(world_context_object) float ¶
Get Game Thread to Audio Render Thread Max Latency
- get_game_thread_to_audio_render_thread_min_latency(world_context_object) float ¶
Get Game Thread to Audio Render Thread Min Latency
- get_handle_for_clock(world_context_object, clock_name) QuartzClockHandle ¶
get handle for existing clock
- Parameters
- Return type