unreal.MovieSceneCaptureEnvironment

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

Bases: Object

Movie Scene Capture Environment

C++ Source:

  • Module: MovieSceneCapture

  • File: MovieSceneCaptureEnvironment.h

classmethod find_audio_capture_protocol() MovieSceneAudioCaptureProtocolBase

Attempt to locate a capture protocol - may not be in a capturing state

Return type:

MovieSceneAudioCaptureProtocolBase

classmethod find_image_capture_protocol() MovieSceneImageCaptureProtocolBase

Attempt to locate a capture protocol - may not be in a capturing state

Return type:

MovieSceneImageCaptureProtocolBase

classmethod get_capture_elapsed_time() float

Get the total elapsed time of the current capture in seconds

Return type:

float

classmethod get_capture_frame_number() int32

Get the frame number of the current capture

Return type:

int32

classmethod is_capture_in_progress() bool

Return true if there is any capture currently active (even in a warm-up state). Useful for checking whether to do certain operations in BeginPlay

Return type:

bool