unreal.MoviePipelineEditorLibrary

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

Bases: BlueprintFunctionLibrary

Movie Pipeline Editor Blueprint Library

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineEditor

  • File: MoviePipelineEditorBlueprintLibrary.h

classmethod apply_default_configuration_type_to_job(job) → None

Applies the user’s default configuration type to the given job.

Parameters:

job (MoviePipelineExecutorJob)

classmethod assign_default_graph_preset_to_job(job, create_transaction=True) → None

Assigns the project’s default graph configuration to the given job, and switches it to graph configuration mode.

Parameters:
classmethod convert_manifest_file_to_string(manifest_file_path) → str

Loads the specified manifest file and converts it into an FString to be embedded with HTTP REST requests. Use in combination with SaveQueueToManifestFile.

Parameters:

manifest_file_path (str)

Return type:

str

classmethod create_job_from_sequence(pipeline_queue, sequence) → MoviePipelineExecutorJob

Create a job from a level sequence. Sets the map as the currently editor world, the author, the sequence and the job name as the sequence name on the new job. Returns the newly created job.

Parameters:
Return type:

MoviePipelineExecutorJob

classmethod ensure_job_has_default_settings(job, force=False) → None

Ensure the job has the settings specified by the project settings added. Idempotent per-job: once defaults have been applied, subsequent calls are no-ops so that settings the user has deliberately removed won’t be resurrected. Pass bForce=true to re-apply after an explicit configuration reset (e.g. SetConfiguration to a fresh empty config).

Parameters:
classmethod export_config_to_asset(config, package_path, file_name, save_asset) → (out_asset=MoviePipelinePrimaryConfig, out_error_reason=Text) or None

Export Config to Asset

Parameters:
Returns:

out_asset (MoviePipelinePrimaryConfig):

out_error_reason (Text):

Return type:

tuple or None

classmethod get_display_output_path_from_job(job) → str or None

Returns display string for output directory for this job. Does not resolve the full path from tokens.

Parameters:

job (MoviePipelineExecutorJob)

Returns:

out_output_path (str):

Return type:

str or None

classmethod is_map_valid_for_remote_render(jobs) → bool

Checks to see if any of the Jobs try to point to maps that wouldn’t be valid on a remote render (ie: unsaved maps)

Parameters:

jobs (Array[MoviePipelineExecutorJob])

Return type:

bool

classmethod resolve_output_directory_from_job(job) → str

Resolves as much of the output directory for this job into a usable directory path as possible. Cannot resolve anything that relies on shot name, frame numbers, etc. Returns an empty string upon failure. see: TryResolveOutputDirectoryFromJob() for the same function which also provides the failure reason

Parameters:

job (MoviePipelineExecutorJob)

Return type:

str

classmethod save_basic_config_as_graph_config(job) → bool

Generates a UMovieGraphConfig from the job’s Basic config. Prompts the user to choose a save location via a Save Asset dialog, saves the asset to disk, then switches the job to Graph configuration mode using the newly saved asset.

Parameters:

job (MoviePipelineExecutorJob) – The job to convert. Must be using Basic configuration mode.

Returns:

true if the graph was saved and the job was switched; false if the job is not in Basic mode, graph generation or asset creation failed, the user canceled, or the save failed.

Return type:

bool

classmethod save_queue_to_manifest_file(pipeline_queue) -> (MoviePipelineQueue, out_manifest_file_path=str)

Take the specified Queue, duplicate it and write it to disk in the ../Saved/MovieRenderPipeline/ folder. Returns the duplicated queue.

Parameters:

pipeline_queue (MoviePipelineQueue)

Returns:

out_manifest_file_path (str):

Return type:

str

classmethod try_resolve_output_directory_from_job(job) -> (str, out_error=Text)

The same as ResolveOutputDirectoryFromJob: returns the resolved output directory, but reports an error string via OutError if resolution failed (e.g. graph traversal could not be completed). Returns an empty string on failure.

Parameters:

job (MoviePipelineExecutorJob)

Returns:

out_error (Text):

Return type:

Text

classmethod warn_user_of_unsaved_map() → None

Pop a dialog box that specifies that they cannot render due to never saved map. Only shows OK button.