unreal.MediaCaptureOptions

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

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)

  • convert_to_desired_pixel_format (bool): [Read-Write] Convert to Desired Pixel Format: Allows to enable/disable pixel format conversion for the cases where render target is not of the desired pixel format.

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

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

  • force_alpha_to_one_on_conversion (bool): [Read-Write] Force Alpha to One on Conversion: In some cases when we want to stream irregular render targets containing limited number of channels (for example RG16f), we would like to force Alpha to 1.

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

  • skip_frame_when_running_expensive_tasks (bool): [Read-Write] Skip Frame when Running Expensive Tasks: 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.

property convert_to_desired_pixel_format

[Read-Write] Convert to Desired Pixel Format: Allows to enable/disable pixel format conversion for the cases where render target is not of the desired pixel format.

Type

(bool)

property crop

[Read-Write] Crop: Crop the captured SceneViewport or TextureRenderTarget2D to the desired size.

Type

(MediaCaptureCroppingType)

property custom_capture_point

[Read-Write] Custom Capture Point: Crop the captured SceneViewport or TextureRenderTarget2D to the desired size. note: Only valid when Crop is set to Custom.

Type

(IntPoint)

property force_alpha_to_one_on_conversion

[Read-Write] Force Alpha to One on Conversion: In some cases when we want to stream irregular render targets containing limited number of channels (for example RG16f), we would like to force Alpha to 1.

Type

(bool)

property resize_source_buffer

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

Type

(bool)

property skip_frame_when_running_expensive_tasks

[Read-Write] Skip Frame when Running Expensive Tasks: 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.

Type

(bool)