1. Epic GamesDeveloper
  3. UUserDefinedCaptureProtocol

UUserDefinedCaptureProtocol

A blueprintable capture protocol that defines how to capture frames from the engine

API > API/Runtime > API/Runtime/MovieSceneCapture

A blueprintable capture protocol that defines how to capture frames from the engine

   
Name UUserDefinedCaptureProtocol
Type class
Header File /Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/UserDefinedCaptureProtocol.h
Include Path #include "Protocols/UserDefinedCaptureProtocol.h"

Syntax

UCLASS (Abstract, Blueprintable, Meta=(DisplayName="Capture Protocol"), MinimalAPI)  
class UUserDefinedCaptureProtocol : public UMovieSceneImageCaptureProtocolBase

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UUserDefinedCaptureProtocol ( const FObjectInitializer& ObjInit
)

   Protocols/UserDefinedCaptureProtocol.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FString GenerateFilename ( const FFrameMetrics& InFrameMetrics
) const

 Generate a filename for the current frame Protocols/UserDefinedCaptureProtocol.h
  • BlueprintCallable
  • Category=Capture

FFrameMetrics GetCurrentFrameMetrics()

 Access this protocol's current frame metrics Protocols/UserDefinedCaptureProtocol.h
  • BlueprintCallable
  • Category=Capture

void OnPixelsReceivedImpl ( const FCapturedPixels& Pixels,
const FCapturedPixelsID& StreamID,
FFrameMetrics FrameMetrics
)

 Called when image pixel data is ready to be processed Protocols/UserDefinedCaptureProtocol.h  

void ReportOutstandingWork ( int32 NumNewOperations
)

 INTERNAL: Report that the protocol is dispatching the specified number of asynchronous tasks that need to be completed before this protocol can be finalized Protocols/UserDefinedCaptureProtocol.h  

void ResolveBuffer ( UTexture* Buffer,
const FCapturedPixelsID& BufferID
)

 Resolve the specified buffer and pass it directly to the specified handler when done (does not pass to any bound streams) Protocols/UserDefinedCaptureProtocol.h
  • BlueprintCallable
  • Category=Capture

void StartCapturingFinalPixels ( const FCapturedPixelsID& StreamID
)

 Instruct this protocol to start capturing LDR final pixels (including slate widgets and burn-ins) Protocols/UserDefinedCaptureProtocol.h
  • BlueprintCallable
  • Category=Capture

void StopCapturingFinalPixels()

 Instruct this protocol to stop capturing LDR final pixels Protocols/UserDefinedCaptureProtocol.h
  • BlueprintCallable
  • Category=Capture

Protected

Name Remarks Include Path Unreal Specifiers

void OnBeginFinalize()

 Called when this protocol is going to be shut down - should not capture any more frames Protocols/UserDefinedCaptureProtocol.h
  • BlueprintImplementableEvent
  • Category=Capture

bool OnCanFinalize()

 Called to check whether this protocol has finished any pending tasks, and can now be shut down Protocols/UserDefinedCaptureProtocol.h
  • BlueprintNativeEvent
  • Category=Capture

virtual bool OnCanFinalize_Implementation()

   Protocols/UserDefinedCaptureProtocol.h
  • BlueprintNativeEvent
  • Category=Capture

void OnCaptureFrame()

 Called when this protocol should capture the current frame Protocols/UserDefinedCaptureProtocol.h
  • BlueprintImplementableEvent
  • Category=Capture

void OnFinalize()

 Called to complete finalization of this protocol Protocols/UserDefinedCaptureProtocol.h
  • BlueprintImplementableEvent
  • Category=Capture

void OnPauseCapture()

 Called when this protocol should temporarily stop capturing frames Protocols/UserDefinedCaptureProtocol.h
  • BlueprintImplementableEvent
  • Category=Capture

void OnPixelsReceived ( const FCapturedPixels& Pixels,
const FCapturedPixelsID& ID,
FFrameMetrics FrameMetrics
)

 Called when pixels have been received for the specified stream name Protocols/UserDefinedCaptureProtocol.h
  • BlueprintImplementableEvent
  • Category=Capture

void OnPreTick()

 Called before the capture process itself is ticked, before each frame is set up for capture Useful for any pre-frame set up or resetting the previous frame's state Protocols/UserDefinedCaptureProtocol.h
  • BlueprintImplementableEvent
  • Category=Capture

bool OnSetup()

 Called once at the start of the capture process, but before any warmup frames Protocols/UserDefinedCaptureProtocol.h
  • BlueprintNativeEvent
  • Category=Capture

virtual bool OnSetup_Implementation()

   Protocols/UserDefinedCaptureProtocol.h
  • BlueprintNativeEvent
  • Category=Capture

void OnStartCapture()

 Called when this protocol should start capturing frames Protocols/UserDefinedCaptureProtocol.h
  • BlueprintImplementableEvent
  • Category=Capture

void OnTick()

 Called after the capture process itself is ticked, after the frame is set up for capture, but before most actors have ticked Protocols/UserDefinedCaptureProtocol.h
  • BlueprintImplementableEvent
  • Category=Capture

void OnWarmUp ()

 Called when the capture process is warming up. Protocols/UserDefinedCaptureProtocol.h
  • BlueprintImplementableEvent
  • Category=Capture

Overridden from UMovieSceneCaptureProtocolBase

Name Remarks Include Path Unreal Specifiers

virtual void AddFormatMappingsImpl ( TMap< FString, FStringFormatArg >& FormatMappings
) const

 Called when generating formatting filename to add any additional format mappings Protocols/UserDefinedCaptureProtocol.h  

virtual void BeginFinalizeImpl()

 Called when we have finished capturing and we should start finalizing the capture Protocols/UserDefinedCaptureProtocol.h  

virtual void CaptureFrameImpl ( const FFrameMetrics& FrameMetrics
)

 Instruct this protocol to capture a frame relating to the specified metrics Protocols/UserDefinedCaptureProtocol.h  

virtual void FinalizeImpl()

 Called when we have finished capturing Protocols/UserDefinedCaptureProtocol.h  

virtual UWorld * GetWorld()

 ~ End UMovieSceneCaptureProtocolBase implementation ~ Begin UObject implementation Protocols/UserDefinedCaptureProtocol.h  

virtual bool HasFinishedProcessingImpl ()

 Check whether this protocol has any processing left to do, or whether it should be finalized. Protocols/UserDefinedCaptureProtocol.h  

virtual void PreTickImpl()

 ~ Begin UMovieSceneCaptureProtocolBase implementation Protocols/UserDefinedCaptureProtocol.h  

virtual bool SetupImpl()

 Called once at the start of the capture process (before any warmup) to set up anything required for the capture. Protocols/UserDefinedCaptureProtocol.h  

virtual bool StartCaptureImpl()

 Start capturing Protocols/UserDefinedCaptureProtocol.h  

virtual void TickImpl()

 Called on the main thread to do any additional processing Protocols/UserDefinedCaptureProtocol.h  

virtual void WarmUpImpl()

 Start warming up this capture protocol Protocols/UserDefinedCaptureProtocol.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page