Navigation
API > API/Plugins > API/Plugins/TakeMovieScene
This decoration contain stores a target and actual FTimecode for each frame for the purposes of detecting whether the engine was running behind, i.e. was hitching, on a previous frame during take recording.
This data can be used to visualize hitches in the Sequencer UI.
| Name | UFrameHitchSceneDecoration |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Takes/Source/TakeMovieScene/Public/Hitching/FrameHitchSceneDecoration.h |
| Include Path | #include "Hitching/FrameHitchSceneDecoration.h" |
Syntax
UCLASS ()
class UFrameHitchSceneDecoration : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UFrameHitchSceneDecoration
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActualTimecode | FTakeMovieSceneHitchTimecodeCurves | Actual timecode that was recorded | Hitching/FrameHitchSceneDecoration.h | |
| RecordFrameRate | FFrameRate | The frame rate Take Recorder was set up with. | Hitching/FrameHitchSceneDecoration.h | |
| TargetTimecode | FTakeMovieSceneHitchTimecodeCurves | Target timecode that the frame was supposed to have | Hitching/FrameHitchSceneDecoration.h | |
| TimecodeProviderFrameRate | FFrameRate | The frame rate the timecode provider was set up with. | Hitching/FrameHitchSceneDecoration.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TOptional< UE::TakeMovieScene::FFrameHitchData > Evaluate
(
const FFrameTime& InFrameTime |
Evaluates the curve data at the specified time. | Hitching/FrameHitchSceneDecoration.h |