unreal.MovieSceneCapture

class unreal.MovieSceneCapture(outer=None, name='None')

Bases: unreal.Object

Class responsible for capturing scene data

C++ Source:

  • Module: MovieSceneCapture

  • File: MovieSceneCapture.h

Editor Properties: (see get_editor_property/set_editor_property)

  • additional_command_line_arguments (str): [Read-Write] Additional Command Line Arguments: Additional command line arguments to pass to the external process when capturing

  • audio_capture_protocol (MovieSceneAudioCaptureProtocolBase): [Read-Only] Audio Capture Protocol

  • audio_capture_protocol_type (SoftClassPath): [Read-Write] Audio Capture Protocol Type: The type of capture protocol to use for audio data. Requires experimental audio mixer (launch editor via with -audiomixer).

  • close_editor_when_capture_starts (bool): [Read-Write] Close Editor when Capture Starts: When enabled, the editor will shutdown when the capture starts

  • image_capture_protocol (MovieSceneImageCaptureProtocolBase): [Read-Only] Image Capture Protocol: Capture protocol responsible for actually capturing frame data

  • image_capture_protocol_type (SoftClassPath): [Read-Write] Image Capture Protocol Type: The type of capture protocol to use for image data

  • inherited_command_line_arguments (str): [Read-Write] Inherited Command Line Arguments: Command line arguments inherited from this process

  • settings (MovieSceneCaptureSettings): [Read-Write] Settings: Settings that define how to capture

  • use_separate_process (bool): [Read-Write] Use Separate Process: Whether to capture the movie in a separate process or not

property additional_command_line_arguments

[Read-Write] Additional Command Line Arguments: Additional command line arguments to pass to the external process when capturing

Type

(str)

property close_editor_when_capture_starts

[Read-Write] Close Editor when Capture Starts: When enabled, the editor will shutdown when the capture starts

Type

(bool)

get_audio_capture_protocol() → MovieSceneCaptureProtocolBase

Get Audio Capture Protocol

Return type

MovieSceneCaptureProtocolBase

get_image_capture_protocol() → MovieSceneCaptureProtocolBase

Access the capture protocol we are using

Return type

MovieSceneCaptureProtocolBase

property inherited_command_line_arguments

[Read-Write] Inherited Command Line Arguments: Command line arguments inherited from this process

Type

(str)

set_audio_capture_protocol_type(protocol_type) → None

Set Audio Capture Protocol Type

Parameters

protocol_type (type(Class)) –

set_image_capture_protocol_type(protocol_type) → None

Set Image Capture Protocol Type

Parameters

protocol_type (type(Class)) –

property settings

[Read-Write] Settings: Settings that define how to capture

Type

(MovieSceneCaptureSettings)

property use_separate_process

[Read-Write] Use Separate Process: Whether to capture the movie in a separate process or not

Type

(bool)