1. Epic GamesDeveloper
  3. UMovieGraphCommandLineEncoderNode

UMovieGraphCommandLineEncoderNode

A node which kicks off an encode process after all renders have completed.

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

A node which kicks off an encode process after all renders have completed.

   
Name UMovieGraphCommandLineEncoderNode
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/Nodes/MovieGraphCommandLineEncoderNode.h
Include Path #include "Graph/Nodes/MovieGraphCommandLineEncoderNode.h"

Syntax

UCLASS (MinimalAPI)  
class UMovieGraphCommandLineEncoderNode :  
    public UMovieGraphSettingNode ,  
    public IMovieGraphPostRenderNode

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieGraphCommandLineEncoderNode()

   Graph/Nodes/MovieGraphCommandLineEncoderNode.h  

Structs

Name Remarks
FActiveJob  
FEncoderParams  

Constants

Name Type Remarks Include Path
ActiveEncodeJobs TArray< FActiveJob > The pipeline generates many instances of the same node throughout its execution; however, some nodes need to have persistent data throughout the pipeline's lifetime. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
CachedPipeline TWeakObjectPtr< UMovieGraphPipeline > The pipeline that started the export. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
PrimaryJobEvaluatedGraph TObjectPtr< UMovieGraphEvaluatedConfig > The job-level graph that should be accessed during execution of the node. Graph/Nodes/MovieGraphCommandLineEncoderNode.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AudioCodec FString Which audio codec should we use? Run 'MovieRenderPipeline.DumpCLIEncoderCodecs' for options. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="General"
  • Meta=(EditCondition="bOverride_AudioCodec")
AudioInputStringFormat FString Format string used for each audio input. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Command Line Arguments"
  • Meta=(EditCondition="bOverride_AudioInputStringFormat", MultiLine=true)
bDeleteSourceFiles bool Whether the source files should be deleted on disk after encoding. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="General"
  • Meta=(EditCondition="bOverride_bDeleteSourceFiles")
bOverride_AudioCodec uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_AudioInputStringFormat uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bDeleteSourceFiles uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bRetainInputTextFiles uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_bSkipEncodeOnRenderCanceled uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_CommandLineFormat uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_EncodeSettings uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_FileNameFormat uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_OutputFileExtension uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_VideoCodec uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bOverride_VideoInputStringFormat uint8   Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Overrides
  • Meta=(InlineEditConditionToggle)
bRetainInputTextFiles bool Retain the intermediate audio and video input text files that are passed to the encoder. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Debug"
  • Meta=(EditCondition="bOverride_bRetainInputTextFiles")
bSkipEncodeOnRenderCanceled bool Whether encoding should be skipped on frames produced if rendering was canceled before finishing. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="General"
  • Meta=(EditCondition="bOverride_bSkipEncodeOnRenderCanceled")
CommandLineFormat FString The format string used when building the final command line argument to launch. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Command Line Arguments"
  • Meta=(EditCondition="bOverride_CommandLineFormat", MultiLine=true)
EncodeSettings FString Additional flags used for specifying encode quality. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Command Line Arguments"
  • Meta=(EditCondition="bOverride_EncodeSettings", MultiLine=true)
FileNameFormat FString File name format string override. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="General"
  • Meta=(EditCondition="bOverride_FileNameFormat")
OutputFileExtension FString Extension for the output files. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="General"
  • Meta=(EditCondition="bOverride_OutputFileExtension")
VideoCodec FString Which video codec should we use? Run 'MovieRenderPipeline.DumpCLIEncoderCodecs' for options. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="General"
  • Meta=(EditCondition="bOverride_VideoCodec")
VideoInputStringFormat FString Format string used for each video input. Graph/Nodes/MovieGraphCommandLineEncoderNode.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Command Line Arguments"
  • Meta=(EditCondition="bOverride_VideoInputStringFormat", MultiLine=true)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void StartEncodingProcess ( TArray< FMovieGraphRenderOutputData >& InGeneratedData,
const bool bInIsShotEncode
)

 Begins the encode process (as long as there are no validation errors). Graph/Nodes/MovieGraphCommandLineEncoderNode.h  

Overridden from UMovieGraphNode

Name Remarks Include Path Unreal Specifiers

virtual EMovieGraphBranchRestriction GetBranchRestriction()

 Determines which types of branches the node can be created in. Graph/Nodes/MovieGraphCommandLineEncoderNode.h  

virtual FSlateIcon GetIconAndTint ( FLinearColor& OutColor
) const

 Gets the node's icon and icon tint, as visible in the graph. Graph/Nodes/MovieGraphCommandLineEncoderNode.h  

virtual FText GetMenuCategory()

 Gets the category that the node belongs under. Graph/Nodes/MovieGraphCommandLineEncoderNode.h  

virtual FText GetNodeTitle ( const bool bGetDescriptive
) const

 Gets the node's title. Graph/Nodes/MovieGraphCommandLineEncoderNode.h  

virtual FLinearColor GetNodeTitleColor()

 Gets the node's title color, as visible in the graph. Graph/Nodes/MovieGraphCommandLineEncoderNode.h  

Overridden from IMovieGraphPostRenderNode

Name Remarks Include Path Unreal Specifiers

virtual void BeginExport ( UMovieGraphPipeline* InMoviePipeline,
TObjectPtr< UMovieGraphEvaluatedConfig >& InPrimaryJobEvaluatedGraph
)

 Begins the export process for this node after all shots have completed. Graph/Nodes/MovieGraphCommandLineEncoderNode.h  

virtual void BeginShotExport ( UMovieGraphPipeline* InMoviePipeline
)

 Begins the export process for this node after an individual shot completes. Graph/Nodes/MovieGraphCommandLineEncoderNode.h  

virtual bool HasFinishedExporting()

 Returns true if this node has finished its export process, else false. Graph/Nodes/MovieGraphCommandLineEncoderNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page