ICaptureProtocolHost Struct Reference

#include <MovieSceneCaptureProtocolBase.h>

Inheritance diagram for ICaptureProtocolHost:

Public Member Functions
virtual const FMovieSceneCaptureSettings &	GetSettings () const =0
virtual const int32	GetFrameNumberOffset () const =0
virtual FFrameRate	GetCaptureFrameRate () const =0
virtual const ICaptureStrategy &	GetCaptureStrategy () const =0
virtual FString	ResolveFileFormat (const FString &Format, const FFrameMetrics &FrameMetrics) const =0
virtual double	GetEstimatedCaptureDurationSeconds () const =0

Detailed Description

Interface to be implemented by any class using an UMovieSceneCaptureProtocolBase instance

Member Function Documentation

GetCaptureFrameRate()

virtual FFrameRate ICaptureProtocolHost::GetCaptureFrameRate ( ) const

pure virtual

Get the capture frequency

Implemented in UMovieSceneCapture.

GetCaptureStrategy()

virtual const ICaptureStrategy & ICaptureProtocolHost::GetCaptureStrategy ( ) const

pure virtual

Access the host's capture strategy

Implemented in UMovieSceneCapture.

GetEstimatedCaptureDurationSeconds()

virtual double ICaptureProtocolHost::GetEstimatedCaptureDurationSeconds ( ) const

pure virtual

Ask the host to inform us of how long the capture duration is expected to be. Should only be used as an estimate due to the possible complexities in calculating the duration due to handle frames, warmups, etc.

Implemented in UMovieSceneCapture.

GetFrameNumberOffset()

virtual const int32 ICaptureProtocolHost::GetFrameNumberOffset ( ) const

pure virtual

Access Frame number index offset when saving out frames.

Implemented in UMovieSceneCapture.

GetSettings()

virtual const FMovieSceneCaptureSettings & ICaptureProtocolHost::GetSettings ( ) const

pure virtual

Get shared settings for the capture

Implemented in UMovieSceneCapture.

ResolveFileFormat()

virtual FString ICaptureProtocolHost::ResolveFileFormat ( const FString &  Format, const FFrameMetrics &  FrameMetrics  ) const

pure virtual

Ask the host to resolve the format string for a file name.

Implemented in UMovieSceneCapture.

---

The documentation for this struct was generated from the following file:

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