1. Epic GamesDeveloper
  3. UMovieSceneCaptureProtocolBase

UMovieSceneCaptureProtocolBase

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

API > API/Runtime > API/Runtime/MovieSceneCapture

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

   
Name UMovieSceneCaptureProtocolBase
Type class
Header File /Engine/Source/Runtime/MovieSceneCapture/Public/MovieSceneCaptureProtocolBase.h
Include Path #include "MovieSceneCaptureProtocolBase.h"

Syntax

UCLASS (Config=EditorPerProjectUserSettings, PerObjectConfig, Abstract, MinimalAPI)  
class UMovieSceneCaptureProtocolBase : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneCaptureProtocolBase ( const FObjectInitializer& ObjInit
)

   MovieSceneCaptureProtocolBase.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bFrameRequested bool Double buffer of values tracking whether we are capturing changes based on GFrameCounter MovieSceneCaptureProtocolBase.h  
State EMovieSceneCaptureProtocolState The current state of the protocol MovieSceneCaptureProtocolBase.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Called when generating formatting filename to add any additional format mappings MovieSceneCaptureProtocolBase.h  

void BeginFinalize()

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

bool CanWriteToFile ( const TCHAR* InFilename,
bool bOverwriteExisting
) const

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

void CaptureFrame ( const FFrameMetrics& FrameMetrics
)

 Instruct this protocol to capture a frame relating to the specified metrics MovieSceneCaptureProtocolBase.h  

void Finalize ()

 Called when this protocol should tear down and finalize all its processing. MovieSceneCaptureProtocolBase.h  
Get the current state of this capture protocol MovieSceneCaptureProtocolBase.h
  • BlueprintCallable
  • Category=Capture

virtual UWorld * GetWorld ()

 Get the UWorld associated with this Capture Protocol. MovieSceneCaptureProtocolBase.h  
Check whether this protocol has any processing left to do, or whether it should be finalized. MovieSceneCaptureProtocolBase.h  

bool IsCapturing()

 Check whether we can capture a frame from this protocol MovieSceneCaptureProtocolBase.h
  • BlueprintCallable
  • Category=Capture

void OnLoadConfig ( FMovieSceneCaptureSettings& InSettings
)

 Called when this protocol has been loaded MovieSceneCaptureProtocolBase.h  

void OnReleaseConfig ( FMovieSceneCaptureSettings& InSettings
)

 Called when this protocol has been released MovieSceneCaptureProtocolBase.h  

void PreTick()

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

bool Setup ( const FCaptureProtocolInitSettings& InSettings,
const ICaptureProtocolHost* Host
)

 Setup this capture protocol MovieSceneCaptureProtocolBase.h  

bool StartCapture()

 Called when this protocol should start capturing MovieSceneCaptureProtocolBase.h  

void Tick()

 Called on the main thread to do any additional processing MovieSceneCaptureProtocolBase.h  

void WarmUp()

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

Protected

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 MovieSceneCaptureProtocolBase.h  

virtual void BeginFinalizeImpl()

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

virtual bool CanWriteToFileImpl ( const TCHAR* InFilename,
bool bOverwriteExisting
) const

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

virtual void CaptureFrameImpl ( const FFrameMetrics& FrameMetrics
)

 Instruct this protocol to capture a frame relating to the specified metrics MovieSceneCaptureProtocolBase.h  

void EnsureFileWritableImpl ( const FString& File
) const

   MovieSceneCaptureProtocolBase.h  

virtual void FinalizeImpl()

 Called when we have finished capturing MovieSceneCaptureProtocolBase.h  

virtual FString GenerateFilenameImpl ( const FFrameMetrics& FrameMetrics,
const TCHAR* Extension,
const FString* NameFormatString
) const

   MovieSceneCaptureProtocolBase.h  

virtual bool HasFinishedProcessingImpl ()

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

virtual void OnLoadConfigImpl ( FMovieSceneCaptureSettings& InSettings
)

 Called when this protocol has been loaded MovieSceneCaptureProtocolBase.h  

virtual void OnReleaseConfigImpl ( FMovieSceneCaptureSettings& InSettings
)

 Called when this protocol has been released MovieSceneCaptureProtocolBase.h  

virtual void PauseCaptureImpl()

 Pause capturing MovieSceneCaptureProtocolBase.h  

virtual void PreTickImpl()

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

virtual bool SetupImpl()

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

virtual bool StartCaptureImpl()

 Start capturing MovieSceneCaptureProtocolBase.h  

virtual void TickImpl()

 Called on the main thread to do any additional processing MovieSceneCaptureProtocolBase.h  

virtual void WarmUpImpl()

 Start warming up this capture protocol MovieSceneCaptureProtocolBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page