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 to pass to the external process when capturing
  • audio_capture_protocol (MovieSceneAudioCaptureProtocolBase): [Read-Only] Audio Capture Protocol
  • audio_capture_protocol_type (SoftClassPath): [Read-Write] 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] When enabled, the editor will shutdown when the capture starts
  • image_capture_protocol (MovieSceneImageCaptureProtocolBase): [Read-Only] Capture protocol responsible for actually capturing frame data
  • image_capture_protocol_type (SoftClassPath): [Read-Write] The type of capture protocol to use for image data
  • inherited_command_line_arguments (str): [Read-Write] Command line arguments inherited from this process
  • settings (MovieSceneCaptureSettings): [Read-Write] Settings that define how to capture
  • use_separate_process (bool): [Read-Write] Whether to capture the movie in a separate process or not
additional_command_line_arguments

(str) – [Read-Write] Additional command line arguments to pass to the external process when capturing

close_editor_when_capture_starts

(bool) – [Read-Write] When enabled, the editor will shutdown when the capture starts

get_audio_capture_protocol() → MovieSceneCaptureProtocolBase

Get Audio Capture Protocol

Returns:
Return type:MovieSceneCaptureProtocolBase
get_image_capture_protocol() → MovieSceneCaptureProtocolBase

Access the capture protocol we are using

Returns:
Return type:MovieSceneCaptureProtocolBase
inherited_command_line_arguments

(str) – [Read-Write] Command line arguments inherited from this process

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)) –
settings

(MovieSceneCaptureSettings) – [Read-Write] Settings that define how to capture

use_separate_process

(bool) – [Read-Write] Whether to capture the movie in a separate process or not