unreal.FileMediaOutput

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

Bases: MediaOutput

Output information for a file media capture. note: ‘Frame Buffer Pixel Format’ must be set to at least 8 bits of alpha to enabled the Key. note: ‘Enable alpha channel support in post-processing’ must be set to ‘Allow through tonemapper’ to enabled the Key.

C++ Source:

  • Plugin: MediaIOFramework

  • Module: MediaIOCore

  • File: FileMediaOutput.h

Editor Properties: (see get_editor_property/set_editor_property)

  • base_file_name (str): [Read-Write] The base file name of the images. The frame number will be append to the base file name.

  • desired_pixel_format (FileMediaOutputPixelFormat): [Read-Write] Use the default back buffer pixel format or specify a specific the pixel format to capture.

  • desired_size (IntPoint): [Read-Write] Use the default back buffer size or specify a specific size to capture.

  • file_path (DirectoryPath): [Read-Write] The file path for the images.

  • invert_alpha (bool): [Read-Write] Invert the alpha for formats that support alpha.

  • number_of_texture_buffers (int32): [Read-Write] Number of texture used to transfer the texture from the GPU to the system memory. A smaller number is most likely to block the GPU (wait for the transfer to complete). A bigger number is most likely to increase latency. note: Some Capture are not are executed on the GPU. If it’s the case then no buffer will be needed and no buffer will be created.

  • override_desired_size (bool): [Read-Write] Use the default back buffer size or specify a specific size to capture.

  • override_pixel_format (bool): [Read-Write] Use the default back buffer pixel format or specify a specific the pixel format to capture.

  • write_options (ImageWriteOptions): [Read-Write] Options on how to save the images.

property base_file_name: str

[Read-Write] The base file name of the images. The frame number will be append to the base file name.

Type:

(str)

property desired_pixel_format: FileMediaOutputPixelFormat

[Read-Write] Use the default back buffer pixel format or specify a specific the pixel format to capture.

Type:

(FileMediaOutputPixelFormat)

property desired_size: IntPoint

[Read-Write] Use the default back buffer size or specify a specific size to capture.

Type:

(IntPoint)

property file_path: DirectoryPath

[Read-Write] The file path for the images.

Type:

(DirectoryPath)

property invert_alpha: bool

[Read-Write] Invert the alpha for formats that support alpha.

Type:

(bool)

property override_desired_size: bool

[Read-Write] Use the default back buffer size or specify a specific size to capture.

Type:

(bool)

property override_pixel_format: bool

[Read-Write] Use the default back buffer pixel format or specify a specific the pixel format to capture.

Type:

(bool)

property write_options: ImageWriteOptions

[Read-Write] Options on how to save the images.

Type:

(ImageWriteOptions)