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 > API/Plugins/MovieRenderPipelineCore/Graph > API/Plugins/MovieRenderPipelineCore/Graph/Nodes

Inheritance Hierarchy

References

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

Syntax

UCLASS ()  
class UMovieGraphCommandLineEncoderNode :  
    public UMovieGraphSettingNode ,  
    public IMovieGraphPostRenderNode

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString AudioCodec Which audio codec should we use? Run 'MovieRenderPipeline.DumpCLIEncoderCodecs' for options.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString AudioInputStringFormat Format string used for each audio input.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bDeleteSourceFiles Whether the source files should be deleted on disk after encoding.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_AudioCodec  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_AudioInputStringFormat  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_bDeleteSourceFiles  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_bRetainInputTextFiles  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_bSkipEncodeOnRenderCanceled  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_CommandLineFormat  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_EncodeSettings  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_FileNameFormat  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_OutputFileExtension  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_VideoCodec  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite uint8: 1 bOverride_VideoInputStringFormat  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bRetainInputTextFiles Retain the intermediate audio and video input text files that are passed to the encoder.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bSkipEncodeOnRenderCanceled Whether encoding should be skipped on frames produced if rendering was canceled before finishing.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString CommandLineFormat The format string used when building the final command line argument to launch.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString EncodeSettings Additional flags used for specifying encode quality.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString FileNameFormat File name format string override.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString OutputFileExtension Extension for the output files.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString VideoCodec Which video codec should we use? Run 'MovieRenderPipeline.DumpCLIEncoderCodecs' for options.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString VideoInputStringFormat Format string used for each video input.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

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

 Begins the encode process (as long as there are no validation errors).

Overridden from UMovieGraphNode

  Type Name Description
Public function Virtual Const EMovieGraphBranchRestriction Determines which types of branches the node can be created in.
Public function Virtual Const FSlateIcon

GetIconAndTint ( FLinearColor& OutColor
)

 Gets the node's icon and icon tint, as visible in the graph.
Public function Virtual Const FText Gets the category that the node belongs under.
Public function Virtual Const FText

GetNodeTitle ( const bool bGetDescriptive
)

 Gets the node's title.
Public function Virtual Const FLinearColor Gets the node's title color, as visible in the graph.

Overridden from IMovieGraphPostRenderNode

  Type Name Description
Public function Virtual void

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

 Begins the export process for this node after all shots have completed.
Public function Virtual void

BeginShotExport ( UMovieGraphPipeline* InMoviePipeline
)

 Begins the export process for this node after an individual shot completes.
Public function Virtual bool Returns true if this node has finished its export process, else false.

Constants

Name Description
ActiveEncodeJobs 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.
CachedPipeline The pipeline that started the export.
PrimaryJobEvaluatedGraph The job-level graph that should be accessed during execution of the node.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page