UFileMediaOutput

Output information for a file media capture.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MediaIOCore

Header

/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/FileMediaOutput.h

Include

#include "FileMediaOutput.h"

Syntax

UCLASS(BlueprintType)
class UFileMediaOutput : public UMediaOutput

Remarks

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.

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

FString

 

BaseFileName

The base file name of the images. The frame number will be append to the base file name.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

bool

 

bInvertAlpha

Invert the alpha for formats that support alpha.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

bool

 

bOverrideDesiredSize

Use the default back buffer size or specify a specific size to capture.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

bool

 

bOverridePixelFormat

Use the default back buffer pixel format or specify a specific the pixel format to capture.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

EFileMediaOutpu...

 

DesiredPixelFormat

Use the default back buffer pixel format or specify a specific the pixel format to capture.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

FIntPoint

 

DesiredSize

Use the default back buffer size or specify a specific size to capture.

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

FDirectoryPath

 

FilePath

The file path for the images.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FImageWriteOpti...

 

WriteOptions

Options on how to save the images.

Constructors

Name Description

Public function

UFileMediaOutput()

Overridden from UMediaOutput

Name Description

Protected function Virtual

UMediaCaptur...

 

CreateMediaCaptureImpl()

Public function Virtual Const

EMediaCaptur...

 

GetConversionOperation

(
    EMediaCaptureSourceType InSourceTyp...
)

The conversion we wish to accomplish on the GPU before the DMA transfer occurs.

Public function Virtual Const

EPixelFormat

 

GetRequestedPixelFormat()

The pixel format of the buffer we wish to capture.

Public function Virtual Const

FIntPoint

 

GetRequestedSize()

The size of the buffer we wish to capture.

Public function Virtual Const

bool

 

Validate

(
    FString& OutFailureReason
)

Validate the media output settings (must be implemented in child classes).