unreal.MovieGraphTmvEncoderNode

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

Bases: MovieGraphVideoOutputNode

A node which can output TMV (Tiled-Mipmap Video) files using the APV encoder.

C++ Source:

  • Plugin: TmvMediaUtils

  • Module: MovieRenderPipelineTmvEncoder

  • File: MovieGraphTmvEncoderNode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • band (ApvMediaBand): [Read-Write] Coded data rate band setting. If the bitrate is not specified otherwise, this determines the max coded data rate (higher band leads to higher bit rate).

  • burn_in_class (SoftClassPath): [Read-Write] The widget that the burn-in should use.

  • burn_in_file_name_format (str): [Read-Write] The file name format used for writing out the burn-in video (if not composited).

  • composite_onto_final_image (bool): [Read-Write] If true, the burn-in that’s generated will be composited onto this output. Otherwise, the burn-in will be written to a different file.

  • destination_color_space (TextureColorSpace): [Read-Write] Specify the destination color space.

  • destination_encoding (TmvMediaEncoderEncoding): [Read-Write] Specify the destination color encoding.

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

  • enable_burn_in (bool): [Read-Write] If true, this output node will also generate a burn-in.

  • enable_mip_mapping (bool): [Read-Write] If checked, mip maps will be generated and encoded in the final destination. The encoder may restrict the generated mip chain depending on the format requirements.

  • file_name_format (str): [Read-Write] What format string should the final files use? Can include folder prefixes, and format string ({shot_name}, etc.)

  • num_threads (int32): [Read-Write] Number of worker threads to encode tiles (0 = automatically use the available number of cores).

  • ocio_configuration (OpenColorIODisplayConfiguration): [Read-Write] OCIO configuration/transform settings.

    If OCIO transform is enabled, the builtin color transform in Color Management will be ignored.

    Note: There are differences from the previous implementation in MRQ given that we are now doing CPU-side processing. 1) This feature only works on desktop platforms when the OpenColorIO library is available. 2) Users are now responsible for setting the renderer output space to Final Color (HDR) in Linear Working Color Space (SCS_FinalColorHDR) by

    disabling the Tone Curve setting on the renderer node.

  • ocio_context (Map[str, str]): [Read-Write] OCIO context of key-value string pairs, typically used to apply shot-specific looks (such as a CDL color correction, or a 1D grade LUT).

    Notes: 1) If a configuration asset base context was set, it remains active but can be overridden here with new key-values. 2) Format tokens such as {shot_name} are supported and will get resolved before submission.

  • output_type (TmvEncoderNodeOutputType): [Read-Write] Select whether to output a single TMV container file or individual files per frame.

  • override_b_composite_onto_final_image (bool): [Read-Write]

  • override_b_enable_burn_in (bool): [Read-Write]

  • override_b_enable_mip_mapping (bool): [Read-Write]

  • override_band (bool): [Read-Write]

  • override_burn_in_class (bool): [Read-Write]

  • override_burn_in_file_name_format (bool): [Read-Write]

  • override_destination_color_space (bool): [Read-Write]

  • override_destination_encoding (bool): [Read-Write]

  • override_file_name_format (bool): [Read-Write]

  • override_num_threads (bool): [Read-Write]

  • override_ocio_configuration (bool): [Read-Write]

  • override_ocio_context (bool): [Read-Write]

  • override_output_type (bool): [Read-Write] — Override bits —

  • override_preset (bool): [Read-Write]

  • override_profile (bool): [Read-Write]

  • override_reference_white (bool): [Read-Write]

  • override_tile_size (bool): [Read-Write]

  • override_yuv_matrix (bool): [Read-Write]

  • override_yuv_matrix_range (bool): [Read-Write]

  • preset (ApvMediaPreset): [Read-Write] Specify the encoding optimization level.

  • profile (ApvMediaProfile): [Read-Write] Specify the color/chroma profile, includes bitdepth. Input video will be converted to the given profile.

  • reference_white (TmvMediaEncoderReferenceWhite): [Read-Write] Reference-white standard used to scale UE scene-linear 1.0 to diffuse white.

  • script_tags (Array[str]): [Read-Write] Tags that can be used to identify this node within a pre/post render script. Tags can be unique in order to identify this specific node, or the same tag can be applied to multiple nodes in order to identify a grouping of nodes.

  • tile_size (IntPoint): [Read-Write] Dimensions of a tile in pixels. The tile size determines parallelism and performance. Frames are divided into rectangular tiles that can be encoded and decoded simultaneously, enabling high throughput on multicore processors.

  • yuv_matrix (TmvMediaEncoderColorMatrix): [Read-Write] Specify the YUV encoding color matrix.

  • yuv_matrix_range (TmvMediaEncoderColorMatrixRange): [Read-Write] Specify the YUV encoding color matrix range.

property band: ApvMediaBand

[Read-Write] Coded data rate band setting. If the bitrate is not specified otherwise, this determines the max coded data rate (higher band leads to higher bit rate).

Type:

(ApvMediaBand)

property burn_in_class: SoftClassPath

[Read-Write] The widget that the burn-in should use.

Type:

(SoftClassPath)

property burn_in_file_name_format: str

[Read-Write] The file name format used for writing out the burn-in video (if not composited).

