Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MovieSceneCapture > Protocols > UFrameGrabberProtocol > UFrameGrabberProtocol::GetFramePayload

Light Theme

Dark Theme

UFrameGrabberProtocol::GetFramePayload

~ End [UMovieSceneCaptureProtocolBase](API\Runtime\MovieSceneCapture\UMovieSceneCaptureProtocolBase) Implementation Retrieve an arbitrary set of data that relates to the specified frame metrics.

Windows

MacOS

Linux

Override Hierarchy

UFrameGrabberProtocol::GetFramePayload()

	UImageSequenceProtocol::GetFramePayload()
	UVideoCaptureProtocol::GetFramePayload()

References

Module	MovieSceneCapture
Header	/Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/FrameGrabberProtocol.h
Include	#include "Protocols/FrameGrabberProtocol.h"

Syntax

virtual FFramePayloadPtr GetFramePayload
(
const FFrameMetrics & FrameMetrics
)

Remarks

~ End UMovieSceneCaptureProtocolBase Implementation Retrieve an arbitrary set of data that relates to the specified frame metrics. This data will be passed through the capture pipeline, and will be accessible from ProcessFrame

Returns

Shared pointer to a payload to associate with the frame, or nullptr

Parameters

Parameter	Description
FrameMetrics	Metrics specific to the current frame
Host	The host that is managing this protocol

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss