unreal.MoviePipelineLibrary

class unreal.MoviePipelineLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Movie Pipeline Blueprint Library

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MoviePipelineBlueprintLibrary.h

classmethod duplicate_sequence(outer, sequence) → MovieSceneSequence

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.

Parameters

  • outer (Object) – The Outer of the newly duplicated object. Leave null for TransientPackage();

  • sequence (MovieSceneSequence) – The sequence to recursively duplicate.

Returns

The duplicated sequence, or null if no sequence was provided to duplicate.

Return type

MovieSceneSequence

classmethod find_or_get_default_setting_for_shot(setting_type, master_config, shot) → MoviePipelineSetting

Allows access to a setting of provided type for specific shot.

Parameters
Returns

Return type

MoviePipelineSetting

classmethod get_completion_percentage(pipeline) → float

Gets the completion percent of the Pipeline in 0-1

Parameters

pipeline (MoviePipeline) –

Returns

Return type

float

classmethod get_current_aperture(movie_pipeline) → float

Get Current Aperture

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

float

classmethod get_current_focal_length(movie_pipeline) → float

Get Current Focal Length

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

float

classmethod get_current_focus_distance(movie_pipeline) → float

Get Current Focus Distance

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

float

classmethod get_current_segment_name(movie_pipeline) -> (out_outer_name=Text, out_inner_name=Text)

Get Current Segment Name

Parameters

movie_pipeline (MoviePipeline) –

Returns

out_outer_name (Text):

out_inner_name (Text):

Return type

tuple

classmethod get_current_segment_state(movie_pipeline) → MovieRenderShotState

Get Current Segment State

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

MovieRenderShotState

classmethod get_current_segment_work_metrics(movie_pipeline) → MoviePipelineSegmentWorkMetrics

Get Current Segment Work Metrics

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

MoviePipelineSegmentWorkMetrics

classmethod get_current_shot_frame_number(movie_pipeline) → FrameNumber

Get Current Shot Frame Number

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

FrameNumber

classmethod get_current_shot_timecode(movie_pipeline) → Timecode

Get Current Shot Timecode

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

Timecode

classmethod get_effective_output_resolution(master_config, pipeline_executor_shot) → IntPoint

In case of Overscan percentage being higher than 0 we render additional pixels. This function returns the resolution with overscan taken into account.

Parameters
Returns

Return type

IntPoint

classmethod get_estimated_time_remaining(pipeline) → Timespan or None

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.

Parameters

pipeline (MoviePipeline) – The pipeline to get the time estimate from.

Returns

True if a valid estimate can be calculated, or false if it is not ready yet (ie: not enough samples rendered)

out_estimate (Timespan): The resulting estimate, or FTimespan() if estimate is not valid.

Return type

Timespan or None

classmethod get_job_author(movie_pipeline) → Text

Get Job Author

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

Text

classmethod get_job_initialization_time(movie_pipeline) → DateTime

Get Job Initialization Time

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

DateTime

classmethod get_job_name(movie_pipeline) → Text

Get Job Name

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

Text

classmethod get_map_package_name(job) → str

Get the package name for the map in this job. The level travel command requires the package path and not the asset path.

Parameters

job (MoviePipelineExecutorJob) –

Returns

Return type

str

classmethod get_master_frame_number(movie_pipeline) → FrameNumber

Get Master Frame Number

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

FrameNumber

classmethod get_master_timecode(movie_pipeline) → Timecode

Get Master Timecode

Parameters

movie_pipeline (MoviePipeline) –

Returns

Return type

Timecode

classmethod get_overall_output_frames(movie_pipeline) -> (out_current_index=int32, out_total_count=int32)

Get Overall Output Frames

Parameters

movie_pipeline (MoviePipeline) –

Returns

out_current_index (int32):

out_total_count (int32):

Return type

tuple

classmethod get_overall_segment_counts(movie_pipeline) -> (out_current_index=int32, out_total_count=int32)

Get Overall Segment Counts

Parameters

movie_pipeline (MoviePipeline) –

Returns

out_current_index (int32):

out_total_count (int32):

Return type

tuple

classmethod get_pipeline_state(pipeline) → MovieRenderPipelineState

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

Parameters

pipeline (MoviePipeline) – The pipeline to get the state for.

Returns

Current State.

Return type

MovieRenderPipelineState

classmethod resolve_filename_format_arguments(format_string, params) -> (out_final_path=str, out_merged_format_args=MoviePipelineFormatArgs)

Resolves the provided InFormatString by converting {format_strings} into settings provided by the master config.

Parameters

  • format_string (str) – A format string (in the form of “{format_key1}_{format_key2}”) to resolve.

  • params (MoviePipelineFilenameResolveParams) – The parameters to resolve the format string with. See FMoviePipelineFilenameResolveParams properties for details. Expected that you fill out all of the parameters so that they can be used to resolve strings, otherwise default values may be used.

Returns

out_final_path (str): The final filepath based on a combination of the format string and the Resolve Params.

out_merged_format_args (MoviePipelineFormatArgs):

Return type

tuple

classmethod resolve_version_number(params) → int32

If version number is manually specified by the Job, returns that. Otherwise search the Output Directory for the highest version already existing an increments it by one.

Parameters

params (MoviePipelineFilenameResolveParams) –

Returns

Return type

int32

classmethod update_job_shot_list_from_sequence(sequence, job) → bool

Scan the provided sequence in the job to see which camera cut sections we would try to render and update the job’s shotlist.

Parameters
Returns

shots_changed (bool):

Return type

bool