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)

Unreal Engine C++ API Reference > Runtime > MovieSceneCapture

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

  Type Name Description
Protected variable const ICaptureProtocolHost * CaptureHost The capture host that is owns this protocol
Protected variable TOptional< FCaptureProtocolInitSettings > InitSettings Initialization settings

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const void Called when generating formatting filename to add any additional format mappings
Protected function Virtual Const void Called when generating formatting filename to add any additional format mappings
Public function void Called when we have finished capturing and we should start finalizing the capture
Protected function Virtual void 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  
Public function void Called when this protocol should tear down and finalize all its processing.
Protected function Virtual void Called when we have finished capturing
Protected function Virtual Const FString

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

  
Public function Const EMovieSceneCaptureProtocolState Get the current state of this capture protocol
Public function Virtual Const UWorld * Get the UWorld associated with this Capture Protocol.
Public function Const bool Check whether this protocol has any processing left to do, or whether it should be finalized.
Protected function Virtual Const bool Check whether this protocol has any processing left to do, or whether it should be finalized.
Public function Const bool Check whether we can capture a frame from this protocol
Public function void Called when this protocol has been loaded
Protected function Virtual void Called when this protocol has been loaded
Public function void Called when this protocol has been released
Protected function Virtual void Called when this protocol has been released
Protected function Virtual void 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 Called on the main thread before the movie capture itself is updated to reset per-frame state
Public function bool

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

 Setup this capture protocol
Protected function Virtual bool Called once at the start of the capture process (before any warmup) to set up anything required for the capture.
Public function bool Called when this protocol should start capturing
Protected function Virtual bool Start capturing
Public function void

Tick ()

 Called on the main thread to do any additional processing
Protected function Virtual void 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 Start warming up this capture protocol

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page