unreal.MovieGraphFilenameResolveParams¶
- class unreal.MovieGraphFilenameResolveParams(render_data_identifier: MovieGraphRenderDataIdentifier = Ellipsis, root_frame_number: int = 0, shot_frame_number: int = 0, root_frame_number_rel: int = 0, shot_frame_number_rel: int = 0, file_metadata: None = {}, version: int = 0, force_relative_frame_numbers: bool = False, file_name_override: str = '', ensure_absolute_path: bool = False, initialization_time: DateTime = [], initialization_time_offset: Timespan = Ellipsis, zero_pad_frame_number_count: int = 0, file_name_format_overrides: None = {}, job: MoviePipelineExecutorJob = Ellipsis, shot: MoviePipelineExecutorShot = Ellipsis, evaluated_config: MovieGraphEvaluatedConfig = Ellipsis, frame_number_offset: int = 0, default_frame_rate: FrameRate = Ellipsis)¶
Bases:
StructBaseThis 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}”.
C++ Source:
Plugin: MovieRenderPipeline
Module: MovieRenderPipelineCore
File: MovieGraphFilenameResolveParams.h
Editor Properties: (see get_editor_property/set_editor_property)
default_frame_rate(FrameRate): [Read-Write] What is the default Frame Rate? This will be overwritten by the Output Setting from the evaluated config (if specified).ensure_absolute_path(bool): [Read-Write] If true, If the format string is a relative path, then the resulting resolved path will be converted to an absolute path. Assumes that the relative path should be resolved relative to the engine/editor executable.evaluated_config(MovieGraphEvaluatedConfig): [Read-Write] Optional. If specified, used to resolve some tokens related to settings in the shot (such as {ts_count}).file_metadata(Map[str, str]): [Read-Write] A key/value pair that maps metadata names to their values. Output is only supported in exr formats at the moment.file_name_format_overrides(Map[str, str]): [Read-Write] A map between “{format}” tokens and their values. These are applied after the auto-generated ones from the system, which allows the caller to override things like {.ext}file_name_override(str): [Read-Write] If specified, this is the filename that will be used instead of building it from the Output Setting node.force_relative_frame_numbers(bool): [Read-Write] If true, force format strings (like {frame_number}) to resolve using the relative version. Used when slow-mo is detected as frame numbers would overlap.frame_number_offset(int32): [Read-Write] Added onto the various FrameNumber settings automatically. Can be used to offset values (such as starting your Level Sequence on frame 0, but outputting it to disk at 1001).initialization_time(DateTime): [Read-Write] The initialization time for this job. Used to resolve time-based format arguments. This should be in UTC, if you want filenames in a local timezone then you should set InitializationTimeOffset to your offset from UTC.initialization_time_offset(Timespan): [Read-Write] What offset should be applied to InitializationTime when generating {time} related filename tokens? Likely your offset from UTC if you want local time.job(MoviePipelineExecutorJob): [Read-Write] Optional. If specified, used to resolve some tokens related to the job.render_data_identifier(MovieGraphRenderDataIdentifier): [Read-Write] This is used to fill out tokens related to the render data that the file represents. Used to fill out the {camera_name}, {layer_name}, {renderer_name}, {renderer_sub_name} tokens.root_frame_number(int32): [Read-Write] 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.root_frame_number_rel(int32): [Read-Write] 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.shot(MoviePipelineExecutorShot): [Read-Write] Optional. If specified, used to resolve the shot name. No settings from this shot are ever used (they must come form the EvaluatedConfig instead).shot_frame_number(int32): [Read-Write] 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.shot_frame_number_rel(int32): [Read-Write] 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.version(int32): [Read-Write] Used to resolve {version} format arguments.zero_pad_frame_number_count(int32): [Read-Write] When converting frame numbers to strings, how many digits should we pad them up to? ie: 5 => 0005 with a count of 4.
- property default_frame_rate: FrameRate¶
[Read-Write] What is the default Frame Rate? This will be overwritten by the Output Setting from the evaluated config (if specified).
- Type:
- property ensure_absolute_path: bool¶
[Read-Write] If true, If the format string is a relative path, then the resulting resolved path will be converted to an absolute path. Assumes that the relative path should be resolved relative to the engine/editor executable.
- Type:
(bool)
- property evaluated_config: MovieGraphEvaluatedConfig¶
[Read-Write] Optional. If specified, used to resolve some tokens related to settings in the shot (such as {ts_count}).
- Type:
- property file_metadata: None¶
[Read-Write] A key/value pair that maps metadata names to their values. Output is only supported in exr formats at the moment.
- property file_name_format_overrides: None¶
[Read-Write] A map between “{format}” tokens and their values. These are applied after the auto-generated ones from the system, which allows the caller to override things like {.ext}
- property file_name_override: str¶
[Read-Write] If specified, this is the filename that will be used instead of building it from the Output Setting node.
- Type:
(str)
- property force_relative_frame_numbers: bool¶
[Read-Write] If true, force format strings (like {frame_number}) to resolve using the relative version. Used when slow-mo is detected as frame numbers would overlap.
- Type:
(bool)
- property frame_number_offset: int¶
[Read-Write] Added onto the various FrameNumber settings automatically. Can be used to offset values (such as starting your Level Sequence on frame 0, but outputting it to disk at 1001).
- Type:
(int32)
- property initialization_time: DateTime¶
[Read-Write] The initialization time for this job. Used to resolve time-based format arguments. This should be in UTC, if you want filenames in a local timezone then you should set InitializationTimeOffset to your offset from UTC.
- Type:
(DateTime)
- property initialization_time_offset: Timespan¶
[Read-Write] What offset should be applied to InitializationTime when generating {time} related filename tokens? Likely your offset from UTC if you want local time.
- Type:
(Timespan)
- property job: MoviePipelineExecutorJob¶
[Read-Write] Optional. If specified, used to resolve some tokens related to the job.
- Type:
- property render_data_identifier: MovieGraphRenderDataIdentifier¶
[Read-Write] This is used to fill out tokens related to the render data that the file represents. Used to fill out the {camera_name}, {layer_name}, {renderer_name}, {renderer_sub_name} tokens.
- Type:
- property root_frame_number: int¶
If the Sequence PlaybackRange starts on 50, this value would be 50 on the first frame.) Used to fill out the {frame_number} token.
- Type:
(int32)
- Type:
[Read-Write] Frame Number for the Root (matching what you see in the Sequencer timeline. ie
- property root_frame_number_rel: int¶
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.
- Type:
(int32)
- Type:
[Read-Write] Frame Number for the Root (relative to the first RootFrameNumber for this render, ie
- property shot: MoviePipelineExecutorShot¶
[Read-Write] Optional. If specified, used to resolve the shot name. No settings from this shot are ever used (they must come form the EvaluatedConfig instead).
- Type:
- property shot_frame_number: int¶
[Read-Write] 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.
- Type:
(int32)
- property shot_frame_number_rel: int¶
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.
- Type:
(int32)
- Type:
[Read-Write] Frame Number for the Shot (relative to the first ShotFrameNumber for this shot, ie