unreal.MovieGraphCommandLineEncoderNode

class unreal.MovieGraphCommandLineEncoderNode(outer: Object | None = None, name: Name | str = 'None')

Bases: MovieGraphSettingNode

A node which kicks off an encode process after all renders have completed.

C++ Source:

• Plugin: MovieRenderPipeline

• Module: MovieRenderPipelineCore

• File: MovieGraphCommandLineEncoderNode.h

Editor Properties: (see get_editor_property/set_editor_property)

• audio_codec (str): [Read-Write] Which audio codec should we use? Run ‘MovieRenderPipeline.DumpCLIEncoderCodecs’ for options.

• audio_input_string_format (str): [Read-Write] Format string used for each audio input.

• command_line_format (str): [Read-Write] The format string used when building the final command line argument to launch.

• delete_source_files (bool): [Read-Write] Whether the source files should be deleted on disk after encoding.

• dynamic_properties (InstancedPropertyBag): [Read-Write] Properties which can be dynamically declared on the node (vs. native properties which are always present).

• encode_settings (str): [Read-Write] Additional flags used for specifying encode quality.

• file_name_format (str): [Read-Write] File name format string override. If specified it will override the FileNameFormat from the Output setting. If {shot_name} or {camera_name} is used, encoding will begin after each shot finishes rendering. Can be different from the main one in the Output setting so you can render out frames to individual shot folders but encode to one file.

• output_file_extension (str): [Read-Write] Extension for the output files. Many encoders use this to determine the container type they are placed in. Should be without dot, ie: “webm”.

• override_audio_codec (bool): [Read-Write]

• override_audio_input_string_format (bool): [Read-Write]

• override_b_delete_source_files (bool): [Read-Write]

• override_b_retain_input_text_files (bool): [Read-Write]

• override_b_skip_encode_on_render_canceled (bool): [Read-Write]

• override_command_line_format (bool): [Read-Write]

• override_encode_settings (bool): [Read-Write]

• override_file_name_format (bool): [Read-Write]

• override_output_file_extension (bool): [Read-Write]

• override_video_codec (bool): [Read-Write]

• override_video_input_string_format (bool): [Read-Write]

• retain_input_text_files (bool): [Read-Write] Retain the intermediate audio and video input text files that are passed to the encoder.

• skip_encode_on_render_canceled (bool): [Read-Write] Whether encoding should be skipped on frames produced if rendering was canceled before finishing.

• video_codec (str): [Read-Write] Which video codec should we use? Run ‘MovieRenderPipeline.DumpCLIEncoderCodecs’ for options.

• video_input_string_format (str): [Read-Write] Format string used for each video input.

property audio_codec: str

[Read-Write] Which audio codec should we use? Run ‘MovieRenderPipeline.DumpCLIEncoderCodecs’ for options.

Type:

(str)

property audio_input_string_format: str

[Read-Write] Format string used for each audio input.

Type:

(str)

property b_override_file_name_format_override: bool

‘b_override_file_name_format_override’ was renamed to ‘override_file_name_format’.

Type:

deprecated

property command_line_format: str

[Read-Write] The format string used when building the final command line argument to launch.

Type:

(str)

property delete_source_files: bool

[Read-Write] Whether the source files should be deleted on disk after encoding.

Type:

(bool)

property encode_settings: str

[Read-Write] Additional flags used for specifying encode quality.

Type:

(str)

property file_name_format: str

[Read-Write] File name format string override. If specified it will override the FileNameFormat from the Output setting. If {shot_name} or {camera_name} is used, encoding will begin after each shot finishes rendering. Can be different from the main one in the Output setting so you can render out frames to individual shot folders but encode to one file.

Type:

(str)

property file_name_format_override: str

‘file_name_format_override’ was renamed to ‘file_name_format’.

Type:

deprecated

property output_file_extension: str

“webm”.

Type:

(str)

Type:

[Read-Write] Extension for the output files. Many encoders use this to determine the container type they are placed in. Should be without dot, ie

property override_audio_codec: bool

[Read-Write]

Type:

(bool)

property override_audio_input_string_format: bool

[Read-Write]

Type:

(bool)

property override_b_delete_source_files: bool

[Read-Write]

Type:

(bool)

property override_b_retain_input_text_files: bool

[Read-Write]

Type:

(bool)

property override_b_skip_encode_on_render_canceled: bool

[Read-Write]

Type:

(bool)

property override_command_line_format: bool

[Read-Write]

Type:

(bool)

property override_encode_settings: bool

[Read-Write]

Type:

(bool)

property override_file_name_format: bool

[Read-Write]

Type:

(bool)

property override_output_file_extension: bool

[Read-Write]

Type:

(bool)

property override_video_codec: bool

[Read-Write]

Type:

(bool)

property override_video_input_string_format: bool

[Read-Write]

Type:

(bool)

property retain_input_text_files: bool

[Read-Write] Retain the intermediate audio and video input text files that are passed to the encoder.

Type:

(bool)

property skip_encode_on_render_canceled: bool

[Read-Write] Whether encoding should be skipped on frames produced if rendering was canceled before finishing.

Type:

(bool)

property video_codec: str

[Read-Write] Which video codec should we use? Run ‘MovieRenderPipeline.DumpCLIEncoderCodecs’ for options.

Type:

(str)

property video_input_string_format: str

[Read-Write] Format string used for each video input.

Type:

(str)