Navigation
API > API/Plugins > API/Plugins/MediaIOCore
Abstract base class for media output.
Media output describe the location and/or settings of media objects that can be used to output the content of Unreal Engine to a target device via a MediaCapture.
| Name | UMediaOutput |
| Type | class |
| Header File | /Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaOutput.h |
| Include Path | #include "MediaOutput.h" |
Syntax
UCLASS (MinimalAPI, Abstract, EditInlineNew, BlueprintType, HideCategories=(Object))
class UMediaOutput : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMediaOutput
Derived Classes
UMediaOutput derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMediaOutput
(
const FObjectInitializer& ObjectInitializer |
MediaOutput.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FInfoElement | TTuple< FText, FText, FText > | MediaOutput.h | |
| FOnOutputModified | TMulticastDelegate_OneParam< void, UMediaOutput * > | MediaOutput.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| RequestCaptureSourceSize | const FIntPoint | MediaOutput.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| NumberOfTextureBuffers | int32 | Number of texture used to transfer the texture from the GPU to the system memory. | MediaOutput.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnOutputModifiedDelegate | FOnOutputModified | MediaOutput.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMediaCapture * CreateMediaCapture() |
Creates the specific implementation of the MediaCapture for the MediaOutput. | MediaOutput.h |
|
virtual EMediaCaptureConversionOperation GetConversionOperation
(
EMediaCaptureSourceType InSourceType |
The conversion we wish to accomplish on the GPU before the DMA transfer occurs. | MediaOutput.h | |
virtual FString GetDescriptionString() |
Gets a string that sums up the media output's description for UI purposes | MediaOutput.h | |
virtual void GetDetailsPanelInfoElements
(
TArray< FInfoElement >& OutInfoElements |
Gets a list of text containing the media source's configuration and description for UI purposes | MediaOutput.h | |
virtual EPixelFormat GetRequestedPixelFormat () |
The pixel format of the buffer we wish to capture. | MediaOutput.h | |
virtual FIntPoint GetRequestedSize () |
The size of the buffer we wish to capture. | MediaOutput.h | |
FOnOutputModified & OnOutputModified() |
MediaOutput.h | ||
virtual bool Validate
(
FString& OutFailureReason |
Validate the media output settings (must be implemented in child classes). | MediaOutput.h |
|
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
MediaOutput.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UMediaCapture * CreateMediaCaptureImpl() |
MediaOutput.h |