Type:

(str)

property composite_onto_final_image: bool

[Read-Write] If true, the burn-in that’s generated will be composited onto this output. Otherwise, the burn-in will be written to a different file.

Type:

(bool)

property destination_color_space: TextureColorSpace

[Read-Write] Specify the destination color space.

Type:

(TextureColorSpace)

property destination_encoding: TmvMediaEncoderEncoding

[Read-Write] Specify the destination color encoding.

Type:

(TmvMediaEncoderEncoding)

property enable_burn_in: bool

[Read-Write] If true, this output node will also generate a burn-in.

Type:

(bool)

property enable_mip_mapping: bool

[Read-Write] If checked, mip maps will be generated and encoded in the final destination. The encoder may restrict the generated mip chain depending on the format requirements.

Type:

(bool)

inject_nodes_post_evaluation(branch_name, evaluated_config) → Array[MovieGraphSettingNode]

Injects nodes into the EVALUATED graph. Called on the fully evaluated node. All new nodes should be outered to InEvaluatedConfig. Because these nodes are injected post-evaluation, the movie pipeline will be immediately shut down if any of the returned nodes already exist in the branch (having two nodes of the same type in the same branch post-evaluation is not allowed). Note that modifying the Globals branch is not typically advised because at this stage, it has already been merged into all other branches.

Parameters:
Returns:

out_injected_nodes (Array[MovieGraphSettingNode]):

Return type:

Array[MovieGraphSettingNode]

property num_threads: int

[Read-Write] Number of worker threads to encode tiles (0 = automatically use the available number of cores).

Type:

(int32)

property ocio_configuration: OpenColorIODisplayConfiguration

[Read-Write] OCIO configuration/transform settings.

If OCIO transform is enabled, the builtin color transform in Color Management will be ignored.

Note: There are differences from the previous implementation in MRQ given that we are now doing CPU-side processing. 1) This feature only works on desktop platforms when the OpenColorIO library is available. 2) Users are now responsible for setting the renderer output space to Final Color (HDR) in Linear Working Color Space (SCS_FinalColorHDR) by

disabling the Tone Curve setting on the renderer node.

Type:

(OpenColorIODisplayConfiguration)

property ocio_context: None

[Read-Write] OCIO context of key-value string pairs, typically used to apply shot-specific looks (such as a CDL color correction, or a 1D grade LUT).

Notes: 1) If a configuration asset base context was set, it remains active but can be overridden here with new key-values. 2) Format tokens such as {shot_name} are supported and will get resolved before submission.

Type:

(Map[str, str])

property output_type: TmvEncoderNodeOutputType

[Read-Write] Select whether to output a single TMV container file or individual files per frame.

Type:

(TmvEncoderNodeOutputType)

property override_b_composite_onto_final_image: bool

[Read-Write]

Type:

(bool)

property override_b_enable_burn_in: bool

[Read-Write]

Type:

(bool)

property override_b_enable_mip_mapping: bool

[Read-Write]

Type:

(bool)

property override_band: bool

[Read-Write]

Type:

(bool)

property override_burn_in_class: bool

[Read-Write]

Type:

(bool)

property override_burn_in_file_name_format: bool

[Read-Write]

Type:

(bool)

property override_destination_color_space: bool

[Read-Write]

Type:

(bool)

property override_destination_encoding: bool

[Read-Write]

Type:

(bool)

property override_num_threads: bool

[Read-Write]

Type:

(bool)

property override_ocio_configuration: bool

[Read-Write]

Type:

(bool)

property override_ocio_context: bool

[Read-Write]

Type:

(bool)

property override_output_type: bool

[Read-Write] — Override bits —

Type:

(bool)

property override_preset: bool

[Read-Write]

Type:

(bool)

property override_profile: bool

[Read-Write]

Type:

(bool)

property override_reference_white: bool

[Read-Write]

Type:

(bool)

property override_tile_size: bool

[Read-Write]

Type:

(bool)

property override_yuv_matrix: bool

[Read-Write]

Type:

(bool)

property override_yuv_matrix_range: bool

[Read-Write]

Type:

(bool)

property preset: ApvMediaPreset

[Read-Write] Specify the encoding optimization level.

Type:

(ApvMediaPreset)

property profile: ApvMediaProfile

[Read-Write] Specify the color/chroma profile, includes bitdepth. Input video will be converted to the given profile.

Type:

(ApvMediaProfile)

property reference_white: TmvMediaEncoderReferenceWhite

[Read-Write] Reference-white standard used to scale UE scene-linear 1.0 to diffuse white.

Type:

(TmvMediaEncoderReferenceWhite)

property tile_size: IntPoint

[Read-Write] Dimensions of a tile in pixels. The tile size determines parallelism and performance. Frames are divided into rectangular tiles that can be encoded and decoded simultaneously, enabling high throughput on multicore processors.

Type:

(IntPoint)

property yuv_matrix: TmvMediaEncoderColorMatrix

[Read-Write] Specify the YUV encoding color matrix.

Type:

(TmvMediaEncoderColorMatrix)

property yuv_matrix_range: TmvMediaEncoderColorMatrixRange

[Read-Write] Specify the YUV encoding color matrix range.

Type:

(TmvMediaEncoderColorMatrixRange)