Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintFunctionLibrary → UMoviePipelineBlueprintLibrary
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UMovieSceneSequence * DuplicateSequence
(
UObject* Outer, |
Duplicates the specified sequence using a medium depth copy. | MoviePipelineBlueprintLibrary.h |
|
static UMoviePipelineSetting * FindOrGetDefaultSettingForShot
(
TSubclassOf< UMoviePipelineSetting > InSettingType, |
Allows access to a setting of provided type for specific shot. | MoviePipelineBlueprintLibrary.h |
|
static FIntPoint GetBackbufferResolution
(
const UMoviePipelinePrimaryConfig* InPrimaryConfig, |
Gets the resolution that will be used by the engine when rendering a frame. | MoviePipelineBlueprintLibrary.h |
|
static float GetCompletionPercentage
(
const UMoviePipeline* InPipeline |
Gets the completion percent of the Pipeline in 0-1 | MoviePipelineBlueprintLibrary.h |
|
static float GetCurrentAperture
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static UMoviePipelineExecutorShot * GetCurrentExecutorShot
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static float GetCurrentFocalLength
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static float GetCurrentFocusDistance
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static void GetCurrentSegmentName
(
UMoviePipeline* InMoviePipeline, |
MoviePipelineBlueprintLibrary.h |
|
|
static EMovieRenderShotState GetCurrentSegmentState
(
UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static FMoviePipelineSegmentWorkMetrics GetCurrentSegmentWorkMetrics
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static ULevelSequence * GetCurrentSequence
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static FFrameNumber GetCurrentShotFrameNumber
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static FTimecode GetCurrentShotTimecode
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
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 |
|
static FIntPoint GetDesiredOutputResolution
(
const UMoviePipelinePrimaryConfig* InPrimaryConfig |
Gets the desired output resolution for the movie render queue as specified by the user. | MoviePipelineBlueprintLibrary.h |
|
static FIntPoint GetEffectiveOutputResolution
(
UMoviePipelinePrimaryConfig* InPrimaryConfig, |
In case of Overscan percentage being higher than 0 we render additional pixels. | MoviePipelineBlueprintLibrary.h |
|
static bool GetEstimatedTimeRemaining
(
const UMoviePipeline* InPipeline, |
Get the estimated amount of time remaining for the current pipeline. | MoviePipelineBlueprintLibrary.h |
|
static FText GetJobAuthor
(
UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static FDateTime GetJobInitializationTime
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static FText GetJobName
(
UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static FString GetMapPackageName
(
UMoviePipelineExecutorJob* InJob |
Get the package name for the map in this job. | MoviePipelineBlueprintLibrary.h |
|
static FText GetMoviePipelineEngineChangelistLabel
(
const UMoviePipeline* InMoviePipeline |
Get a string to represent the Changelist Number for the burn in. | MoviePipelineBlueprintLibrary.h |
|
static void GetOverallOutputFrames
(
const UMoviePipeline* InMoviePipeline, |
MoviePipelineBlueprintLibrary.h |
|
|
static void GetOverallSegmentCounts
(
const UMoviePipeline* InMoviePipeline, |
MoviePipelineBlueprintLibrary.h |
|
|
static FIntRect GetOverscanCropRectangle
(
const UMoviePipelinePrimaryConfig* InPrimaryConfig, |
Gets a rectangle that will crop out any overscan applied to the scene. | MoviePipelineBlueprintLibrary.h |
|
static FIntPoint GetOverscannedResolution
(
const UMoviePipelinePrimaryConfig* InPrimaryConfig, |
Gets the overscanned resolution, which is the target output resolution scaled by any configured overscan amount | MoviePipelineBlueprintLibrary.h |
|
static EMovieRenderPipelineState GetPipelineState
(
const UMoviePipeline* InPipeline |
Get the current state of the specified Pipeline. | MoviePipelineBlueprintLibrary.h |
|
static FFrameNumber GetRootFrameNumber
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static FTimecode GetRootTimecode
(
const UMoviePipeline* InMoviePipeline |
MoviePipelineBlueprintLibrary.h |
|
|
static UMoviePipelineQueue * LoadManifestFileFromString
(
const FString& InManifestFilePath |
Loads the specified manifest file and converts it into an UMoviePipelineQueue. | MoviePipelineBlueprintLibrary.h |
|
static void ResolveFilenameFormatArguments
(
const FString& InFormatString, |
Resolves the provided InFormatString by converting {format_strings} into settings provided by the primary config. | MoviePipelineBlueprintLibrary.h |
|
static int32 ResolveVersionNumber
(
FMoviePipelineFilenameResolveParams InParams, |
If version number is manually specified by the Job, returns that. | MoviePipelineBlueprintLibrary.h |
|
static void UpdateJobShotListFromSequence
(
ULevelSequence* InSequence, |
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 |
|
static UCineCameraComponent * Utility_GetCurrentCineCamera
(
const UWorld* InWorld |
Get the current cine camera in use, or nullptr if there is none. | MoviePipelineBlueprintLibrary.h |