Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MovieRenderPipelineCore > UMoviePipelineMasterConfig

Light Theme

Dark Theme

UMoviePipelineMasterConfig

This class describes the main configuration for a Movie Render Pipeline.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMoviePipelineConfigBase

UMoviePipelineMasterConfig

References

Module	MovieRenderPipelineCore
Header	/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineMasterConfig.h
Include	#include "MoviePipelineMasterConfig.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable)
class UMoviePipelineMasterConfig : public UMoviePipelineConfigBase

Remarks

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)

Variables

		Name	Description
	TMap< FString, ...	PerShotConfigMapping	A mapping of Shot Name -> Shot Config to use for rendering specific shots with specific configs.

Constructors

	Name	Description
	UMoviePipelineMasterConfig()

Functions

	Name	Description
void	AddTransientSettingByClass ( const UClass* InSettingClass )
TArray< UMov...	GetAllSettings()
UMoviePipeli...	GetConfigForShot ( const FString& ShotName )	Returns a pointer to the config specified for the shot, otherwise the default for this pipeline.
FFrameRate	GetEffectiveFrameRate ( const ULevelSequence* InSequen... )	Returns the frame rate override from the Master Configuration (if any) or the Sequence frame rate if no override is specified.
TRange< FFra...	GetEffectivePlaybackRange ( const ULevelSequence* InSequen... )
void	GetFilenameFormatArguments ( FMoviePipelineFormatArgs& InOutFor... )
TArray< UMov...	GetOutputContainers()
TArray< UMov...	GetTransientSettings()
void	InitializeTransientSettings()	Initializes a single instance of every setting so that even non-user-configured settings have a chance to apply their default values.

Overridden from UMoviePipelineConfigBase

	Name	Description
bool	CanSettingBeAdded ( const UMoviePipelineSetting* I... )
void	CopyFrom ( UMoviePipelineConfigBase* InCo... )	Copy this configuration from another existing configuration.
TArray< UMov...	GetUserSettings()	Returns an array of all settings in this config that the user has added via the UI or via Scripting.
void	OnSettingAdded ( UMoviePipelineSetting* InSetti... )
void	OnSettingRemoved ( UMoviePipelineSetting* InSetti... )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss