FAVIWriter Class Reference

#include <AVIWriter.h>

Public Member Functions
virtual AVIWRITER_API	~FAVIWriter ()
TArray< FCapturedFrame >	GetFrameData (uint32 WaitTimeMs) const
int32	GetNumOutstandingFrames () const
uint32	GetWidth () const
uint32	GetHeight () const
int32	GetFrameNumber () const
bool	IsCapturing () const
AVIWRITER_API void	Update (double FrameTimeSeconds, TArray< FColor > FrameData)
virtual void	Initialize ()=0
virtual void	Finalize ()=0
virtual void	DropFrames (int32 NumFramesToDrop)=0

Static Public Member Functions
static AVIWRITER_API FAVIWriter *	CreateInstance (const FAVIWriterOptions &InOptions)

Public Attributes
FAVIWriterOptions	Options

Protected Member Functions
	FAVIWriter (const FAVIWriterOptions &InOptions)

Protected Attributes
FThreadSafeBool	bCapturing
int32	FrameNumber
TUniquePtr< FCapturedFrames >	CapturedFrames

Detailed Description

Class responsible for writing frames out to an AVI file

Constructor & Destructor Documentation

FAVIWriter()

FAVIWriter::FAVIWriter ( const FAVIWriterOptions &  InOptions )

inlineprotected

Protected constructor to avoid abuse.

~FAVIWriter()

FAVIWriter::~FAVIWriter ( )

virtual

Public destruction

Member Function Documentation

CreateInstance()

FAVIWriter * FAVIWriter::CreateInstance ( const FAVIWriterOptions &  InOptions )

static

Create a new avi writer from the specified options

DropFrames()

virtual void FAVIWriter::DropFrames ( int32  NumFramesToDrop )

pure virtual

Finalize()

virtual void FAVIWriter::Finalize ( )

pure virtual

GetFrameData()

TArray< FCapturedFrame > FAVIWriter::GetFrameData ( uint32  WaitTimeMs ) const

inline

Access captured frame data. Safe to be called from any thread.

GetFrameNumber()

int32 FAVIWriter::GetFrameNumber ( ) const

inline

GetHeight()

uint32 FAVIWriter::GetHeight ( ) const

inline

GetNumOutstandingFrames()

int32 FAVIWriter::GetNumOutstandingFrames ( ) const

inline

Retrieve the number of oustanding frames we have not processed yet

GetWidth()

uint32 FAVIWriter::GetWidth ( ) const

inline

Initialize()

virtual void FAVIWriter::Initialize ( )

pure virtual

IsCapturing()

bool FAVIWriter::IsCapturing ( ) const

inline

Update()

void FAVIWriter::Update	(	double	FrameTimeSeconds,
		TArray< FColor >	FrameData
	)

Member Data Documentation

bCapturing

FThreadSafeBool FAVIWriter::bCapturing

protected

Whether we are capturing or not

CapturedFrames

TUniquePtr<FCapturedFrames> FAVIWriter::CapturedFrames

mutableprotected

Container that manages frames that we have already captured

FrameNumber

int32 FAVIWriter::FrameNumber

protected

The current frame number

Options

FAVIWriterOptions FAVIWriter::Options

Creation options

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h
• Engine/Source/Runtime/AVIWriter/Private/AVIWriter.cpp