Module |
|
Header |
/Engine/Source/Runtime/MovieSceneCapture/Public/MovieSceneCaptureProtocolBase.h |
Include |
#include "MovieSceneCaptureProtocolBase.h" |
class UMovieSceneCaptureProtocolBase : public UObject
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 | Description | ||
---|---|---|---|
|
const ICaptureP... |
CaptureHost |
The capture host that is owns this protocol |
|
InitSettings |
Initialization settings |
Name | Description | |
---|---|---|
|
UMovieSceneCaptureProtocolBase ( |
Name | Description | ||
---|---|---|---|
|
AddFormatMappings ( |
Called when generating formatting filename to add any additional format mappings |
|
|
AddFormatMappingsImpl ( |
Called when generating formatting filename to add any additional format mappings |
|
|
BeginFinalize() |
Called when we have finished capturing and we should start finalizing the capture |
|
|
BeginFinalizeImpl() |
Called when we have finished capturing and we should start finalizing the capture |
|
|
CanWriteToFile |
Test whether this capture protocol thinks the file should be written to. |
|
|
CanWriteToFileImpl |
Test whether this capture protocol thinks the file should be written to. |
|
|
CaptureFrame ( |
Instruct this protocol to capture a frame relating to the specified metrics |
|
|
CaptureFrameImpl ( |
Instruct this protocol to capture a frame relating to the specified metrics |
|
|
EnsureFileWritableImpl ( |
||
|
Finalize() |
Called when this protocol should tear down and finalize all its processing. |
|
|
FinalizeImpl() |
Called when we have finished capturing |
|
|
GenerateFilenameImpl ( |
||
|
EMovieSceneC... |
GetState() |
Get the current state of this capture protocol |
|
UWorld * |
GetWorld() |
Get the UWorld associated with this Capture Protocol. |
|
HasFinishedProcessing() |
Check whether this protocol has any processing left to do, or whether it should be finalized. |
|
|
HasFinishedProcessingImpl() |
Check whether this protocol has any processing left to do, or whether it should be finalized. |
|
|
IsCapturing() |
Check whether we can capture a frame from this protocol |
|
|
OnLoadConfig ( |
Called when this protocol has been loaded |
|
|
OnLoadConfigImpl ( |
Called when this protocol has been loaded |
|
|
OnReleaseConfig ( |
Called when this protocol has been released |
|
|
OnReleaseConfigImpl ( |
Called when this protocol has been released |
|
|
PauseCaptureImpl() |
Pause capturing |
|
|
PreTick() |
Called on the main thread before the movie capture itself is updated to reset per-frame state |
|
|
PreTickImpl() |
Called on the main thread before the movie capture itself is updated to reset per-frame state |
|
|
Setup ( |
Setup this capture protocol |
|
|
SetupImpl() |
Called once at the start of the capture process (before any warmup) to set up anything required for the capture. |
|
|
StartCapture() |
Called when this protocol should start capturing |
|
|
StartCaptureImpl() |
Start capturing |
|
|
Tick() |
Called on the main thread to do any additional processing |
|
|
TickImpl() |
Called on the main thread to do any additional processing |
|
|
WarmUp() |
Start warming up this capture protocol - called any time the process enters a warming-up state |
|
|
WarmUpImpl() |
Start warming up this capture protocol |