UMovieSceneCaptureProtocolBase

A capture protocol responsible for dealing with captured frames using some custom method (writing out to disk, streaming, etc)

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MovieSceneCapture

Header

/Engine/Source/Runtime/MovieSceneCapture/Public/MovieSceneCaptureProtocolBase.h

Include

#include "MovieSceneCaptureProtocolBase.h"

Syntax

class UMovieSceneCaptureProtocolBase : public UObject

Remarks

A capture protocol responsible for dealing with captured frames using some custom method (writing out to disk, streaming, etc)

A typical process for capture consits of the following process: Setup -> [ Warm up -> [ Capture Frame ] ] -> Begin Finalize -> [ HasFinishedProcessing ] -> Finalize

Variables

Name Description

Protected variable

const ICaptureP...

 

CaptureHost

The capture host that is owns this protocol

Protected variable

TOptional< FCap...

 

InitSettings

Initialization settings

Constructors

Name Description

Public function

UMovieSceneCaptureProtocolBase

(
    const FObjectInitializer& ObjInit
)

Functions

Name Description

Public function Const

void

 

AddFormatMappings

(
    TMap< FString, FStringFormatArg >&...
)

Called when generating formatting filename to add any additional format mappings

Protected function Virtual Const

void

 

AddFormatMappingsImpl

(
    TMap< FString, FStringFormatArg >&...
)

Called when generating formatting filename to add any additional format mappings

Public function

void

 

BeginFinalize()

Called when we have finished capturing and we should start finalizing the capture

Protected function Virtual

void

 

BeginFinalizeImpl()

Called when we have finished capturing and we should start finalizing the capture

Public function Const

bool

 

CanWriteToFile

(
    const TCHAR* InFilename,
    bool bOverwriteExisting
)

Test whether this capture protocol thinks the file should be written to.

Protected function Virtual Const

bool

 

CanWriteToFileImpl

(
    const TCHAR* InFilename,
    bool bOverwriteExisting
)

Test whether this capture protocol thinks the file should be written to.

Public function

void

 

CaptureFrame

(
    const FFrameMetrics& FrameMetrics
)

Instruct this protocol to capture a frame relating to the specified metrics

Protected function Virtual

void

 

CaptureFrameImpl

(
    const FFrameMetrics& FrameMetrics
)

Instruct this protocol to capture a frame relating to the specified metrics

Protected function Const

void

 

EnsureFileWritableImpl

(
    const FString& File
)

Public function

void

 

Finalize()

Called when this protocol should tear down and finalize all its processing.

Protected function Virtual

void

 

FinalizeImpl()

Called when we have finished capturing

Protected function Virtual Const

FString

 

GenerateFilenameImpl

(
    const FFrameMetrics& FrameMetrics,
    const TCHAR* Extension,
    const FString* NameFormatStrin...
)

Public function Const

EMovieSceneC...

 

GetState()

Get the current state of this capture protocol

Public function Virtual Const

UWorld *

 

GetWorld()

Get the UWorld associated with this Capture Protocol.

Public function Const

bool

 

HasFinishedProcessing()

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

Protected function Virtual Const

bool

 

HasFinishedProcessingImpl()

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

Public function Const

bool

 

IsCapturing()

Check whether we can capture a frame from this protocol

Public function

void

 

OnLoadConfig

(
    FMovieSceneCaptureSettings& InSett...
)

Called when this protocol has been loaded

Protected function Virtual

void

 

OnLoadConfigImpl

(
    FMovieSceneCaptureSettings& InSett...
)

Called when this protocol has been loaded

Public function

void

 

OnReleaseConfig

(
    FMovieSceneCaptureSettings& InSett...
)

Called when this protocol has been released

Protected function Virtual

void

 

OnReleaseConfigImpl

(
    FMovieSceneCaptureSettings& InSett...
)

Called when this protocol has been released

Protected function Virtual

void

 

PauseCaptureImpl()

Pause capturing

Public function

void

 

PreTick()

Called on the main thread before the movie capture itself is updated to reset per-frame state

Protected function Virtual

void

 

PreTickImpl()

Called on the main thread before the movie capture itself is updated to reset per-frame state

Public function

bool

 

Setup

(
    const FCaptureProtocolInitSettings ...,
    const ICaptureProtocolHost* Ho...
)

Setup this capture protocol

Protected function Virtual

bool

 

SetupImpl()

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

Public function

bool

 

StartCapture()

Called when this protocol should start capturing

Protected function Virtual

bool

 

StartCaptureImpl()

Start capturing

Public function

void

 

Tick()

Called on the main thread to do any additional processing

Protected function Virtual

void

 

TickImpl()

Called on the main thread to do any additional processing

Public function

void

 

WarmUp()

Start warming up this capture protocol - called any time the process enters a warming-up state

Protected function Virtual

void

 

WarmUpImpl()

Start warming up this capture protocol