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 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.
- 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:
pipeline_queue (MoviePipelineQueue) –
sequence (LevelSequence) –
- Return type:
- classmethod ensure_job_has_default_settings(job) None ¶
Ensure the job has the settings specified by the project settings added. If they’re already added we don’t modify the object so that we don’t make it confused about whether or not you’ve modified the preset.
- Parameters:
job (MoviePipelineExecutorJob) –
- 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:
config (MoviePipelinePrimaryConfig) –
package_path (str) –
file_name (str) –
save_asset (bool) –
- 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:
- 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.
- Parameters:
job (MoviePipelineExecutorJob) –
- Return type:
- 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: