UAutomatedLevelSequenceCapture

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMovieSceneCapture

UAutomatedLevelSequenceCapture

References

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

Syntax

class UAutomatedLevelSequenceCapture : public UMovieSceneCapture

Variables

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

Constructors

	Name	Description
	UAutomatedLevelSequenceCapture ( const FObjectInitializer& )

Functions

		Name	Description
	void	SetFrameOverrides ( FFrameNumber InStartFrame, FFrameNumber InEndFrame )	Override the render frames with the given start/end frames. Restore the values when done rendering.

Overridden from UMovieSceneCapture

	Name	Description
void	AddFormatMappings ( TMap< FString, FStringFormatArg >&..., const FFrameMetrics& FrameMetrics )	Add additional format mappings to be used when generating filenames
void	DeserializeAdditionalJson ( const FJsonObject& Object )	Custom, additional json deserialization
void	LoadFromConfig()	Load save from config helpers
void	SaveToConfig()
void	SerializeAdditionalJson ( FJsonObject& Object )	Custom, additional json serialization

Overridden from IMovieSceneCaptureInterface

		Name	Description
	void	Close()	Shut down this movie capture
	void	Initialize ( TSharedPtr< FSceneViewport > Viewpo..., int32 PIEInstance )	Initialize this capture object by binding it to the specified viewport

Overridden from ICaptureProtocolHost

		Name	Description
	double	GetEstimatedCaptureDurationSeconds()	Ask the host to inform us of how long the capture duration is expected to be.

Enums

	Name	Description
	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.