FrameGrabberProtocol.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "MovieSceneCaptureProtocolBase.h"
#include "FrameGrabber.h"
 
#include "FrameGrabberProtocol.generated.h"
 
 
UCLASS(Abstract, config=EditorPerProjectUserSettings, MinimalAPI)
class UFrameGrabberProtocol : public UMovieSceneImageCaptureProtocolBase
{
public:
 
    GENERATED_BODY()
 
    UFrameGrabberProtocol(const FObjectInitializer& ObjectInit)
        : Super(ObjectInit)
        , DesiredPixelFormat(PF_B8G8R8A8)
        , RingBufferSize(3)
    {}
 
    EPixelFormat DesiredPixelFormat;
 
    uint32 RingBufferSize;
 
protected:
 
    MOVIESCENECAPTURE_API virtual bool HasFinishedProcessingImpl() const override;
    MOVIESCENECAPTURE_API virtual bool SetupImpl() override;
    MOVIESCENECAPTURE_API virtual void CaptureFrameImpl(const FFrameMetrics& FrameMetrics);
    MOVIESCENECAPTURE_API virtual void TickImpl() override;
    MOVIESCENECAPTURE_API virtual void BeginFinalizeImpl() override;
    MOVIESCENECAPTURE_API virtual void FinalizeImpl() override;
protected:
 
    virtual FFramePayloadPtr GetFramePayload(const FFrameMetrics& FrameMetrics) PURE_VIRTUAL(UFrameGrabberProtocol::GetFramePayload, return nullptr;)
 
    virtual void ProcessFrame(FCapturedFrameData Frame) PURE_VIRTUAL(UFrameGrabberProtocol::ProcessFrame,)
 
private:
 
    TUniquePtr<FFrameGrabber> FrameGrabber;
};