unreal.MoviePipelineBasicConfig

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

Bases: Object

A simplified configuration for Movie Render Queue jobs. Provides a pared-down set of rendering options that generates a UMovieGraphConfig just-in-time before rendering. This allows most users to configure renders without touching Presets or Graphs, while still using the full graph pipeline under the hood.

C++ Source:

• Plugin: MovieRenderPipeline

• Module: MovieRenderPipelineCore

• File: MoviePipelineBasicConfig.h

Editor Properties: (see get_editor_property/set_editor_property)

• burn_in_class (SoftClassPath): [Read-Write] The burn-in widget class to use on all output types that support burn-in. Only applies if the burn-in override is enabled. Burn-ins are enabled for all output types that support them, and compositing is enabled for all output types that support burn-in compositing.

• custom_end_frame (int32): [Read-Write] A custom end frame, overriding the sequence’s playback range end.

• custom_start_frame (int32): [Read-Write] A custom start frame, overriding the sequence’s playback range start.

• deferred_anti_aliasing_method (AntiAliasingMethod): [Read-Write] Anti-aliasing method for the Deferred Renderer.

• deferred_spatial_sample_count (int32): [Read-Write] Spatial sample count for the Deferred Renderer.

• enabled_output_types (Array[Class]): [Read-Write] The output types that rendered media should be saved to.

• file_name_format (str): [Read-Write] The format string for file names. Can include folder prefixes, and format string tokens ({shot_name}, etc.)

• num_warm_up_frames (int32): [Read-Write] The number of frames to run (without producing output) at the start of each shot to warm up systems like Niagara, Chaos, etc.

• output_directory (DirectoryPath): [Read-Write] The directory all the output files are relative to.

• output_resolution (MovieGraphNamedResolution): [Read-Write] The resolution that output files are exported at.

• override_b_use_deferred_renderer (bool): [Read-Write]

• override_b_use_path_traced_renderer (bool): [Read-Write]

• override_burn_in_class (bool): [Read-Write]

• override_custom_end_frame (bool): [Read-Write] Whether to override the sequence’s playback range end. Playback range overrides are only job-level settings.

• override_custom_start_frame (bool): [Read-Write] Whether to override the sequence’s playback range start. Playback range overrides are only job-level settings.

• override_deferred_anti_aliasing_method (bool): [Read-Write] Whether to override the project’s anti-aliasing method. For shots, this overrides the job’s anti-aliasing method.

• override_deferred_spatial_sample_count (bool): [Read-Write]

• override_enabled_output_types (bool): [Read-Write]

• override_file_name_format (bool): [Read-Write]

• override_num_warm_up_frames (bool): [Read-Write]

• override_output_directory (bool): [Read-Write] — Override flags. Some are shot-only gates, while others also act as Basic config enable flags. —

• override_output_resolution (bool): [Read-Write]

• override_path_traced_denoiser_type (bool): [Read-Write] Whether to enable the path traced denoiser. For shots, this overrides the job’s denoiser setting.

• override_path_traced_spatial_sample_count (bool): [Read-Write]

• override_temporal_sample_count (bool): [Read-Write]

• path_traced_denoiser_type (MoviePipelineBasicDenoiserType): [Read-Write] If denoising is enabled, this specifies the specific denoiser that path tracer results should be passed to.

• path_traced_spatial_sample_count (int32): [Read-Write] Spatial sample count for the Path Traced Renderer.

• temporal_sample_count (int32): [Read-Write] The number of temporal sub-samples per output frame. Higher values will reduce temporal aliasing.

• use_deferred_renderer (bool): [Read-Write] Whether the deferred renderer should be enabled.

• use_path_traced_renderer (bool): [Read-Write] Whether the path tracer should be enabled.

property burn_in_class: SoftClassPath

[Read-Write] The burn-in widget class to use on all output types that support burn-in. Only applies if the burn-in override is enabled. Burn-ins are enabled for all output types that support them, and compositing is enabled for all output types that support burn-in compositing.

Type:

(SoftClassPath)

property custom_end_frame: int

[Read-Write] A custom end frame, overriding the sequence’s playback range end.

Type:

(int32)

property custom_start_frame: int

[Read-Write] A custom start frame, overriding the sequence’s playback range start.

Type:

(int32)

property deferred_anti_aliasing_method: AntiAliasingMethod

[Read-Write] Anti-aliasing method for the Deferred Renderer.

Type:

(AntiAliasingMethod)

property deferred_spatial_sample_count: int

[Read-Write] Spatial sample count for the Deferred Renderer.

Type:

(int32)

property enabled_output_types: None

[Read-Write] The output types that rendered media should be saved to.

Type:

(Array[Class])

property file_name_format: str

[Read-Write] The format string for file names. Can include folder prefixes, and format string tokens ({shot_name}, etc.)

Type:

(str)

property num_warm_up_frames: int

[Read-Write] The number of frames to run (without producing output) at the start of each shot to warm up systems like Niagara, Chaos, etc.

Type:

(int32)

property output_directory: DirectoryPath

[Read-Write] The directory all the output files are relative to.

Type:

(DirectoryPath)

property output_resolution: MovieGraphNamedResolution

[Read-Write] The resolution that output files are exported at.

Type:

(MovieGraphNamedResolution)

property override_b_use_deferred_renderer: bool

[Read-Write]

Type:

(bool)

property override_b_use_path_traced_renderer: bool

[Read-Write]

Type:

(bool)

property override_burn_in_class: bool

[Read-Write]

Type:

(bool)

property override_custom_end_frame: bool

[Read-Write] Whether to override the sequence’s playback range end. Playback range overrides are only job-level settings.

Type:

(bool)

property override_custom_start_frame: bool

[Read-Write] Whether to override the sequence’s playback range start. Playback range overrides are only job-level settings.

Type:

(bool)

property override_deferred_anti_aliasing_method: bool

[Read-Write] Whether to override the project’s anti-aliasing method. For shots, this overrides the job’s anti-aliasing method.

Type:

(bool)

property override_deferred_spatial_sample_count: bool

[Read-Write]

Type:

(bool)

property override_enabled_output_types: bool

[Read-Write]

Type:

(bool)

property override_file_name_format: bool

[Read-Write]

Type:

(bool)

property override_num_warm_up_frames: bool

[Read-Write]

Type:

(bool)

property override_output_directory: bool

[Read-Write] — Override flags. Some are shot-only gates, while others also act as Basic config enable flags. —

Type:

(bool)

property override_output_resolution: bool

[Read-Write]

Type:

(bool)

property override_path_traced_denoiser_type: bool

[Read-Write] Whether to enable the path traced denoiser. For shots, this overrides the job’s denoiser setting.

Type:

(bool)

property override_path_traced_spatial_sample_count: bool

[Read-Write]

Type:

(bool)

property override_temporal_sample_count: bool

[Read-Write]

Type:

(bool)

property path_traced_denoiser_type: MoviePipelineBasicDenoiserType

[Read-Write] If denoising is enabled, this specifies the specific denoiser that path tracer results should be passed to.

Type:

(MoviePipelineBasicDenoiserType)

property path_traced_spatial_sample_count: int

[Read-Write] Spatial sample count for the Path Traced Renderer.

Type:

(int32)

property temporal_sample_count: int

[Read-Write] The number of temporal sub-samples per output frame. Higher values will reduce temporal aliasing.

Type:

(int32)

property use_deferred_renderer: bool

[Read-Write] Whether the deferred renderer should be enabled.

Type:

(bool)

property use_path_traced_renderer: bool

[Read-Write] Whether the path tracer should be enabled.

Type:

(bool)