Navigation
API > API/Runtime > API/Runtime/TimeManagement
Control the engine's time step via the engine's TimecodeProvider. Will sleep and wake up the engine when a new frame is available.
| Name | UTimecodeCustomTimeStep |
| Type | class |
| Header File | /Engine/Source/Runtime/TimeManagement/Public/TimecodeCustomTimeStep.h |
| Include Path | #include "TimecodeCustomTimeStep.h" |
Syntax
UCLASS (Blueprintable, EditInlineNew, MinimalAPI, Meta=(DisplayName="Timecode Custom Time Step"))
class UTimecodeCustomTimeStep : public UFixedFrameRateCustomTimeStep
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UEngineCustomTimeStep → UFixedFrameRateCustomTimeStep → UTimecodeCustomTimeStep
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bErrorIfFrameAreNotConsecutive | bool | If true, stop the CustomTimeStep if the new timecode value doesn't follow the previous timecode value. | TimecodeCustomTimeStep.h |
|
| bErrorIfTimecodeProviderChanged | bool | If true, stop the CustomTimeStep if the engine's TimeProvider changed since last frame. | TimecodeCustomTimeStep.h |
|
| bIgnoreSubframes | bool | If true, the subframe frame portion of timecode will be ignored when comparing the current and previous timecode sample Set to true if you wish to sample an overriden timecode rate rather than the rate data is received at eg. Live Link Timecode from a 120fps system but with timecode of 24. | TimecodeCustomTimeStep.h |
|
| MaxDeltaTime | float | If the timecode doesn't change after that amount of time, stop the CustomTimeStep. | TimecodeCustomTimeStep.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bWarnAboutSynchronizationState | bool | Only warn once about the synchronization state. | TimecodeCustomTimeStep.h | |
| InitializedSeconds | double | The time at initialization. | TimecodeCustomTimeStep.h | |
| PreviousFrameRate | FFrameRate | The last frame rate of the TimecodeProvider. | TimecodeCustomTimeStep.h | |
| PreviousTimecode | FTimecode | The last timecode of the TimecodeProvider. | TimecodeCustomTimeStep.h | |
| State | ECustomTimeStepSynchronizationState | The current SynchronizationState of the CustomTimeStep. | TimecodeCustomTimeStep.h |