1. Epic GamesDeveloper
  3. UMoviePipelinePrimaryConfig

UMoviePipelinePrimaryConfig

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

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

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)

   
Name UMoviePipelinePrimaryConfig
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelinePrimaryConfig.h
Include Path #include "MoviePipelinePrimaryConfig.h"

Syntax

UCLASS (MinimalAPI, Blueprintable)  
class UMoviePipelinePrimaryConfig : public UMoviePipelineConfigBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMoviePipelinePrimaryConfig()

   MoviePipelinePrimaryConfig.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
PerShotConfigMapping TMap< FString, TObjectPtr< UMoviePipelineShotConfig > > A mapping of Shot Name -> Shot Config to use for rendering specific shots with specific configs. MoviePipelinePrimaryConfig.h
  • Instanced

Protected

Name Type Remarks Include Path Unreal Specifiers
OutputSetting TObjectPtr< UMoviePipelineOutputSetting >   MoviePipelinePrimaryConfig.h
  • Instanced
TransientSettings TArray< TObjectPtr< UMoviePipelineSetting > > An array of settings that are available in the engine and have not been edited by the user. MoviePipelinePrimaryConfig.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

TArray< UMoviePipelineSetting * > GetAllSettings ( const bool bIncludeDisabledSettings,
const bool bIncludeTransientSettings
) const

   MoviePipelinePrimaryConfig.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

UMoviePipelineShotConfig * GetConfigForShot ( const FString& ShotName
) const

 Returns a pointer to the config specified for the shot, otherwise the default for this pipeline. MoviePipelinePrimaryConfig.h  

FFrameRate GetEffectiveFrameRate ( const ULevelSequence* InSequence
) const

 Returns the frame rate override from the Primary Configuration (if any) or the Sequence frame rate if no override is specified. MoviePipelinePrimaryConfig.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

TRange< FFrameNumber > GetEffectivePlaybackRange ( const ULevelSequence* InSequence
) const

   MoviePipelinePrimaryConfig.h  

void GetFormatArguments ( FMoviePipelineFormatArgs& InOutFormatArgs,
const bool bIncludeAllSettings
) const

   MoviePipelinePrimaryConfig.h  

TArray< UMoviePipelineOutputBase * > GetOutputContainers()

   MoviePipelinePrimaryConfig.h  

TArray< UMoviePipelineSetting * > GetTransientSettings()

   MoviePipelinePrimaryConfig.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"
Initializes a single instance of every setting so that even non-user-configured settings have a chance to apply their default values. MoviePipelinePrimaryConfig.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

Overridden from UMoviePipelineConfigBase

Name Remarks Include Path Unreal Specifiers

virtual void CopyFrom ( UMoviePipelineConfigBase* InConfig
)

 Copy this configuration from another existing configuration. MoviePipelinePrimaryConfig.h  

virtual TArray< UMoviePipelineSetting * > GetUserSettings()

 Returns an array of all settings in this config that the user has added via the UI or via Scripting. MoviePipelinePrimaryConfig.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddTransientSettingByClass ( const UClass* InSettingClass
)

   MoviePipelinePrimaryConfig.h  

Overridden from UMoviePipelineConfigBase

Name Remarks Include Path Unreal Specifiers

virtual bool CanSettingBeAdded ( const UMoviePipelineSetting* InSetting
) const

   MoviePipelinePrimaryConfig.h  

virtual void OnSettingAdded ( UMoviePipelineSetting* InSetting
)

   MoviePipelinePrimaryConfig.h  

virtual void OnSettingRemoved ( UMoviePipelineSetting* InSetting
)

   MoviePipelinePrimaryConfig.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page