1. Epic GamesDeveloper
  3. UAutomatedLevelSequenceCapture

UAutomatedLevelSequenceCapture

API > API/Editor > API/Editor/MovieSceneTools

   
Name UAutomatedLevelSequenceCapture
Type class
Header File /Engine/Source/Editor/MovieSceneTools/Public/AutomatedLevelSequenceCapture.h
Include Path #include "AutomatedLevelSequenceCapture.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UAutomatedLevelSequenceCapture ( const FObjectInitializer&
)

   AutomatedLevelSequenceCapture.h  

Structs

Name Remarks
FCinematicShotCache  

Constants

Name Type Remarks Include Path
AutomatedLevelSequenceCaptureUIName const FName 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. AutomatedLevelSequenceCapture.h

Variables

Public

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

Protected

Name Type Remarks Include Path Unreal Specifiers
bCachedUseCustomEndFrame TOptional< bool >   AutomatedLevelSequenceCapture.h  
bCachedUseCustomStartFrame TOptional< bool >   AutomatedLevelSequenceCapture.h  
CachedDelayBeforeShotWarmUp int32   AutomatedLevelSequenceCapture.h  
CachedDelayBeforeWarmUp int32   AutomatedLevelSequenceCapture.h  
CachedEndFrame TOptional< FFrameNumber >   AutomatedLevelSequenceCapture.h  
CachedPlaybackRange TRange< FFrameNumber >   AutomatedLevelSequenceCapture.h  
CachedShotStates TArray< FCinematicShotCache >   AutomatedLevelSequenceCapture.h  
CachedStartFrame TOptional< FFrameNumber >   AutomatedLevelSequenceCapture.h  
CachedState FLevelSequencePlayerSnapshot   AutomatedLevelSequenceCapture.h  
CachedWarmUpFrameCount int32 We cache these off on initialization so we can restore to them after running an audio pass. AutomatedLevelSequenceCapture.h  
CaptureState enum UAutomatedLevelSequenceCapture::ELevelSequenceCaptureState   AutomatedLevelSequenceCapture.h  
DelayTimer FTimerHandle   AutomatedLevelSequenceCapture.h  
LevelSequenceActor TWeakObjectPtr< ALevelSequenceActor > The pre-existing level sequence actor to use for capture that specifies playback settings AutomatedLevelSequenceCapture.h  
NumShots int32 The number of individual shot movies to render AutomatedLevelSequenceCapture.h  
OnPlayerUpdatedBinding FDelegateHandle Delegate binding for the above callback AutomatedLevelSequenceCapture.h  
RemainingWarmUpFrames int32 The number of warm up frames left before we actually start saving out images AutomatedLevelSequenceCapture.h  
ShotIndex int32 The current shot movie that is rendering AutomatedLevelSequenceCapture.h  
TimeController TSharedPtr< FMovieSceneTimeController_FrameStep >   AutomatedLevelSequenceCapture.h  
Viewport TWeakPtr< FSceneViewport > The viewport being captured. AutomatedLevelSequenceCapture.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetFrameOverrides ( FFrameNumber InStartFrame,
FFrameNumber InEndFrame
)

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

Overridden from UMovieSceneCapture

Name Remarks Include Path Unreal Specifiers

virtual void LoadFromConfig()

   AutomatedLevelSequenceCapture.h  

virtual void SaveToConfig()

   AutomatedLevelSequenceCapture.h  

Overridden from IMovieSceneCaptureInterface

Name Remarks Include Path Unreal Specifiers

virtual void Close()

   AutomatedLevelSequenceCapture.h  

virtual void Initialize ( TSharedPtr< FSceneViewport > InViewport,
int32 PIEInstance
)

   AutomatedLevelSequenceCapture.h  

Overridden from ICaptureProtocolHost

Name Remarks Include Path Unreal Specifiers

virtual double GetEstimatedCaptureDurationSeconds()

   AutomatedLevelSequenceCapture.h  

Protected

Overridden from UMovieSceneCapture

Name Remarks Include Path Unreal Specifiers

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

   AutomatedLevelSequenceCapture.h  

virtual void DeserializeAdditionalJson ( const FJsonObject& Object
)

 Custom, additional json deserialization AutomatedLevelSequenceCapture.h  

virtual void SerializeAdditionalJson ( FJsonObject& Object
)

 Custom, additional json serialization AutomatedLevelSequenceCapture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page