unreal.MovieGraphAppleProResNode

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

Bases: MovieGraphVideoOutputNode

A node which can output Apple ProRes movies.

C++ Source:

  • Plugin: AppleProResMedia

  • Module: AppleProResMedia

  • File: MovieGraphAppleProResNode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • 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.

  • 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.

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

  • include_audio (bool): [Read-Write] If true, audio will be included in the video file.

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

    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.

  • override_b_composite_onto_final_image (bool): [Read-Write]

  • override_b_enable_burn_in (bool): [Read-Write]

  • override_b_include_audio (bool): [Read-Write]

  • override_burn_in_class (bool): [Read-Write]

  • override_burn_in_file_name_format (bool): [Read-Write]

  • override_file_name_format (bool): [Read-Write]

  • override_ocio_configuration (bool): [Read-Write]

  • override_ocio_context (bool): [Read-Write]

  • override_quality (bool): [Read-Write]

  • quality (AppleProResEncoderCodec): [Read-Write] The Apple ProRes codec that should be used. See Apple documentation for more specifics. Uses Rec 709 color primaries.

  • 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.

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 enable_burn_in: bool

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

Type:

(bool)

property include_audio: bool

[Read-Write] If true, audio will be included in the video file.

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 ocio_configuration: OpenColorIODisplayConfiguration

[Read-Write] OCIO configuration/transform settings.

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 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_include_audio: 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_ocio_configuration: bool

[Read-Write]

Type:

(bool)

property override_ocio_context: bool

[Read-Write]

Type:

(bool)

property override_quality: bool

[Read-Write]

Type:

(bool)

property quality: AppleProResEncoderCodec

[Read-Write] The Apple ProRes codec that should be used. See Apple documentation for more specifics. Uses Rec 709 color primaries.

Type:

(AppleProResEncoderCodec)