unreal.MovieGraphLibrary

class unreal.MovieGraphLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Movie Graph Blueprint Library

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphBlueprintLibrary.h

classmethod get_completion_percentage(pipeline) → float

Gets the completion percent of the Pipeline in 0-1

Parameters:

pipeline (MovieGraphPipeline) –

Return type:

float

classmethod get_current_aperture(movie_graph_pipeline) → float

Gets the aperture for the camera currently in use.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get the camera information from.

Return type:

float

classmethod get_current_cine_camera(movie_graph_pipeline) → CineCameraComponent

Gets the currently active cine camera, or nullptr if one was not found.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get the camera from.

Return type:

CineCameraComponent

classmethod get_current_focal_length(movie_graph_pipeline) → float

Gets the focal length for the camera currently in use.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get the camera information from.

Return type:

float

classmethod get_current_focus_distance(movie_graph_pipeline) → float

Gets the focus distance for the camera currently in use.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get the camera information from.

Return type:

float

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

Gets the name of the segment (shot) currently being rendered.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get segment information from.

Returns:

out_outer_name (Text):

out_inner_name (Text):

Return type:

tuple

classmethod get_current_segment_state(movie_graph_pipeline) → MovieRenderShotState

Gets the state of the segment (shot) currently being rendered.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get segment information from.

Return type:

MovieRenderShotState

classmethod get_current_segment_work_metrics(movie_graph_pipeline) → MoviePipelineSegmentWorkMetrics

Gets the work metrics for the segment (shot) that is currently being rendered.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get segment information from.

Return type:

MoviePipelineSegmentWorkMetrics

classmethod get_current_shot_frame_number(movie_graph_pipeline) → FrameNumber

Gets the frame number of the current render at the shot level.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get frame number information from.

Return type:

FrameNumber

classmethod get_current_shot_timecode(movie_graph_pipeline) → Timecode

Gets the timecode of the current render at the shot level.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get timecode information from.

Return type:

Timecode

classmethod get_effective_frame_rate(node, default_rate) → FrameRate

If InNode is valid, inspects the provided OutputsettingNode to determine if it wants to override the Frame Rate, and if so, returns the overwritten frame rate. If nullptr, or it does not have the bOverride_bUseCustomFrameRate flag set, then InDefaultrate is returned.

Parameters:

  • node (MovieGraphGlobalOutputSettingNode) – Optional, setting to inspect for a custom framerate.

  • default_rate (FrameRate) – The frame rate to use if the node is nullptr or doesn’t want to override the rate.

Returns:

The effective frame rate (taking into account the node’s desire to override it).

Return type:

FrameRate

classmethod get_effective_output_resolution(evaluated_graph) → IntPoint

In case of overscan percentage being higher than 0, additional pixels are rendered. This function returns the resolution with overscan taken into account.

Parameters:

evaluated_graph (MovieGraphEvaluatedConfig) – The evaluated graph that will provide context for resolving the resolution

Returns:

The output resolution, taking into account overscan

Return type:

IntPoint

classmethod get_estimated_time_remaining(movie_graph_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:

movie_graph_pipeline (MovieGraphPipeline) – 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_graph_pipeline) → Text

Gets the author of the current job, or the logged in user’s username if the job has no specified author.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get the job author from.

Return type:

Text

classmethod get_job_initialization_time(movie_graph_pipeline) → DateTime

Gets the time the job was initialized.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get the job initialization time from.

Return type:

DateTime

classmethod get_job_name(movie_graph_pipeline) → Text

Gets the name of the current job.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get the job name from.

Return type:

Text

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

Determines the overall current frame number and total number of frames.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get the frame information from.

Returns:

out_current_index (int32): The current frame number.

out_total_count (int32): The total number of frames.

Return type:

tuple

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

Gets the number of segments (shots) that will be rendered.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get segment information from.

Returns:

out_current_index (int32):

out_total_count (int32):

Return type:

tuple

classmethod get_pipeline_state(movie_graph_pipeline) → MovieRenderPipelineState

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

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get the state for.

Returns:

The current state.

Return type:

MovieRenderPipelineState

classmethod get_root_frame_number(movie_graph_pipeline) → FrameNumber

Gets the frame number of the current render at the root (sequence) level.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get frame number information from.

Return type:

FrameNumber

classmethod get_root_timecode(movie_graph_pipeline) → Timecode

Gets the timecode of the current render at the root (sequence) level.

Parameters:

movie_graph_pipeline (MovieGraphPipeline) – The pipeline to get timecode information from.

Return type:

Timecode

classmethod is_named_resolution_valid(resolution_profile_name) → bool

Utility function for checking if a given resolution profile name is valid, since NamedResolutionFromProfile will throw a kismet exception, but blueprints can’t actually try/catch them.

Parameters:

resolution_profile_name (Name) –

Return type:

bool

classmethod named_resolution_from_profile(resolution_profile_name) → MovieGraphNamedResolution

Create a Named Resolution from the profile name. Throws a Kismet Exception if the profile name isn’t found. The known profiles can be found in UMovieGraphProjectSettings’s CDO.

Parameters:

resolution_profile_name (Name) –

Return type:

MovieGraphNamedResolution

classmethod named_resolution_from_size(res_x, res_y) → MovieGraphNamedResolution

Create a Named Resolution from the given resolution. Given named resolution will be named “Custom”.

Parameters:

  • res_x (int32) –

  • res_y (int32) –

Return type:

MovieGraphNamedResolution

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

Takes a Movie Graph format string (in the form of {token}), a list of parameters (which normally come from the running UMovieGraphPipeline) and resolves them into a string. Unknown tokens are ignored. Which tokens can be resolved depends on the contents of InParams, tokens from settings rely on a evaluated config being provided, etc.

Parameters:

  • format_string (str) – Format string to attempt to resolve. Leave blank if just the format args should be populated.

  • params (MovieGraphFilenameResolveParams) – A list of parameters to use as source data for the resolve step. Normally comes from the UMovieGraphPipeline instance, - but takes (mostly) POD here to allow using this function outside of the render runtime.

Returns:

The resolved format string. Returns an empty string if InFormatString is blank.

out_merged_format_args (MovieGraphResolveArgs): The set of KVP for both filename formats and file metadata that is generated as a result of this. Provided in case you - needed to do your own string resolving with the final dataset.

Return type:

MovieGraphResolveArgs

classmethod resolve_version_number(params, get_next_version=True) → int32

If the version number is explicitly specified on the Output Setting node, returns that. Otherwise searches the output directory for the highest version that already exists (and increments it by one if bGetNextVersion is true). Returns -1 if the version could not be resolved.

Parameters:
Return type:

int32