1. Epic GamesDeveloper
  3. UAutomatedLevelSequenceCapture

UAutomatedLevelSequenceCapture

Unreal Engine C++ API Reference > Editor > MovieSceneTools

Inheritance Hierarchy

  • UMovieSceneCapture
  • UAutomatedLevelSequenceCapture

References

   
Module MovieSceneTools
Header /Engine/Source/Editor/MovieSceneTools/Public/AutomatedLevelSequenceCapture.h
Include #include "AutomatedLevelSequenceCapture.h"

Syntax

UCLASS (Config=EditorPerProjectUserSettings, PerObjectConfig, BlueprintType)  
class UAutomatedLevelSequenceCapture : public UMovieSceneCapture

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite Transient TObjectPtr< ULevelSequenceBurnInOptions > BurnInOptions  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite Config bool bUseCustomEndFrame When enabled, the EndFrame setting will override the default ending frame number
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite Config bool bUseCustomStartFrame When enabled, the StartFrame setting will override the default starting frame number
Public variable UProperty Category, EditAnywhere BlueprintReadWrite Config bool bWriteEditDecisionList Whether to write edit decision lists (EDLs) if the sequence contains shots
Public variable UProperty Category, EditAnywhere BlueprintReadWrite Config bool bWriteFinalCutProXML Whether to write Final Cut Pro XML files (XMLs) if the sequence contains shots
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite Config FFrameNumber CustomEndFrame Frame number to end capturing.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite Config FFrameNumber CustomStartFrame Frame number to start capturing.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite Config float DelayBeforeShotWarmUp The number of seconds to wait (in real-time) at shot boundaries.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite Config float DelayBeforeWarmUp The number of seconds to wait (in real-time) before we start playing back the warm up frames.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite Config float DelayEveryFrame The number of seconds to wait (in real-time) at every frame.
Public variable UProperty Category BlueprintReadWrite FSoftObjectPath LevelSequenceAsset A level sequence asset to playback at runtime - used where the level sequence does not already exist in the world.
Public variable UProperty Category BlueprintReadWrite FString ShotName Optional shot name to render. The frame range to render will be set to the shot frame range.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite Config int32 WarmUpFrameCount The number of extra frames to play before the sequence's start frame, to "warm up" the animation.

Constructors

  Type Name Description
Public function  

UAutomatedLevelSequenceCapture ( const FObjectInitializer&
)

  

Functions

  Type Name Description
Protected function Virtual Const void

AddFormatMappings ( TMap< FString, FStringFormatArg >& OutFormatMappings,
const FFrameMetrics& FrameMetrics
)

  
Public function Virtual void

Close ()

  
Protected function Virtual void

DeserializeAdditionalJson ( const FJsonObject& Object
)

 Custom, additional json deserialization
Public function Const double  
Public function Virtual void

Initialize ( TSharedPtr< FSceneViewport > InViewport,
int32 PIEInstance
)

  
Public function Virtual void  
Public function Virtual void  
Protected function Virtual void

SerializeAdditionalJson ( FJsonObject& Object
)

 Custom, additional json serialization
Public function void

SetFrameOverrides ( FFrameNumber InStartFrame,
FFrameNumber InEndFrame
)

 Override the render frames with the given start/end frames. Restore the values when done rendering.

Enums

  Type Name Description
Private enum ELevelSequenceCaptureState Which state we're in right now  

Constants

Name Description
AutomatedLevelSequenceCaptureUIName This name is used by the UI to save/load a specific instance of the settings from config that doesn't affect the CDO which would affect scripting environments.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.