unreal.MediaCaptureOptions?

class unreal.MediaCaptureOptions(crop=MediaCaptureCroppingType.NONE, custom_capture_point=[0, 0], resize_source_buffer=False, skip_frame_when_running_expensive_tasks=True)?

Bases: unreal.StructBase

Base class of additional data that can be stored for each requested capture.

C++ Source:

  • Plugin: MediaIOFramework
  • Module: MediaIOCore
  • File: MediaCapture.h

Editor Properties: (see get_editor_property/set_editor_property)

  • crop (MediaCaptureCroppingType): [Read-Write] Crop the captured SceneViewport or TextureRenderTarget2D to the desired size.
  • custom_capture_point (IntPoint): [Read-Write] Crop the captured SceneViewport or TextureRenderTarget2D to the desired size. Only valid when Crop is set to Custom.:
  • resize_source_buffer (bool): [Read-Write] When the capture start, resize the source buffer to the desired size. Only valid when a size is specified by the MediaOutput.: For viewport, the window size will not change. Only the viewport will be resized.: For RenderTarget, the asset will be modified and resized to the desired size.:
  • skip_frame_when_running_expensive_tasks (bool): [Read-Write] When the application enters responsive mode, skip the frame capture. The application can enter responsive mode on mouse down, viewport resize, … That is to ensure responsiveness in low FPS situations.
crop?

(MediaCaptureCroppingType) – [Read-Write] Crop the captured SceneViewport or TextureRenderTarget2D to the desired size.

custom_capture_point?

(IntPoint) – [Read-Write] Crop the captured SceneViewport or TextureRenderTarget2D to the desired size. Only valid when Crop is set to Custom.:

resize_source_buffer?

(bool) – [Read-Write] When the capture start, resize the source buffer to the desired size. Only valid when a size is specified by the MediaOutput.: For viewport, the window size will not change. Only the viewport will be resized.: For RenderTarget, the asset will be modified and resized to the desired size.:

skip_frame_when_running_expensive_tasks?

(bool) – [Read-Write] When the application enters responsive mode, skip the frame capture. The application can enter responsive mode on mouse down, viewport resize, … That is to ensure responsiveness in low FPS situations.