UFileMediaOutput

Output information for a file media capture.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MediaIOCore

Header

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

Include

#include "FileMediaOutput.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class UFileMediaOutput : public UMediaOutput

Remarks

Output information for a file media capture.

'Frame Buffer Pixel Format' must be set to at least 8 bits of alpha to enabled the Key.

'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, 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).

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback