Navigation
Unreal Engine C++ API Reference > Plugins > MovieRenderPipelineCore
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&40;Blueprintable, Abstract&41;
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
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() ![]() |
FMoviePipelineHttpResponseRecieved | HTTPResponseRecievedDelegate | If an HTTP Request has been made and a response returned, the returned response will be broadcast on this event. |
![]() ![]() ![]() ![]() |
FMoviePipelineSocketMessageRecieved | 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< UMoviePipeline > | TargetPipelineClass | Which Pipeline Class should be created by this Executor. May be null. |
![]() ![]() ![]() ![]() |
FString | UserData | Arbitrary data that can be associated with the executor. |
![]() |
UE::MoviePipeline::FViewportArgs | ViewportInitArgs | Some global initialization args that get passed to the UMoviePipeline before the call to Initialize() |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() ![]() |
void | Abort the currently executing job and skip all other jobs. | |
![]() ![]() |
void | ||
![]() ![]() ![]() ![]() |
void | Abort the currently executing job. | |
![]() ![]() |
void | ||
![]() ![]() ![]() |
bool | ConnectSocket
(
const FString& InHostName, |
Attempts to connect a socket to the specified host and port. This is a blocking call. |
![]() ![]() ![]() |
void | Disconnects the socket (if currently connected.) | |
![]() ![]() ![]() ![]() |
void | Execute
(
UMoviePipelineQueue* InPipelineQueue |
Execute the provided Queue. |
![]() ![]() |
void | Execute_Implementation
(
UMoviePipelineQueue* InPipelineQueue |
|
![]() ![]() ![]() ![]() ![]() |
FString | Get the current status message for this job. | |
![]() ![]() ![]() |
FString | ||
![]() ![]() ![]() ![]() ![]() |
float | Get the current progress as last set by SetStatusProgress. | |
![]() ![]() ![]() |
float | ||
![]() ![]() |
bool | ||
![]() ![]() ![]() ![]() ![]() |
bool | IsRendering () |
Report the current state of the executor. |
![]() ![]() ![]() |
bool | ||
![]() ![]() ![]() ![]() |
bool | Returns true if the socket is currently connected, false otherwise. | |
![]() ![]() ![]() ![]() |
void | OnBeginFrame () |
Called once at the beginning of each engine frame. |
![]() ![]() |
void | ||
![]() |
FOnMoviePipelineExecutorErroredNative & | ||
![]() ![]() ![]() ![]() |
void | OnExecutorErroredImpl
(
UMoviePipeline* ErroredPipeline, |
|
![]() |
FOnMoviePipelineExecutorFinishedNative & | Native C++ event to listen to for when this Executor has finished. | |
![]() ![]() ![]() ![]() |
void | This should be called when the Executor has finished executing all of the things it has been asked to execute. | |
![]() ![]() ![]() |
int32 | 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 |
|
![]() |
void | SetViewportInitArgs
(
const UE::MoviePipeline::FViewportArgs& InArgs |
Overridden from UObject
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
void | BeginDestroy () |
Called before destroying the object. |
Deprecated Variables
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() ![]() |
TSubclassOf< UMovieRenderDebugWidget > | DebugWidgetClass | Use SetViewportInitArgs instead. |