Movie Render Pipeline

Movie Render Pipeline

Windows
MacOS
Linux
On this page

Actions

Duplicate Sequence

Duplicates the specified sequence using a medium depth copy. Standard duplication will only duplicate the top level Sequence (since shots and sub-sequences are other standalone assets) so this function recursively duplicates the given sequence, shot and subsequence and then fixes up the references to point to newly duplicated sequences.

Use at your own risk. Some features may not work when duplicated (complex object binding arrangements, blueprint GetSequenceBinding nodes, etc.) but can be useful when wanting to create a bunch of variations with minor differences (such as swapping out an actor, track, etc.)

This does not duplicate any assets that the sequence points to outside of Shots/Subsequences.

Target is Movie Pipeline Blueprint Library

Execute

Execute

Target is Movie Pipeline Executor Base

Export Config to Asset

Export Config to Asset

Target is Movie Pipeline Editor Blueprint Library

Find or Add Setting by Class

Finds a setting of a particular type for this pipeline config, adding it if it doesn't already exist.

Target is Movie Pipeline Config Base

Find Setting by Class

Find a setting of a particular type for this config.

Target is Movie Pipeline Config Base

Get Active Executor

Returns the active executor (if there is one). This can be used to subscribe to events on an already in-progress render. May be null.

Target is Movie Pipeline Queue Subsystem

Get Completion Percentage

same as above but just 0-1

Target is Movie Pipeline Blueprint Library

Get Configuration

Get Configuration

Target is Movie Pipeline Executor Job

Get Current Segment Name

Get Current Segment Name

Target is Movie Pipeline Blueprint Library

Get Current Segment State

Get Current Segment State

Target is Movie Pipeline Blueprint Library

Get Current Segment Work Metrics

Get Current Segment Work Metrics

Target is Movie Pipeline Blueprint Library

Get Current Shot Frame Number

Get Current Shot Frame Number

Target is Movie Pipeline Blueprint Library

Get Current Shot Timecode

Get Current Shot Timecode

Target is Movie Pipeline Blueprint Library

Get Effective Frame Rate

Returns the frame rate override from the Master Configuration (if any) or the Sequence frame rate if no override is specified. This should be treated as the actual output framerate of the overall Pipeline.

Target is Movie Pipeline Master Config

Get Engine Warm Up Frame Count

Get Engine Warm Up Frame Count

Target is Movie Pipeline Blueprint Library

Get Estimated Time Remaining

Get the estimated amount of time remaining for the current pipeline. Based on looking at the total amount of samples to render vs. how many have been completed so far. Inaccurate when Time Dilation is used, and gets more accurate over the course of the render.

Target is Movie Pipeline Blueprint Library

Get Job Author

Get Job Author

Target is Movie Pipeline Blueprint Library

Get Job Initialization Time

Get Job Initialization Time

Target is Movie Pipeline Blueprint Library

Get Job Name

Get Job Name

Target is Movie Pipeline Blueprint Library

Get Master Frame Number

Get Master Frame Number

Target is Movie Pipeline Blueprint Library

Get Master Timecode

Get Master Timecode

Target is Movie Pipeline Blueprint Library

Get Overall Output Frames

Get Overall Output Frames

Target is Movie Pipeline Blueprint Library

Get Overall Segment Counts

Get Overall Segment Counts

Target is Movie Pipeline Blueprint Library

Get Pipeline Master Config

Get the Master Configuration used to render this shot. This contains the global settings for the shot, as well as per-shot configurations which can contain their own settings.

Target is Movie Pipeline

Get Pipeline State

Get the current state of the specified Pipeline. See EMovieRenderPipelineState for more detail about each state.

Target is Movie Pipeline Blueprint Library

Get Preset Origin

Get Preset Origin

Target is Movie Pipeline Executor Job

Get Preview Texture

Get Preview Texture

Target is Movie Pipeline

Get Queue

Returns the queue of Movie Pipelines that need to be rendered.

Target is Movie Pipeline Queue Subsystem

Get Subsample Count

Get Subsample Count

Target is Movie Pipeline Blueprint Library

Get Total Sample Count

The most accurate way to determine 0-1 progress as it looks at the total number of samples needing to be rendered

Target is Movie Pipeline Blueprint Library

Has Finished

Has Finished

Target is Movie Pipeline Executor Job

On Executor Errored Delegate

Called when an individual job reports a warning/error. Jobs are considered fatal if the severity was bad enough to abort the job (missing sequence, write failure, etc.)

Exposed for Blueprints/Python. Called at the same time as the native one.

On Executor Finished Delegate

Called when the Executor has finished all jobs. Reports success if no jobs had fatal errors. Subscribe to the error delegate for more information about any errors.

Exposed for Blueprints/Python. Called at the same time as the native one.

Remove Setting

Removes the specific instance from our Setting list.

Target is Movie Pipeline Config Base

Set Configuration

Set Configuration

Target is Movie Pipeline Executor Job

Set Preset Origin

Set Preset Origin

Target is Movie Pipeline Executor Job

Categories

Queue

Queue

Rendering

Rendering

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback