Navigation
API > API/Plugins > API/Plugins/MediaIOCore
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.
| Name | UFileMediaOutput |
| Type | class |
| Header File | /Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/FileMediaOutput.h |
| Include Path | #include "FileMediaOutput.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UFileMediaOutput : public UMediaOutput
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMediaOutput → UFileMediaOutput
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UFileMediaOutput() |
FileMediaOutput.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BaseFileName | FString | The base file name of the images. The frame number will be append to the base file name. | FileMediaOutput.h |
|
| bInvertAlpha | bool | Invert the alpha for formats that support alpha. | FileMediaOutput.h |
|
| bOverrideDesiredSize | bool | Use the default back buffer size or specify a specific size to capture. | FileMediaOutput.h |
|
| bOverridePixelFormat | bool | Use the default back buffer pixel format or specify a specific the pixel format to capture. | FileMediaOutput.h |
|
| DesiredPixelFormat | EFileMediaOutputPixelFormat | Use the default back buffer pixel format or specify a specific the pixel format to capture. | FileMediaOutput.h |
|
| DesiredSize | FIntPoint | Use the default back buffer size or specify a specific size to capture. | FileMediaOutput.h |
|
| FilePath | FDirectoryPath | The file path for the images. | FileMediaOutput.h |
|
| WriteOptions | FImageWriteOptions | Options on how to save the images. | FileMediaOutput.h |
|
Functions
Public
Overridden from UMediaOutput
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EMediaCaptureConversionOperation GetConversionOperation
(
EMediaCaptureSourceType InSourceType |
The conversion we wish to accomplish on the GPU before the DMA transfer occurs. | FileMediaOutput.h | |
virtual FString GetDescriptionString() |
Gets a string that sums up the media output's description for UI purposes | FileMediaOutput.h | |
virtual void GetDetailsPanelInfoElements
(
TArray< FInfoElement >& OutInfoElements |
Gets a list of text containing the media source's configuration and description for UI purposes | FileMediaOutput.h | |
virtual EPixelFormat GetRequestedPixelFormat () |
The pixel format of the buffer we wish to capture. | FileMediaOutput.h | |
virtual FIntPoint GetRequestedSize () |
The size of the buffer we wish to capture. | FileMediaOutput.h | |
virtual bool Validate
(
FString& OutFailureReason |
Validate the media output settings (must be implemented in child classes). | FileMediaOutput.h |
Protected
Overridden from UMediaOutput
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UMediaCapture * CreateMediaCaptureImpl() |
FileMediaOutput.h |