unreal.CinePrestreamingGraphNode

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

Bases: MovieGraphFileOutputNode

A Movie Render Graph output node that records virtual texture page requests and Nanite geometry requests during rendering, then saves them as UCinePrestreamingData assets. These assets can be used at runtime to pre-stream content before it is needed during cinematic playback.

This node provides the same recording functionality as UCinePrestreamingRecorderSetting (the Movie Render Queue version), but integrates with the Movie Render Graph pipeline instead.

Note: Because delegates are registered lazily on the first completed output frame, the very first output frame’s streaming requests are not captured. This is acceptable because warmup frames precede actual output frames and pre-establish the streaming state.

C++ Source:

  • Plugin: CinematicPrestreaming

  • Module: CinematicPrestreamingEditor

  • File: CinePrestreamingGraphNode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • disable_advance_render_features (bool): [Read-Write] Disable rendering features not required to generate prestreaming data (lighting, post processing, etc.). Makes recording significantly faster but produces unusable rendered images. Only enable this when using a dedicated recording graph with no image output nodes.

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

  • end_frame (int32): [Read-Write] Last frame to include in the recorded asset. Frames after this index are dropped. Set to 0 to include all frames.

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

  • frame_count_merge_threshold (int32): [Read-Write] Maximum number of frames to merge data across.

  • merge_frames (bool): [Read-Write] Enable merging of frame data. Reduces asset size when consecutive frames have high request coherence.

  • modify_target_sequence (bool): [Read-Write] Automatically add the generated prestreaming track to the target sequence.

  • nanite (bool): [Read-Write] Enable capture of Nanite geometry requests.

  • nanite_request_merge_threshold (int32): [Read-Write] Threshold of Nanite page requests. Frames are merged until this threshold is reached.

  • on_generate_data (OnCinePrestreamingGenerateData): [Read-Write] Broadcast after asset generation completes, with the generated data.

  • override_file_name_format (bool): [Read-Write]

  • package_directory (DirectoryPath): [Read-Write] Specifies the content browser directory where generated assets will be placed. Can contain format tokens such as {sequence_name} and {shot_name}.

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

  • start_frame (int32): [Read-Write] First frame to include in the recorded asset. Frames before this index are dropped.

  • virtual_texture_request_merge_threshold (int32): [Read-Write] Threshold of virtual texture page requests. Frames are merged until this threshold is reached.

  • virtual_textures (bool): [Read-Write] Enable capture of virtual texture page requests.

property disable_advance_render_features: bool

[Read-Write] Disable rendering features not required to generate prestreaming data (lighting, post processing, etc.). Makes recording significantly faster but produces unusable rendered images. Only enable this when using a dedicated recording graph with no image output nodes.

Type:

(bool)

property end_frame: int

[Read-Write] Last frame to include in the recorded asset. Frames after this index are dropped. Set to 0 to include all frames.

Type:

(int32)

property frame_count_merge_threshold: int

[Read-Write] Maximum number of frames to merge data across.

Type:

(int32)

property merge_frames: bool

[Read-Write] Enable merging of frame data. Reduces asset size when consecutive frames have high request coherence.

Type:

(bool)

property modify_target_sequence: bool

[Read-Write] Automatically add the generated prestreaming track to the target sequence.

Type:

(bool)

property nanite: bool

[Read-Write] Enable capture of Nanite geometry requests.

Type:

(bool)

property nanite_request_merge_threshold: int

[Read-Write] Threshold of Nanite page requests. Frames are merged until this threshold is reached.

Type:

(int32)

property on_generate_data: OnCinePrestreamingGenerateData

[Read-Write] Broadcast after asset generation completes, with the generated data.

Type:

(OnCinePrestreamingGenerateData)

property package_directory: DirectoryPath

[Read-Write] Specifies the content browser directory where generated assets will be placed. Can contain format tokens such as {sequence_name} and {shot_name}.

Type:

(DirectoryPath)

property start_frame: int

[Read-Write] First frame to include in the recorded asset. Frames before this index are dropped.

Type:

(int32)

property virtual_texture_request_merge_threshold: int

[Read-Write] Threshold of virtual texture page requests. Frames are merged until this threshold is reached.

Type:

(int32)

property virtual_textures: bool

[Read-Write] Enable capture of virtual texture page requests.

Type:

(bool)