1. Epic GamesDeveloper
  3. UMoviePipelineBlueprintLibrary

UMoviePipelineBlueprintLibrary

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Meta&61;&40;ScriptName&61;"MoviePipelineLibrary"&41;&41;  
class UMoviePipelineBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category UMovieSceneSequence * Duplicates the specified sequence using a medium depth copy.
Public function Static UFunction BlueprintCallable, Category, Meta UMoviePipelineSetting * Allows access to a setting of provided type for specific shot.
Public function Static UFunction BlueprintPure, Category float

GetCompletionPercentage ( const UMoviePipeline* InPipeline
)

 Gets the completion percent of the Pipeline in 0-1
Public function Static UFunction BlueprintPure, Category float

GetCurrentAperture ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category UMoviePipelineExecutorShot *

GetCurrentExecutorShot ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category float

GetCurrentFocalLength ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category float

GetCurrentFocusDistance ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category void

GetCurrentSegmentName ( UMoviePipeline* InMoviePipeline,
FText& OutOuterName,
FText& OutInnerName
)

  
Public function Static UFunction BlueprintPure, Category EMovieRenderShotState

GetCurrentSegmentState ( UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category FMoviePipelineSegmentWorkMetrics

GetCurrentSegmentWorkMetrics ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category ULevelSequence *

GetCurrentSequence ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category FFrameNumber

GetCurrentShotFrameNumber ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category FTimecode

GetCurrentShotTimecode ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintCallable, Category FIntPoint In case of Overscan percentage being higher than 0 we render additional pixels.
Public function Static UFunction BlueprintPure, Category bool

GetEstimatedTimeRemaining ( const UMoviePipeline* InPipeline,
FTimespan& OutEstimate
)

 Get the estimated amount of time remaining for the current pipeline.
Public function Static UFunction BlueprintPure, Category FText

GetJobAuthor ( UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category FDateTime

GetJobInitializationTime ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category FText

GetJobName ( UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category FString Get the package name for the map in this job.
Public function Static UFunction BlueprintPure, Category FText Get a string to represent the Changelist Number for the burn in.
Public function Static UFunction BlueprintPure, Category void

GetOverallOutputFrames ( const UMoviePipeline* InMoviePipeline,
int32& OutCurrentIndex,
int32& OutTotalCount
)

  
Public function Static UFunction BlueprintPure, Category void

GetOverallSegmentCounts ( const UMoviePipeline* InMoviePipeline,
int32& OutCurrentIndex,
int32& OutTotalCount
)

  
Public function Static UFunction BlueprintPure, Category EMovieRenderPipelineState

GetPipelineState ( const UMoviePipeline* InPipeline
)

 Get the current state of the specified Pipeline.
Public function Static UFunction BlueprintPure, Category FFrameNumber

GetRootFrameNumber ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintPure, Category FTimecode

GetRootTimecode ( const UMoviePipeline* InMoviePipeline
)

  
Public function Static UFunction BlueprintCallable, Category UMoviePipelineQueue *

LoadManifestFileFromString ( const FString& InManifestFilePath
)

 Loads the specified manifest file and converts it into an UMoviePipelineQueue.
Public function Static UFunction BlueprintCallable, Category void

ResolveFilenameFormatArguments ( const FString& InFormatString,
const FMoviePipelineFilenameResolveParams& InParams,
FString& OutFinalPath,
FMoviePipelineFormatArgs& OutMergedFormatArgs
)

 Resolves the provided InFormatString by converting {format_strings} into settings provided by the primary config.
Public function Static UFunction BlueprintCallable, Category int32

ResolveVersionNumber ( FMoviePipelineFilenameResolveParams InParams,
bool bGetNextVersion
)

 If version number is manually specified by the Job, returns that.
Public function Static UFunction BlueprintCallable, Category void

UpdateJobShotListFromSequence ( ULevelSequence* InSequence,
UMoviePipelineExecutorJob* InJob,
bool& bShotsChanged
)

 Scan the provided sequence in the job to see which camera cut sections we would try to render and update the job's shotlist.

Deprecated Functions

  Type Name Description
Public function Static UFunction BlueprintPure, Category, Meta FFrameNumber

GetMasterFrameNumber ( const UMoviePipeline* InMoviePipeline
)

 GetMasterFrameNumber is deprecated. Please use GetRootFrameNumber instead
Public function Static UFunction BlueprintPure, Category, Meta FTimecode

GetMasterTimecode ( const UMoviePipeline* InMoviePipeline
)

 GetMasterTimecode is deprecated. Please use GetRootTimecode instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page