Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
This data structure contains all of the information needed to resolve a filename format string from the Movie Graph. During runtime the values are generated by the actual rendering and then placed into this data structure before resolving an actual {format_string} using the UMovieGraphBlueprintLibrary. You can use this to resolve filenames when editing. If you wish to resolve a partial format string (such as {sequence_name}/{frame_number} but have it only resolve {sequence_name} you can add ("frame_number", "{frame_number}") to the FileNameFormatOverrides and that portion of the format string will be preserved so the resulting string back would say "my_seq_name/{frame_number}".
| Name | FMovieGraphFilenameResolveParams |
| Type | struct |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/MovieGraphFilenameResolveParams.h |
| Include Path | #include "Graph/MovieGraphFilenameResolveParams.h" |
Syntax
USTRUCT (BlueprintType )
struct FMovieGraphFilenameResolveParams
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieGraphFilenameResolveParams() |
Graph/MovieGraphFilenameResolveParams.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEnsureAbsolutePath | bool | If true, If the format string is a relative path, then the resulting resolved path will be converted to an absolute path. | Graph/MovieGraphFilenameResolveParams.h |
|
| bForceRelativeFrameNumbers | bool | If true, force format strings (like {frame_number}) to resolve using the relative version. | Graph/MovieGraphFilenameResolveParams.h |
|
| DefaultFrameRate | FFrameRate | What is the default Frame Rate? This will be overwritten by the Output Setting from the evaluated config (if specified). | Graph/MovieGraphFilenameResolveParams.h |
|
| EvaluatedConfig | TObjectPtr< UMovieGraphEvaluatedConfig > | Optional. | Graph/MovieGraphFilenameResolveParams.h |
|
| FileMetadata | TMap< FString, FString > | A key/value pair that maps metadata names to their values. | Graph/MovieGraphFilenameResolveParams.h |
|
| FileNameFormatOverrides | TMap< FString, FString > | A map between "{format}" tokens and their values. | Graph/MovieGraphFilenameResolveParams.h |
|
| FileNameOverride | FString | If specified, this is the filename that will be used instead of building it from the Output Setting node. | Graph/MovieGraphFilenameResolveParams.h |
|
| FrameNumberOffset | int32 | Added onto the various FrameNumber settings automatically. | Graph/MovieGraphFilenameResolveParams.h |
|
| InitializationTime | FDateTime | The initialization time for this job. | Graph/MovieGraphFilenameResolveParams.h |
|
| InitializationTimeOffset | FTimespan | What offset should be applied to InitializationTime when generating {time} related filename tokens? Likely your offset from UTC if you want local time. | Graph/MovieGraphFilenameResolveParams.h |
|
| Job | TObjectPtr< UMoviePipelineExecutorJob > | Optional. If specified, used to resolve some tokens related to the job. | Graph/MovieGraphFilenameResolveParams.h |
|
| RenderDataIdentifier | FMovieGraphRenderDataIdentifier | This is used to fill out tokens related to the render data that the file represents. | Graph/MovieGraphFilenameResolveParams.h |
|
| RootFrameNumber | int32 | Frame Number for the Root (matching what you see in the Sequencer timeline. ie: If the Sequence PlaybackRange starts on 50, this value would be 50 on the first frame.) Used to fill out the {frame_number} token. | Graph/MovieGraphFilenameResolveParams.h |
|
| RootFrameNumberRel | int32 | Frame Number for the Root (relative to the first RootFrameNumber for this render, ie: if your sequence started at 35, this would be 35 as well, but supports time dilation because it will count up based on the total number of frame rendered, not the closest Sequencer frame (like RootFrameNumber)) Used to fill out the {frame_number_rel} token. | Graph/MovieGraphFilenameResolveParams.h |
|
| Shot | TObjectPtr< UMoviePipelineExecutorShot > | Optional. | Graph/MovieGraphFilenameResolveParams.h |
|
| ShotFrameNumber | int32 | Frame Number for the Shot (matching what you would see in Sequencer at the sub-sequence level.) Used to fill out the {frame_number_shot} token. | Graph/MovieGraphFilenameResolveParams.h |
|
| ShotFrameNumberRel | int32 | Frame Number for the Shot (relative to the first ShotFrameNumber for this shot, ie: if your shot started at 35, this would be 35 as well, but supports time dilation because it will count up based on the total number of frame rendered, not the closest Sequencer frame (like ShotFrameNumber)) Used to fill out the {frame_number_shot_rel} token. | Graph/MovieGraphFilenameResolveParams.h |
|
| Version | int32 | Used to resolve {version} format arguments. | Graph/MovieGraphFilenameResolveParams.h |
|
| ZeroPadFrameNumberCount | int32 | When converting frame numbers to strings, how many digits should we pad them up to? ie: 5 => 0005 with a count of 4. | Graph/MovieGraphFilenameResolveParams.h |
|
Functions
Public
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FMovieGraphFilenameResolveParams MakeResolveParams
(
const FMovieGraphRenderDataIdentifier& InRenderId, |
Convenience function to make filename resolve parameters for output files, or OCIO contexts. | Graph/MovieGraphFilenameResolveParams.h |