1. Epic GamesDeveloper
  3. UMovieGraphBlueprintLibrary

UMovieGraphBlueprintLibrary

API > API/Plugins > API/Plugins/MovieRenderPipelineCore > API/Plugins/MovieRenderPipelineCore/Graph

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • UMovieGraphBlueprintLibrary

References

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

Syntax

UCLASS (Meta=(ScriptName="MovieGraphLibrary"))  
class UMovieGraphBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

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

GetCurrentAperture ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the aperture for the camera currently in use.
Public function Static UFunction BlueprintPure, Category UCineCameraComponent *

GetCurrentCineCamera ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the currently active cine camera, or nullptr if one was not found.
Public function Static UFunction BlueprintPure, Category float

GetCurrentFocalLength ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the focal length for the camera currently in use.
Public function Static UFunction BlueprintPure, Category float

GetCurrentFocusDistance ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the focus distance for the camera currently in use.
Public function Static UFunction BlueprintPure, Category void

GetCurrentSegmentName ( const UMovieGraphPipeline* InMovieGraphPipeline,
FText& OutOuterName,
FText& OutInnerName
)

 Gets the name of the segment (shot) currently being rendered.
Public function Static UFunction BlueprintPure, Category EMovieRenderShotState

GetCurrentSegmentState ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the state of the segment (shot) currently being rendered.
Public function Static UFunction BlueprintPure, Category FMoviePipelineSegmentWorkMetrics

GetCurrentSegmentWorkMetrics ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the work metrics for the segment (shot) that is currently being rendered.
Public function Static UFunction BlueprintPure, Category FFrameNumber

GetCurrentShotFrameNumber ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the frame number of the current render at the shot level.
Public function Static UFunction BlueprintPure, Category FTimecode

GetCurrentShotTimecode ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the timecode of the current render at the shot level.
Public function Static UFunction BlueprintCallable, Category FFrameRate

GetEffectiveFrameRate ( UMovieGraphGlobalOutputSettingNode* InNode,
const FFrameRate& InDefaultRate
)

 If InNode is valid, inspects the provided OutputsettingNode to determine if it wants to override the Frame Rate, and if so, returns the overwritten frame rate.
Public function Static UFunction BlueprintCallable, Category FIntPoint In case of overscan percentage being higher than 0, additional pixels are rendered.
Public function Static UFunction BlueprintPure, Category bool

GetEstimatedTimeRemaining ( const UMovieGraphPipeline* InMovieGraphPipeline,
FTimespan& OutEstimate
)

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

GetJobAuthor ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the author of the current job, or the logged in user's username if the job has no specified author.
Public function Static UFunction BlueprintPure, Category FDateTime

GetJobInitializationTime ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the time the job was initialized.
Public function Static UFunction BlueprintPure, Category FText

GetJobName ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the name of the current job.
Public function Static UFunction BlueprintPure, Category void

GetOverallOutputFrames ( const UMovieGraphPipeline* InMovieGraphPipeline,
int32& OutCurrentIndex,
int32& OutTotalCount
)

 Determines the overall current frame number and total number of frames.
Public function Static UFunction BlueprintPure, Category void

GetOverallSegmentCounts ( const UMovieGraphPipeline* InMovieGraphPipeline,
int32& OutCurrentIndex,
int32& OutTotalCount
)

 Gets the number of segments (shots) that will be rendered.
Public function Static UFunction BlueprintPure, Category EMovieRenderPipelineState

GetPipelineState ( const UMovieGraphPipeline* InMovieGraphPipeline
)

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

GetRootFrameNumber ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the frame number of the current render at the root (sequence) level.
Public function Static UFunction BlueprintPure, Category FTimecode

GetRootTimecode ( const UMovieGraphPipeline* InMovieGraphPipeline
)

 Gets the timecode of the current render at the root (sequence) level.
Public function Static UFunction BlueprintPure, Category bool

IsNamedResolutionValid ( const FName& InResolutionProfileName
)

 Utility function for checking if a given resolution profile name is valid, since NamedResolutionFromProfile will throw a kismet exception, but blueprints can't actually try/catch them.
Public function Static UFunction BlueprintPure, Category FMovieGraphNamedResolution

NamedResolutionFromProfile ( const FName& InResolutionProfileName
)

 Create a Named Resolution from the profile name.
Public function Static UFunction BlueprintPure, Category FMovieGraphNamedResolution

NamedResolutionFromSize ( const int32 InResX,
const int32 InResY
)

 Create a Named Resolution from the given resolution. Given named resolution will be named "Custom".
Public function Static UFunction BlueprintCallable, Category FString

ResolveFilenameFormatArguments ( const FString& InFormatString,
const FMovieGraphFilenameResolveParams& InParams,
FMovieGraphResolveArgs& OutMergedFormatArgs
)

 Takes a Movie Graph format string (in the form of {token}), a list of parameters (which normally come from the running UMovieGraphPipeline) and resolves them into a string.
Public function Static UFunction BlueprintCallable, Category int32

ResolveVersionNumber ( FMovieGraphFilenameResolveParams InParams,
const bool bGetNextVersion
)

 If the version number is explicitly specified on the Output Setting node, returns that.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page