unreal.MoviePipelineBase

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

Bases: Object

Movie Pipeline Base

C++ Source:

• Plugin: MovieRenderPipeline

• Module: MovieRenderPipelineCore

• File: MoviePipelineBase.h

get_pipeline_state() → MovieRenderPipelineState

Get Pipeline State

Return type:

MovieRenderPipelineState

is_shutdown_requested() → bool

Has RequestShutdown() been called?

Return type:

bool

request_shutdown(is_error=False) → None

Request the movie pipeline to shut down at the next available time. The pipeline will attempt to abandon the current frame (such as if there are more temporal samples pending) but may be forced into finishing if there are spatial samples already submitted to the GPU. The shutdown flow will be run to ensure already completed work is written to disk. This is a non-blocking operation, use Shutdown() instead if you need to block until it is fully shut down.

Parameters:

is_error (bool) – Whether this is a request for early shut down due to an error This function is thread safe.

shutdown(is_error=False) → None

Abandons any future work on this Movie Pipeline and runs through the shutdown flow to ensure already completed work is written to disk. This is a blocking-operation and will not return until all outstanding work has been completed.

Parameters:

is_error (bool) – Whether this is an early shut down due to an error This function should only be called from the game thread.