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 > UMoviePipelineCommandLineEncoder

Light Theme

Dark Theme

UMoviePipelineCommandLineEncoder

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMoviePipelineSetting

UMoviePipelineCommandLineEncoder

References

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

Syntax

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

Variables

	Name	Description
FString	AdditionalCommandLineArgs	Any additional arguments to pass to the CLI encode for this particular job.
bool	bDeleteSourceFiles	Should we delete the source files from disk after encoding?
bool	bSkipEncodeOnRenderCanceled	If a render was canceled (via hitting escape mid render) should we skip trying to encode the files we did produce?
FString	FileNameFormatOverride	File name format string override.
EMoviePipelineE...	Quality	What encoding quality to use for this job? Exact command line arguments for each one are specified in Project Settings.

Constructors

	Name	Description
	UMoviePipelineCommandLineEncoder()

Functions

		Name	Description
	FString	GetQualitySettingString()
	void	LaunchEncoder ( const FEncoderParams& InParams )
	bool	NeedsPerShotFlushing()
	void	OnTick()
	void	StartEncodingProcess ( TArray< FMoviePipelineShotOutputDat..., const bool bInIsShotEncode )

Overridden from UMoviePipelineSetting

	Name	Description
void	BeginExportImpl()	Called once when all files have been finalized.
bool	CanBeDisabled()	Can this setting be disabled? UI only.
FText	GetCategoryText()	Warning: This gets called on the CDO of the object
FText	GetDisplayText()	Warning: This gets called on the CDO of the object
bool	HasFinishedExportingImpl()	Has this setting finished any export-related things it needs to do post-finalize?
bool	IsValidOnMaster()	Can this configuration setting be added to the master configuration? If not, it will throw an error when trying to add it to the master configuration.
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.
void	SetupForPipelineImpl ( UMoviePipeline* InPipeline )
void	ValidateStateImpl()	Attempt to validate the configuration the user has chosen for this setting.

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

Take our survey

Dismiss