1. Epic GamesDeveloper
  3. UMoviePipelineBlueprintLibrary

UMoviePipelineBlueprintLibrary

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

   
Name UMoviePipelineBlueprintLibrary
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineBlueprintLibrary.h
Include Path #include "MoviePipelineBlueprintLibrary.h"

Syntax

UCLASS (MinimalAPI, Meta=(ScriptName="MoviePipelineLibrary"))  
class UMoviePipelineBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers
Duplicates the specified sequence using a medium depth copy. MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

static UMoviePipelineSetting * FindOrGetDefaultSettingForShot ( TSubclassOf< UMoviePipelineSetting > InSettingType,
const UMoviePipelinePrimaryConfig* InPrimaryConfig,
const UMoviePipelineExecutorShot* InShot
)

 Allows access to a setting of provided type for specific shot. MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"
  • Meta=(DeterminesOutputType="InSettingType")

static FIntPoint GetBackbufferResolution ( const UMoviePipelinePrimaryConfig* InPrimaryConfig,
const UMoviePipelineExecutorShot* InPipelineExecutorShot,
float InDefaultOverscan
)

 Gets the resolution that will be used by the engine when rendering a frame. MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

static float GetCompletionPercentage ( const UMoviePipeline* InPipeline
)

 Gets the completion percent of the Pipeline in 0-1 MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static float GetCurrentAperture ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static UMoviePipelineExecutorShot * GetCurrentExecutorShot ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static float GetCurrentFocalLength ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static float GetCurrentFocusDistance ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

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

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static EMovieRenderShotState GetCurrentSegmentState ( UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FMoviePipelineSegmentWorkMetrics GetCurrentSegmentWorkMetrics ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static ULevelSequence * GetCurrentSequence ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FFrameNumber GetCurrentShotFrameNumber ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FTimecode GetCurrentShotTimecode ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static int32 GetCurrentVersionNumber ( const UMoviePipeline* InMoviePipeline
)

 Retrieves the cached version number calculated for the current shot, which depends on where the version token was used in the File Name Output ie: If {version} comes before {shot_name} then all shots will use the same version number, but if it comes afterwards then each shot may have a different version (which is the highest number found of that particular shot). MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FIntPoint GetDesiredOutputResolution ( const UMoviePipelinePrimaryConfig* InPrimaryConfig
)

 Gets the desired output resolution for the movie render queue as specified by the user. MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

static FIntPoint GetEffectiveOutputResolution ( UMoviePipelinePrimaryConfig* InPrimaryConfig,
UMoviePipelineExecutorShot* InPipelineExecutorShot,
float DefaultOverscan
)

 In case of Overscan percentage being higher than 0 we render additional pixels. MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use GetOverscannedResolution instead")

static bool GetEstimatedTimeRemaining ( const UMoviePipeline* InPipeline,
FTimespan& OutEstimate
)

 Get the estimated amount of time remaining for the current pipeline. MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FText GetJobAuthor ( UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FDateTime GetJobInitializationTime ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FText GetJobName ( UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"
Get the package name for the map in this job. MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FText GetMoviePipelineEngineChangelistLabel ( const UMoviePipeline* InMoviePipeline
)

 Get a string to represent the Changelist Number for the burn in. MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

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

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

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

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FIntRect GetOverscanCropRectangle ( const UMoviePipelinePrimaryConfig* InPrimaryConfig,
const UMoviePipelineExecutorShot* InPipelineExecutorShot,
float DefaultOverscan
)

 Gets a rectangle that will crop out any overscan applied to the scene. MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

static FIntPoint GetOverscannedResolution ( const UMoviePipelinePrimaryConfig* InPrimaryConfig,
const UMoviePipelineExecutorShot* InPipelineExecutorShot,
float InDefaultOverscan
)

 Gets the overscanned resolution, which is the target output resolution scaled by any configured overscan amount MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"
Get the current state of the specified Pipeline. MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FFrameNumber GetRootFrameNumber ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static FTimecode GetRootTimecode ( const UMoviePipeline* InMoviePipeline
)

   MoviePipelineBlueprintLibrary.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

static UMoviePipelineQueue * LoadManifestFileFromString ( const FString& InManifestFilePath
)

 Loads the specified manifest file and converts it into an UMoviePipelineQueue. MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

static 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. MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

static int32 ResolveVersionNumber ( FMoviePipelineFilenameResolveParams InParams,
bool bGetNextVersion
)

 If version number is manually specified by the Job, returns that. MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

static 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. MoviePipelineBlueprintLibrary.h
  • BlueprintCallable
  • Category="Movie Render Pipeline"

static UCineCameraComponent * Utility_GetCurrentCineCamera ( const UWorld* InWorld
)

 Get the current cine camera in use, or nullptr if there is none. MoviePipelineBlueprintLibrary.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page