UMoviePipelineOutputSetting | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/MovieRenderPipelineCore


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

Syntax

UCLASS (MinimalAPI, Blueprintable)  
class UMoviePipelineOutputSetting : public UMoviePipelineSetting

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineSetting → UMoviePipelineOutputSetting

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UMoviePipelineOutputSetting()		MoviePipelineOutputSetting.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bAutoVersion	bool	If true, version tokens will automatically be incremented with each local render.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Category="Versioning"
bFlushDiskWritesPerShot	bool	If true, the game thread will stall at the end of each shot to flush the rendering queue, and then flush any outstanding writes to disk, finalizing any outstanding videos and generally completing the work.	MoviePipelineOutputSetting.h	BlueprintReadWrite Category="File Output"
bOverrideExistingOutput	bool	If true, output containers should attempt to override any existing files with the same name.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Category="File Output"
bUseCustomFrameRate	bool	Should we use the custom frame rate specified by OutputFrameRate? Otherwise defaults to Sequence frame rate.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Category="File Output"
bUseCustomPlaybackRange	bool	If true, override the Playback Range start/end bounds with the bounds specified below.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Category="Frames"
CustomEndFrame	int32	Used when overriding the playback range.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Meta=(EditCondition=bUseCustomPlaybackRange) Category="Frames"
CustomStartFrame	int32	Used when overriding the playback range.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Meta=(EditCondition=bUseCustomPlaybackRange) Category="Frames"
DEBUG_OutputFrameStepOffset	int32	Experimental way to interleave renders between multiple computers.	MoviePipelineOutputSetting.h
FileNameFormat	FString	What format string should the final files use? Can include folder prefixes, and format string ({shot_name}, etc.)	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Category="File Output"
FrameNumberOffset	int32	How many frames should we offset the output frame number by? This is useful when using handle frames on Sequences that start at frame 0, as the output would start in negative numbers.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite AdvancedDisplay Category="File Output"
HandleFrameCount	int32	Top level shot track sections will automatically be expanded by this many frames in both directions, and the resulting additional time will be rendered as part of that shot.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Meta=(UIMin=0, ClampMin=0) Category="Frames"
OutputDirectory	FDirectoryPath	What directory should all of our output files be relative to.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Category="File Output"
OutputFrameRate	FFrameRate	What frame rate should the output files be exported at? This overrides the Display Rate of the target sequence.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Meta=(EditCondition=bUseCustomFrameRate) Category="File Output"
OutputFrameStep	int32	Render every Nth frame.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Meta=(UIMin="1", ClampMin="1") Category="Frames"
OutputResolution	FIntPoint	What resolution should our output files be exported at?	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Category="File Output"
VersionNumber	int32	The value to use for the version token if versions are not automatically incremented.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Meta=(EditCondition="!bAutoVersion", UIMin=1, UIMax=10, ClampMin=1) Category="Versioning"
ZeroPadFrameNumbers	int32	How many digits should all output frame numbers be padded to? MySequence_1.png -> MySequence_0001.png.	MoviePipelineOutputSetting.h	EditAnywhere BlueprintReadWrite Meta=(UIMin="1", UIMax="5", ClampMin="1") AdvancedDisplay Category="File Output"

Functions

Public

Overridden from UMoviePipelineSetting

Name	Remarks	Include Path
virtual bool CanBeDisabled()	Can this setting be disabled? UI only.	MoviePipelineOutputSetting.h
virtual FText GetDisplayText()	Warning: This gets called on the CDO of the object	MoviePipelineOutputSetting.h
virtual FText GetFooterText ( UMoviePipelineExecutorJob* InJob ) const	Return a string to show in the footer of the details panel.	MoviePipelineOutputSetting.h
virtual void GetFormatArguments ( FMoviePipelineFormatArgs& InOutFormatArgs ) const	Return Key/Value pairs that you wish to be usable in the Output File Name format string or file metadata.	MoviePipelineOutputSetting.h
virtual bool IsValidOnPrimary()	Can this configuration setting be added to the primary configuration? If not, it will throw an error when trying to add it to the primary configuration.	MoviePipelineOutputSetting.h
virtual bool IsValidOnShots()	Can this configuration setting be added to shots? If not, it will throw an error when trying to add it to a shot config.	MoviePipelineOutputSetting.h
virtual void SetupForPipelineImpl ( UMoviePipeline* InPipeline )		MoviePipelineOutputSetting.h
virtual void UpdateTelemetry ( FMoviePipelineShotRenderTelemetry* InTelemetry ) const	Updates telemetry data for this setting.	MoviePipelineOutputSetting.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostLoad()		MoviePipelineOutputSetting.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public

Overridden from UMoviePipelineSetting

Overridden from UObject