UMoviePipelineCommandLineEncoder | Unreal Engine 5.6 Documentation


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

Syntax

UCLASS (Blueprintable)  
class UMoviePipelineCommandLineEncoder : public UMoviePipelineSetting

Name	Remarks	Include Path	Unreal Specifiers
UMoviePipelineCommandLineEncoder()		MoviePipelineCommandLineEncoder.h

Name	Remarks
FActiveJob
FEncoderParams

Name	Type	Remarks	Include Path	Unreal Specifiers
AdditionalCommandLineArgs	FString	Any additional arguments to pass to the CLI encode for this particular job.	MoviePipelineCommandLineEncoder.h	EditAnywhere BlueprintReadWrite Category="Command Line Encoder"
bDeleteSourceFiles	bool	Should we delete the source files from disk after encoding?	MoviePipelineCommandLineEncoder.h	EditAnywhere BlueprintReadWrite Category="Command Line Encoder"
bSkipEncodeOnRenderCanceled	bool	If a render was canceled (via hitting escape mid render) should we skip trying to encode the files we did produce?	MoviePipelineCommandLineEncoder.h	EditAnywhere BlueprintReadWrite Category="Command Line Encoder"
bWriteEachFrameDuration	bool	Write the duration for each frame into the generated text file.	MoviePipelineCommandLineEncoder.h	EditAnywhere BlueprintReadWrite Category="Command Line Encoder"
FileNameFormatOverride	FString	File name format string override.	MoviePipelineCommandLineEncoder.h	EditAnywhere BlueprintReadWrite Category="Command Line Encoder"
Quality	EMoviePipelineEncodeQuality	What encoding quality to use for this job? Exact command line arguments for each one are specified in Project Settings.	MoviePipelineCommandLineEncoder.h	EditAnywhere BlueprintReadWrite Category="Command Line Encoder"

Name	Type	Remarks	Include Path	Unreal Specifiers
ActiveEncodeJobs	TArray< FActiveJob >		MoviePipelineCommandLineEncoder.h

Name	Remarks	Include Path	Unreal Specifiers
void StartEncodingProcess ( TArray< FMoviePipelineShotOutputData >& InOutData, const bool bInIsShotEncode )		MoviePipelineCommandLineEncoder.h

Name	Remarks	Include Path
virtual void BeginExportImpl()	Called once when all files have been finalized.	MoviePipelineCommandLineEncoder.h
virtual bool CanBeDisabled()	Can this setting be disabled? UI only.	MoviePipelineCommandLineEncoder.h
virtual FText GetCategoryText()	Warning: This gets called on the CDO of the object	MoviePipelineCommandLineEncoder.h
virtual FText GetDisplayText()	Warning: This gets called on the CDO of the object	MoviePipelineCommandLineEncoder.h
virtual bool HasFinishedExportingImpl()	Has this setting finished any export-related things it needs to do post-finalize?	MoviePipelineCommandLineEncoder.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.	MoviePipelineCommandLineEncoder.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.	MoviePipelineCommandLineEncoder.h
virtual void SetupForPipelineImpl ( UMoviePipeline* InPipeline )		MoviePipelineCommandLineEncoder.h
virtual void ValidateStateImpl ()	Attempt to validate the configuration the user has chosen for this setting.	MoviePipelineCommandLineEncoder.h

Name	Remarks	Include Path	Unreal Specifiers
FString GetQualitySettingString()		MoviePipelineCommandLineEncoder.h
void LaunchEncoder ( const FEncoderParams& InParams )		MoviePipelineCommandLineEncoder.h
bool NeedsPerShotFlushing()		MoviePipelineCommandLineEncoder.h
void OnTick()		MoviePipelineCommandLineEncoder.h