unreal.CinePrestreamingRecorderSetting

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

Bases: MoviePipelineOutputBase

Cine Prestreaming Recorder Setting

C++ Source:

• Plugin: CinematicPrestreaming

• Module: CinematicPrestreamingEditor

• File: CinePrestreamingRecorderSetting.h

Editor Properties: (see get_editor_property/set_editor_property)

• disable_advance_render_features (bool): [Read-Write] By default we disable any render features that aren’t needed to generate the prestreaming data. This makes renders significantly faster, but also means that the final image generated by the renderer is unusable.

• end_frame (int32): [Read-Write] Last frame to capture in each recorded asset. Frames after this are dropped. (Set to 0 to ignore).

• 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. This can reduce data overhead in the common case where there is high coherance of requests across frames.

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

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

• nanite_request_merge_threshold (int32): [Read-Write] Threshold of nanite page requests. We merge frames until up to and including the frame where we pass this threshold.

• on_generate_data (OnCinePrestreamingGenerateData): [Read-Write]

• package_directory (DirectoryPath): [Read-Write] Specifies which directory the generated assets be placed in. Assumed to be relative to the root folder, ie it should start with /Game/ etc. Can contain MRQ format strings such as {shot_name} which will be resolved.

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

• virtual_texture_request_merge_threshold (int32): [Read-Write] Threshold of virtual texture page requests. We merge frames until up to and including the frame where we pass this threshold.

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

property disable_advance_render_features: bool

[Read-Write] By default we disable any render features that aren’t needed to generate the prestreaming data. This makes renders significantly faster, but also means that the final image generated by the renderer is unusable.

Type:

(bool)

property end_frame: int

[Read-Write] Last frame to capture in each recorded asset. Frames after this are dropped. (Set to 0 to ignore).

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. This can reduce data overhead in the common case where there is high coherance of requests across frames.

Type:

(bool)

property modify_target_sequence: bool

[Read-Write] Automatically add the generated tracks to the target sequence

Type:

(bool)

property nanite: bool

[Read-Write] Enable capture of nanite requests.

Type:

(bool)

property nanite_request_merge_threshold: int

[Read-Write] Threshold of nanite page requests. We merge frames until up to and including the frame where we pass this threshold.

Type:

(int32)

property on_generate_data: OnCinePrestreamingGenerateData

[Read-Write]

Type:

(OnCinePrestreamingGenerateData)

property package_directory: DirectoryPath

[Read-Write] Specifies which directory the generated assets be placed in. Assumed to be relative to the root folder, ie it should start with /Game/ etc. Can contain MRQ format strings such as {shot_name} which will be resolved.

Type:

(DirectoryPath)

property start_frame: int

[Read-Write] First frame to output in each recorded asset. Frames before this are dropped.

Type:

(int32)

property virtual_texture_request_merge_threshold: int

[Read-Write] Threshold of virtual texture page requests. We merge frames until up to and including the frame where we pass this threshold.

Type:

(int32)

property virtual_textures: bool

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

Type:

(bool)