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
TArray< TShared...	ActiveRenderPasses	A list of engine passes which need to be run each frame to generate required content for all the movie render passes.
IImageWriteQueu...	ImageWriteQueue	A debug image sequence writer in the event they want to dump every sample generated on its own.
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
UMoviePipeli...	FindOrAddSetting ( TSubclassOf< UMoviePipelineSetting ..., const FMoviePipelineShotInfo& InSh... )
SettingType ...	FindOrAddSetting ( const FMoviePipelineShotInfo& InSh... )
const MovieP...	GetAudioState()
UMoviePipeli...	GetCurrentJob()
int32	GetCurrentShotIndex()
FDateTime	GetInitializationTime()
const FMovie...	GetOutputState()
UMoviePipeli...	GetPipelineMasterConfig()	Get the Master Configuration used to render this shot.
EMovieRender...	GetPipelineState()
UTexture ...	GetPreviewTexture()
const TArray...	GetShotList()
ULevelSequen...	GetTargetSequence()
void	Initialize ( UMoviePipelineExecutorJob* InJ... )	Initialize the movie pipeline with the specified settings. This kicks off the rendering process.
bool	IsShutdownRequested()	Has RequestShutdown() been called?
FMoviePipeli...	OnMoviePipelineErrored()	Called when there was an error during the rendering of this movie pipeline (such as missing sequence, i/o failure, etc.)
FMoviePipeli...	OnMoviePipelineFinished()	Called when we have completely finished this pipeline.
void	OnSampleRendered ( TUniquePtr< FImagePixelData >&& Ou..., const TSharedRef< FImagePixelDataPa... )
void	ProcessOutstandingFinishedFrames()
void	RequestShutdown()	Request the movie pipeline to shut down at the next available time.
FString	ResolveFilenameFormatArguments ( const FString& InFormatString, const FMoviePipelineFrameOutputStat..., const FStringFormatNamedArguments&... )	Resolves the provided InFormatString by converting {format_strings} into settings provided by the master config.
void	SetPreviewTexture ( UTexture* InTexture )
void	Shutdown()	Abandons any future work on this Movie Pipeline and runs through the shutdown flow to ensure already completed work is written to disk.

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

Take our survey

Dismiss