Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MovieSceneCapture > UMovieSceneCapture

Light Theme

Dark Theme

UMovieSceneCapture

Class responsible for capturing scene data

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMovieSceneCapture

	UAutomatedLevelSequenceCapture
	ULevelCapture

References

Module	MovieSceneCapture
Header	/Engine/Source/Runtime/MovieSceneCapture/Public/MovieSceneCapture.h
Include	#include "MovieSceneCapture.h"

Syntax

class UMovieSceneCapture :
    public UObject,
    public IMovieSceneCaptureInterface,
    public ICaptureProtocolHost

Remarks

Class responsible for capturing scene data

Variables

	Name	Description
FString	AdditionalCommandLineArguments	Additional command line arguments to pass to the external process when capturing
UMovieSceneAudi...	AudioCaptureProtocol
FSoftClassPath	AudioCaptureProtocolType	The type of capture protocol to use for audio data.
bool	bCapturing	Whether we have started capturing or not
bool	bCloseEditorWhenCaptureStarts	When enabled, the editor will shutdown when the capture starts
bool	bFinalizeWhenReady	Whether we should automatically attempt to capture frames every tick or not
bool	bIsAudioCapturePass	If we're currently doing an audio pass or not
bool	bUseSeparateProcess	Whether to capture the movie in a separate process or not
FCachedMetrics	CachedMetrics	Cached metrics for this capture operation
Scalability::FQ...	CachedQualityLevels	Cached quality levels
TSharedPtr< ICa...	CaptureStrategy	Strategy used for capture (real-time/fixed-time-step)
TMap< FString, ...	FormatMappings	Format mappings used for generating filenames
int32	FrameNumberOffset	Frame number index offset when saving out frames.
FMovieSceneCapt...	Handle	Our unique handle, used for external representation without having to link to the MovieSceneCapture module
UMovieSceneImag...	ImageCaptureProtocol	Capture protocol responsible for actually capturing frame data
FSoftClassPath	ImageCaptureProtocolType	The type of capture protocol to use for image data
FString	InheritedCommandLineArguments	Command line arguments inherited from this process
TOptional< FCap...	InitSettings	The settings we will use to set up the capture protocol
FOnCaptureFinis...	OnCaptureFinishedDelegate	Event that is triggered when capturing has finished
FMovieSceneCapt...	Settings	Settings that define how to capture

Constructors

	Name	Description
	UMovieSceneCapture ( const FObjectInitializer& Initiali... )

Functions

	Name	Description
void	AddFormatMappings ( TMap< FString, FStringFormatArg >&..., const FFrameMetrics& FrameMetrics )	Add additional format mappings to be used when generating filenames
void	CaptureThisFrame ( float DeltaSeconds )	Indicate that this frame should be captured - must be called before the movie scene capture is ticked
void	DeserializeAdditionalJson ( const FJsonObject& Object )	Custom, additional json deserialization
void	DeserializeJson ( const FJsonObject& Object )	Deserialize additional json data for this capture
void	Finalize()	Finalize the capturing process, assumes all frames have been processed.
void	FinalizeWhenReady()	Automatically finalizes the capture when all currently pending frames are dealt with
void	ForciblyReinitializeCaptureProtocols()
UMovieSceneC...	GetAudioCaptureProtocol()
UMovieSceneC...	GetImageCaptureProtocol()	Access the capture protocol we are using
const FCache...	GetMetrics()	Access this object's cached metrics
void	InitializeCaptureProtocols()	Initialize the settings structure for the current capture type
bool	IsAudioPassIfNeeded()	Returns true if this is currently the audio pass, or if an audio pass is not needed.
void	LoadFromConfig()	Load save from config helpers
FOnCaptureFi...	OnCaptureFinished()
void	OnTick ( float DeltaSeconds )	Called at the end of a frame, before a frame is presented by slate
void	SaveToConfig()
void	SerializeAdditionalJson ( FJsonObject& Object )	Custom, additional json serialization
void	SerializeJson ( FJsonObject& Object )	Serialize additional json data for this capture
void	SetAudioCaptureProtocolType ( TSubclassOf< UMovieSceneCaptureProt... )
void	SetImageCaptureProtocolType ( TSubclassOf< UMovieSceneCaptureProt... )
bool	ShouldFinalize()	Check whether we should automatically finalize this capture
void	StartCapture()	Initialize the capture so that it is able to start capturing frames
void	StartWarmup()	Starts warming up.
void	Tick ( float DeltaSeconds )	Called at the end of a frame, before a frame is presented by slate

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Overridden from IMovieSceneCaptureInterface

	Name	Description
void	Close()	Shut down this movie capture
const int32	GetFrameNumberOffset()	Access Frame Number Offset
FMovieSceneC...	GetHandle()	Get a unique handle to this object
const FMovie...	GetSettings()	Access specific movie scene capture settings
void	Initialize ( TSharedPtr< FSceneViewport > Viewpo..., int32 PIEInstance )	Initialize this capture object by binding it to the specified viewport
void	StartCapturing()	Instruct this capture to start capturing frames

Overridden from ICaptureProtocolHost

	Name	Description
FFrameRate	GetCaptureFrameRate()	Get the capture frequency
const ICaptu...	GetCaptureStrategy()	Access the host's capture strategy
double	GetEstimatedCaptureDurationSeconds()	Estimate how long our duration is going to be for pre-allocation purposes.
FString	ResolveFileFormat ( const FString& Format, const FFrameMetrics& FrameMetrics )	Resolve the specified format using the user supplied formatting rules.

Classes

	Name	Description
	FOnCaptureFinished	Event that is fired after we've finished capturing

Constants

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss