unreal.MoviePipelineMasterConfig

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

Bases: unreal.MoviePipelineConfigBase

This class describes the main configuration for a Movie Render Pipeline. Only settings that apply to the entire output should be stored here, anything that is changed on a per-shot basis should be stored inside of UMovieRenderShotConfig instead.

THIS CLASS SHOULD BE IMMUTABLE ONCE PASSED TO THE PIPELINE FOR PROCESSING. (Otherwise you will be modifying the instance that exists in the UI)

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MoviePipelineMasterConfig.h

Editor Properties: (see get_editor_property/set_editor_property)

  • settings (Array(MoviePipelineSetting)): [Read-Only] Array of settings classes that affect various parts of the output pipeline.

get_all_settings(include_disabled_settings=False, include_transient_settings=False)

Get All Settings

Parameters
  • include_disabled_settings (bool) –

  • include_transient_settings (bool) –

Returns

Return type

Array(MoviePipelineSetting)

get_effective_frame_rate(sequence)FrameRate

Returns the frame rate override from the Master Configuration (if any) or the Sequence frame rate if no override is specified. This should be treated as the actual output framerate of the overall Pipeline.

Parameters

sequence (LevelSequence) –

Returns

Return type

FrameRate

get_transient_settings()

Get Transient Settings

Returns

Return type

Array(MoviePipelineSetting)

initialize_transient_settings()None

Initializes a single instance of every setting so that even non-user-configured settings have a chance to apply their default values. Does nothing if they’re already instanced for this configuration.