unreal.VPTimecodeCustomTimeStep

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

Bases: unreal.FixedFrameRateCustomTimeStep

Control the engine’s time step via the engine’s TimecodeProvider. Will sleep and wake up engine when the a new frame is available.

C++ Source:

  • Plugin: VirtualProductionUtilities

  • Module: VPUtilities

  • File: VPTimecodeCustomTimeStep.h

Editor Properties: (see get_editor_property/set_editor_property)

  • error_if_frame_are_not_consecutive (bool): [Read-Write] Error if Frame Are Not Consecutive: If true, stop the CustomTimeStep if the new timecode value doesn’t follow the previous timecode value.

  • error_if_timecode_provider_changed (bool): [Read-Write] Error if Timecode Provider Changed: If true, stop the CustomTimeStep if the engine’s TimeProvider changed since last frame.

  • max_delta_time (float): [Read-Write] Max Delta Time: If the timecode doesn’t change after that amount of time, stop the CustomTimeStep.