1. Epic GamesDeveloper
  3. FPixelCaptureCapturerMultiFormat

FPixelCaptureCapturerMultiFormat

A capturer that contains multiple formats of multi layer capture processes.

API > API/Plugins > API/Plugins/PixelCapture

A capturer that contains multiple formats of multi layer capture processes. Feed it a IPixelCaptureCapturerSource that will create the appropriate base capturers. Input: User defined Output: Capturer defined

   
Name FPixelCaptureCapturerMultiFormat
Type class
Header File /Engine/Plugins/Media/PixelCapture/Source/PixelCapture/Public/PixelCaptureCapturerMultiFormat.h
Include Path #include "PixelCaptureCapturerMultiFormat.h"

Syntax

class FPixelCaptureCapturerMultiFormat : public TSharedFromThis< FPixelCaptureCapturerMultiFormat >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FPixelCaptureCapturerMultiFormat ( IPixelCaptureCapturerSource* InCapturerSource,
TArray< FIntPoint > InOutputResolutions
)

   PixelCaptureCapturerMultiFormat.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPixelCaptureCapturerMultiFormat()

   PixelCaptureCapturerMultiFormat.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnComplete FOnComplete   PixelCaptureCapturerMultiFormat.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddOutputFormat ( int32 Format
)

 Sets up a capture pipeline for the given destination format. PixelCaptureCapturerMultiFormat.h  

void Capture ( const IPixelCaptureInputFrame& SourceFrame
)

 Begins the capture process of a given frame. PixelCaptureCapturerMultiFormat.h  

DECLARE_TS_MULTICAST_DELEGATE ( FOnComplete
)

 Listen on this to be notified when a frame completes all capture formats/layers. PixelCaptureCapturerMultiFormat.h  

int32 GetHeight ( int LayerIndex
) const

 Gets the frame height of a given output layer. PixelCaptureCapturerMultiFormat.h  

TArray< FIntPoint > GetLayerSizes()

 Gets the layer sizes PixelCaptureCapturerMultiFormat.h  

int32 GetNumLayers()

 Gets the number of layers in the multi-layered capturers. PixelCaptureCapturerMultiFormat.h  

int32 GetWidth ( int LayerIndex
) const

 Gets the frame width of a given output layer. PixelCaptureCapturerMultiFormat.h  

void OnDisconnected()

 Call to notify this capturer that it has been disconnected and no more frames will be captured and any waiting for format calls should stop waiting. PixelCaptureCapturerMultiFormat.h  

TSharedPtr< IPixelCaptureOutputFrame > RequestFormat ( int32 Format,
FIntPoint LayerSize
)

 Requests the output in a specific format. PixelCaptureCapturerMultiFormat.h  

TSharedPtr< IPixelCaptureOutputFrame > RequestFormat ( int32 Format,
int32 LayerIndex
)

 Requests the output in a specific format. PixelCaptureCapturerMultiFormat.h  

TSharedPtr< IPixelCaptureOutputFrame > WaitForFormat ( int32 Format,
FIntPoint LayerSize,
uint32 MaxWaitTime
)

 Like RequestFormat except if the format does not exist it will add it and then wait for the format to have output. PixelCaptureCapturerMultiFormat.h  

TSharedPtr< IPixelCaptureOutputFrame > WaitForFormat ( int32 Format,
int32 LayerIndex,
uint32 MaxWaitTime
)

 Like RequestFormat except if the format does not exist it will add it and then wait for the format to have output. PixelCaptureCapturerMultiFormat.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CheckFormatEvent ( int32 Format
)

   PixelCaptureCapturerMultiFormat.h  

void FlushWaitingEvents()

   PixelCaptureCapturerMultiFormat.h  

void FreeEvent ( int32 Format,
FEvent* Event
)

   PixelCaptureCapturerMultiFormat.h  

FEvent * GetEventForFormat ( int32 Format
)

   PixelCaptureCapturerMultiFormat.h  

void OnCaptureFormatComplete ( int32 Format
)

   PixelCaptureCapturerMultiFormat.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedPtr< FPixelCaptureCapturerMultiFormat > Create ( IPixelCaptureCapturerSource* InCapturerSource,
TArray< float > LayerScales
)

 Create a new multi-format multi-Layered Capturer. PixelCaptureCapturerMultiFormat.h  

static TSharedPtr< FPixelCaptureCapturerMultiFormat > Create ( IPixelCaptureCapturerSource* InCapturerSource,
TArray< FIntPoint > InOutputResolutions
)

 Create a new multi-format multi-Layered Capturer. PixelCaptureCapturerMultiFormat.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page