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

UMoviePipelinePythonHostExecutor

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...	DebugWidgetClass	Optional widget for feedback during render
FMoviePipelineH...	HTTPResponseRecievedDelegate	If an HTTP Request has been made and a response returned, the returned response will be broadcast on this event.
FMoviePipelineS...	SocketMessageRecievedDelegate	If this executor has been configured to connect to a socket, this event will be called each time the socket recieves something.
FString	StatusMessage
float	StatusProgress
TSubclassOf< UM...	TargetPipelineClass	Which Pipeline Class should be created by this Executor. May be null.
FString	UserData	Arbitrary data that can be associated with the executor.

Constructors

	Name	Description
	UMoviePipelineExecutorBase()

Functions

	Name	Description
void	CancelAllJobs()	Abort the currently executing job and skip all other jobs.
void	CancelAllJobs_Implementation()
void	CancelCurrentJob()	Abort the currently executing job.
void	CancelCurrentJob_Implementation()
bool	ConnectSocket ( const FString& InHostName, const int32 InPort )	Attempts to connect a socket to the specified host and port. This is a blocking call.
void	DisconnectSocket()	Disconnects the socket (if currently connected.)
void	Execute ( UMoviePipelineQueue* InPipelin... )	Execute the provided Queue.
void	Execute_Implementation ( UMoviePipelineQueue* InPipelin... )
FString	GetStatusMessage()	Get the current status message for this job.
FString	GetStatusMessage_Implementation()
float	GetStatusProgress()	Get the current progress as last set by SetStatusProgress.
float	GetStatusProgress_Implementation()
bool	IsAnyJobErrored()
bool	IsRendering()	Report the current state of the executor.
bool	IsRendering_Implementation()
bool	IsSocketConnected()	Returns true if the socket is currently connected, false otherwise.
void	OnBeginFrame()	Called once at the beginning of each engine frame.
void	OnBeginFrame_Implementation()
FOnMoviePipe...	OnExecutorErrored()
void	OnExecutorErroredImpl ( UMoviePipeline* ErroredPipelin..., bool bFatal, FText ErrorReason )
FOnMoviePipe...	OnExecutorFinished()	Native C++ event to listen to for when this Executor has finished.
void	OnExecutorFinishedImpl()	This should be called when the Executor has finished executing all of the things it has been asked to execute.
int32	SendHTTPRequest ( const FString& InURL, const FString& InVerb, const FString& InMessage, const TMap< FString, FString >& In... )	Sends a asynchronous HTTP request.
bool	SendSocketMessage ( const FString& InMessage )	Sends a socket message if the socket is currently connected.
void	SetMoviePipelineClass ( UClass* InPipelineClass )	Specify which MoviePipeline class type should be created by this executor when processing jobs.
void	SetStatusMessage ( const FString& InStatus )	Set the status of this Executor.
void	SetStatusMessage_Implementation ( const FString& InMessage )
void	SetStatusProgress ( const float InProgress )	Set the progress of this Executor.
void	SetStatusProgress_Implementation ( const float InProgress )

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.

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

Take our survey

Dismiss