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 > UMoviePipelineExecutorBase

Light Theme

Dark Theme

UMoviePipelineExecutorBase

A Movie Pipeline Executor is responsible for executing an array of Movie Pipelines, and (optionally) reporting progress back for the movie pipelines.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMoviePipelineExecutorBase

UMoviePipelineLinearExecutorBase

	UMoviePipelineInProcessExecutor
	UMoviePipelinePIEExecutor

UMoviePipelineNewProcessExecutor

References

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

Syntax

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

Remarks

A Movie Pipeline Executor is responsible for executing an array of Movie Pipelines, and (optionally) reporting progress back for the movie pipelines. The entire array is passed at once to allow the implementations to choose how to split up the work. By default we provide a local execution (UMoviePipelineLocalExecutor) which works on them serially, but you can create an implementation of this class, change the default in the Project Settings and use your own distribution logic. For example, you may want to distribute the work to multiple computers over a network, which may involve running command line options on each machine to sync the latest content from the project before the execution starts.

Variables

		Name	Description
	TSubclassOf< UM...	TargetPipelineClass	Which Pipeline Class should be created by this Executor. May be null.

Constructors

	Name	Description
	UMoviePipelineExecutorBase()

Functions

	Name	Description
void	Execute ( UMoviePipelineQueue* InPipelin... )
void	ExecuteImpl ( UMoviePipelineQueue* InPipelin... )
bool	IsRendering()
bool	IsRenderingImpl()
FOnMoviePipe...	OnExecutorErrored()
void	OnExecutorErroredImpl ( UMoviePipeline* ErroredPipelin..., bool bFatal, FText ErrorReason )
FOnMoviePipe...	OnExecutorFinished()
void	OnExecutorFinishedImpl()	This should be called when the Executor has finished executing all of the things it has been asked to execute.
void	SetMoviePipelineClass ( UClass* InPipelineClass )

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

Take our survey

Dismiss