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 > Plugins > MovieRenderPipelineCore > UMoviePipeline

Light Theme

Dark Theme

UMoviePipeline

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMoviePipeline

References

Module	MovieRenderPipelineCore
Header	/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipeline.h
Include	#include "MoviePipeline.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable)
class UMoviePipeline : public UObject

Variables

	Name	Description
TSubclassOf< UM...	DebugWidgetClass	Optional widget for feedback during render
IImageWriteQueu...	ImageWriteQueue	A debug image sequence writer in the event they want to dump every sample generated on its own.
FMoviePipelineW...	OnMoviePipelineShotWorkFinishedDelegate	Only called if `IsFlushDiskWritesPerShot()_ is set! Called after each shot is finished and files have been flushed to disk.
FMoviePipelineW...	OnMoviePipelineWorkFinishedDelegate	Called when we have completely finished this pipeline.
TSharedPtr< FMo...	OutputBuilder	This gathers all of the produced data for an output frame (which may come in async many frames later) before passing them onto the Output Containers.

Constructors

	Name	Description
	UMoviePipeline()

Functions

	Name	Description
void	AddFrameToOutputMetadata ( const FString& ClipName, const FString& ImageSequenceFileNa..., const FMoviePipelineFrameOutputStat..., const FString& Extension, const bool bHasAlpha )
void	AddOutputFuture ( TFuture< bool >&& OutputFuture, const MoviePipeline::FMoviePipeline... )
SettingType ...	FindOrAddSettingForShot ( const UMoviePipelineExecutorShot&#... )
TArray< Sett...	FindSettingsForShot ( const UMoviePipelineExecutorShot&#... )
TArray< UMov...	FindSettingsForShot ( TSubclassOf< UMoviePipelineSetting ..., const UMoviePipelineExecutorShot&#... )
const TArray...	GetActiveShotList()
const MovieP...	GetAudioState()
UMoviePipeli...	GetCurrentJob()
int32	GetCurrentShotIndex()
FDateTime	GetInitializationTime()
FMoviePipeli...	GetOutputDataParams()
const FMovie...	GetOutputMetadata()
const FMovie...	GetOutputState()
UMoviePipeli...	GetPipelineMasterConfig()	Get the Master Configuration used to render this shot.
EMovieRender...	GetPipelineState()
UTexture ...	GetPreviewTexture()
ULevelSequen...	GetTargetSequence()
void	Initialize ( UMoviePipelineExecutorJob* InJ... )	Initialize the movie pipeline with the specified settings. This kicks off the rendering process.
bool	IsFlushDiskWritesPerShot()
bool	IsShutdownRequested()	Has RequestShutdown() been called?
void	OnMoviePipelineFinishedImpl()	This function should be called by the Executor when execution has finished (this should still be called in the event of an error)
FMoviePipeli...	OnMoviePipelineShotWorkFinished()	Only called if `IsFlushDiskWritesPerShot()_ is set! Called after each shot is finished and files have been flushed to disk.
FMoviePipeli...	OnMoviePipelineWorkFinished()	Called when we have completely finished this pipeline.
void	OnSampleRendered ( TUniquePtr< FImagePixelData >&& Ou... )
void	ProcessOutstandingFinishedFrames()
void	ProcessOutstandingFutures()
void	RequestShutdown ( bool bIsError )	Request the movie pipeline to shut down at the next available time.
void	ResolveFilenameFormatArguments ( const FString& InFormatString, const TMap< FString, FString >& In..., FString& OutFinalPath, FMoviePipelineFormatArgs& OutFinal..., const FMoviePipelineFrameOutputStat..., const int32 InFrameNumberOffset )	Resolves the provided InFormatString by converting {format_strings} into settings provided by the master config.
void	SetFlushDiskWritesPerShot ( const bool bFlushWrites )
void	SetPreviewTexture ( UTexture* InTexture )
void	Shutdown ( bool bError )	Abandons any future work on this Movie Pipeline and runs through the shutdown flow to ensure already completed work is written to disk.

Constants

Name	Description
DefaultDebugWidgetAsset

Deprecated Variables

		Name	Description
	FMoviePipelineF...	OnMoviePipelineFinishedDelegate	Use OnMoviePipelineWorkFinishedDelegate instead.

Deprecated Functions

		Name	Description
	FMoviePipeli...	OnMoviePipelineFinished()	Use OnMoviePipelineWorkFinished() instead.

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

Take our survey

Dismiss