UMoviePipelineBlueprintLibrary

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MovieRenderPipelineCore

Header

/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineBlueprintLibrary.h

Include

#include "MoviePipelineBlueprintLibrary.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Meta=(ScriptName="MoviePipelineLibrary"))
class UMoviePipelineBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category

UMovieSceneS...

 

DuplicateSequence

(
    UObject* Outer,
    UMovieSceneSequence* InSequenc...
)

Duplicates the specified sequence using a medium depth copy.

Public function Static UFunction BlueprintCallable, Category

UMoviePipeli...

 

FindOrGetDefaultSettingForShot

(
    TSubclassOf< UMoviePipelineSetting ...,
    const UMoviePipelineMasterConfig&#...,
    const UMoviePipelineExecutorShot&#...
)

Allows access to a setting of provided type for specific shot.

Public function Static UFunction BlueprintPure, Category

float

 

GetCompletionPercentage

(
    const UMoviePipeline* InPipeli...
)

Gets the completion percent of the Pipeline in 0-1

Public function Static UFunction BlueprintPure, Category

float

 

GetCurrentAperture

(
    const UMoviePipeline* InMovieP...
)

Public function Static UFunction BlueprintPure, Category

float

 

GetCurrentFocalLength

(
    const UMoviePipeline* InMovieP...
)

Public function Static UFunction BlueprintPure, Category

float

 

GetCurrentFocusDistance

(
    const UMoviePipeline* InMovieP...
)

Public function Static UFunction BlueprintPure, Category

void

 

GetCurrentSegmentName

(
    UMoviePipeline* InMoviePipelin...,
    FText& OutOuterName,
    FText& OutInnerName
)

Public function Static UFunction BlueprintPure, Category

EMovieRender...

 

GetCurrentSegmentState

(
    UMoviePipeline* InMoviePipelin...
)

Public function Static UFunction BlueprintPure, Category

FMoviePipeli...

 

GetCurrentSegmentWorkMetrics

(
    const UMoviePipeline* InMovieP...
)

Public function Static UFunction BlueprintPure, Category

FFrameNumber

 

GetCurrentShotFrameNumber

(
    const UMoviePipeline* InMovieP...
)

Public function Static UFunction BlueprintPure, Category

FTimecode

 

GetCurrentShotTimecode

(
    const UMoviePipeline* InMovieP...
)

Public function Static UFunction BlueprintCallable, Category

FIntPoint

 

GetEffectiveOutputResolution

(
    UMoviePipelineMasterConfig* In...,
    UMoviePipelineExecutorShot* In...
)

In case of Overscan percentage being higher than 0 we render additional pixels.

Public function Static UFunction BlueprintPure, Category

bool

 

GetEstimatedTimeRemaining

(
    const UMoviePipeline* InPipeli...,
    FTimespan& OutEstimate
)

Get the estimated amount of time remaining for the current pipeline.

Public function Static UFunction BlueprintPure, Category

FText

 

GetJobAuthor

(
    UMoviePipeline* InMoviePipelin...
)

Public function Static UFunction BlueprintPure, Category

FDateTime

 

GetJobInitializationTime

(
    const UMoviePipeline* InMovieP...
)

Public function Static UFunction BlueprintPure, Category

FText

 

GetJobName

(
    UMoviePipeline* InMoviePipelin...
)

Public function Static UFunction BlueprintPure, Category

FString

 

GetMapPackageName

(
    UMoviePipelineExecutorJob* InJ...
)

Get the package name for the map in this job.

Public function Static UFunction BlueprintPure, Category

FFrameNumber

 

GetMasterFrameNumber

(
    const UMoviePipeline* InMovieP...
)

Public function Static UFunction BlueprintPure, Category

FTimecode

 

GetMasterTimecode

(
    const UMoviePipeline* InMovieP...
)

Public function Static UFunction BlueprintPure, Category

void

 

GetOverallOutputFrames

(
    const UMoviePipeline* InMovieP...,
    int32& OutCurrentIndex,
    int32& OutTotalCount
)

Public function Static UFunction BlueprintPure, Category

void

 

GetOverallSegmentCounts

(
    const UMoviePipeline* InMovieP...,
    int32& OutCurrentIndex,
    int32& OutTotalCount
)

Public function Static UFunction BlueprintPure, Category

EMovieRender...

 

GetPipelineState

(
    const UMoviePipeline* InPipeli...
)

Get the current state of the specified Pipeline.

Public function Static UFunction BlueprintCallable, Category

void

 

ResolveFilenameFormatArguments

(
    const FString& InFormatString,
    const FMoviePipelineFilenameResolve...,
    FString& OutFinalPath,
    FMoviePipelineFormatArgs& OutMerge...
)

Resolves the provided InFormatString by converting {format_strings} into settings provided by the master config.

Public function Static UFunction BlueprintCallable, Category

int32

 

ResolveVersionNumber

If version number is manually specified by the Job, returns that.

Public function Static UFunction BlueprintCallable, Category

void

 

UpdateJobShotListFromSequence

(
    ULevelSequence* InSequence,
    UMoviePipelineExecutorJob* InJ...,
    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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss