Navigation
API > API/Runtime > API/Runtime/MovieSceneCapture
| Name | UImageSequenceProtocol |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieSceneCapture/Public/Protocols/ImageSequenceProtocol.h |
| Include Path | #include "Protocols/ImageSequenceProtocol.h" |
Syntax
UCLASS (Abstract, Config=EditorPerProjectUserSettings, MinimalAPI)
class UImageSequenceProtocol : public UFrameGrabberProtocol
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneCaptureProtocolBase → UMovieSceneImageCaptureProtocolBase → UFrameGrabberProtocol → UImageSequenceProtocol
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UImageSequenceProtocol
(
const FObjectInitializer& ObjInit |
Protocols/ImageSequenceProtocol.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FinalizeFence | TFuture< void > | A future that is created on BeginFinalize from a fence in the image write queue that will be fulfilled when all currently pending tasks have been completed | Protocols/ImageSequenceProtocol.h | |
| ImageWriteQueue | IImageWriteQueue * | A pointer to the image write queue used for asynchronously writing images | Protocols/ImageSequenceProtocol.h | |
| StringFormatMap | TMap< FString, FStringFormatArg > | Custom string format arguments for filenames | Protocols/ImageSequenceProtocol.h |
Functions
Public
Overridden from UFrameGrabberProtocol
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FFramePayloadPtr GetFramePayload
(
const FFrameMetrics& FrameMetrics |
~UFrameGrabberProtocol implementation | Protocols/ImageSequenceProtocol.h | |
virtual void ProcessFrame
(
FCapturedFrameData Frame |
Process a captured frame. This may be called on any thread. | Protocols/ImageSequenceProtocol.h |
Overridden from UMovieSceneCaptureProtocolBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddFormatMappingsImpl
(
TMap< FString, FStringFormatArg >& FormatMappings |
Called when generating formatting filename to add any additional format mappings | Protocols/ImageSequenceProtocol.h | |
virtual void BeginFinalizeImpl() |
Called when we have finished capturing and we should start finalizing the capture | Protocols/ImageSequenceProtocol.h | |
virtual void FinalizeImpl() |
Called when we have finished capturing | Protocols/ImageSequenceProtocol.h | |
virtual bool HasFinishedProcessingImpl() |
~ UMovieSceneCaptureProtocolBase Implementation | Protocols/ImageSequenceProtocol.h | |
virtual void OnLoadConfigImpl
(
FMovieSceneCaptureSettings& InSettings |
Called when this protocol has been loaded | Protocols/ImageSequenceProtocol.h | |
virtual void OnReleaseConfigImpl
(
FMovieSceneCaptureSettings& InSettings |
Called when this protocol has been released | Protocols/ImageSequenceProtocol.h | |
virtual bool SetupImpl() |
~End UFrameGrabberProtocol implementation ~ UMovieSceneCaptureProtocol implementation | Protocols/ImageSequenceProtocol.h |