Navigation
API > API/Plugins > API/Plugins/VPUtilities
Control the engine's time step via the engine's TimecodeProvider. Will sleep and wake up engine when the a new frame is available.
| Name | UVPTimecodeCustomTimeStep |
| Type | class |
| Header File | /Engine/Plugins/Experimental/VirtualProductionUtilities/Source/VPUtilities/Public/VPTimecodeCustomTimeStep.h |
| Include Path | #include "VPTimecodeCustomTimeStep.h" |
Syntax
UCLASS (Blueprintable, EditInlineNew, Meta=(DisplayName="Timecode Custom Time Step"))
class UVPTimecodeCustomTimeStep : public UFixedFrameRateCustomTimeStep
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UEngineCustomTimeStep → UFixedFrameRateCustomTimeStep → UVPTimecodeCustomTimeStep
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. | VPTimecodeCustomTimeStep.h |
|
| bErrorIfTimecodeProviderChanged | bool | If true, stop the CustomTimeStep if the engine's TimeProvider changed since last frame. | VPTimecodeCustomTimeStep.h |
|
| MaxDeltaTime | float | If the timecode doesn't change after that amount of time, stop the CustomTimeStep. | VPTimecodeCustomTimeStep.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bWarnAboutSynchronizationState | bool | Only warn once about the synchronization state. | VPTimecodeCustomTimeStep.h | |
| InitializedSeconds | double | The time at initialization. | VPTimecodeCustomTimeStep.h | |
| PreviousFrameRate | FFrameRate | The last frame rate of the TimecodeProvider. | VPTimecodeCustomTimeStep.h | |
| PreviousTimecode | FTimecode | The last timecode of the TimecodeProvider. | VPTimecodeCustomTimeStep.h | |
| State | ECustomTimeStepSynchronizationState | The current SynchronizationState of the CustomTimeStep. | VPTimecodeCustomTimeStep.h |
Functions
Public
Overridden from UFixedFrameRateCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FFrameRate GetFixedFrameRate() |
VPTimecodeCustomTimeStep.h |
Overridden from UEngineCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ECustomTimeStepSynchronizationState GetSynchronizationState() |
VPTimecodeCustomTimeStep.h | ||
virtual bool Initialize
(
UEngine* InEngine |
VPTimecodeCustomTimeStep.h | ||
virtual void Shutdown
(
UEngine* InEngine |
VPTimecodeCustomTimeStep.h | ||
virtual bool UpdateTimeStep
(
UEngine* InEngine |
VPTimecodeCustomTimeStep.h |