UMoviePipeline::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/MoviePipeline.h

Include

#include "MoviePipeline.h"

Source

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

Syntax

void ResolveFilenameFormatArguments
(
    const FString & InFormatString,
    const TMap< FString, FString > & InFormatOverrides,
    FString & OutFinalPath,
    FMoviePipelineFormatArgs & OutFinalFormatArgs,
    const FMoviePipelineFrameOutputState * InOutputState,
    const int32 InFrameNumberOffset
) const

Remarks

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

Returns

OutFinalFormatArgs The format arguments that were actually used to fill the format string (including file metadata)

Parameters

Parameter

Description

InFormatString

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

InFormatOverrides

A series of Key/Value pairs to override particular format keys. Useful for things that change based on the caller such as filename extensions.

InOutputState

(optional) The output state for frame information.

InFrameNumberOffset

(optional) Frame offset of the frame we want the filename for, if not the current frame as specified in InOutputState

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