UMoviePipelineBlueprintLibrary::ResolveFilenameFormatArguments

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

Windows
MacOS
Linux

References

Module

MovieRenderPipelineCore

Header

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

Include

#include "MoviePipelineBlueprintLibrary.h"

Source

/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Private/MoviePipelineBlueprintLibrary.cpp

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Movie Render Pipeline")
static void ResolveFilenameFormatArguments
(
    const FString & InFormatString,
    const FMoviePipelineFilenameResolveParams & InParams,
    FString & OutFinalPath,
    FMoviePipelineFormatArgs & OutMergedFormatArgs
)

Remarks

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

Returns

OutMergedFormatArgs A merged set of Key/Value pairs for both Filename Arguments and Metadata that merges all the sources.

Parameters

Parameter

Description

InFormatString

A format string (in the form of "{format_key1}_{format_key2}") to resolve.

InParams

The parameters to resolve the format string with. See FMoviePipelineFilenameResolveParams properties for details. Expected that you fill out all of the parameters so that they can be used to resolve strings, otherwise default values may be used.

OutFinalPath

The final filepath based on a combination of the format string and the Resolve Params.

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