FAVIWriter

Class responsible for writing frames out to an AVI file

Windows
MacOS
Linux

References

Module

AVIWriter

Header

/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h

Include

#include "AVIWriter.h"

Syntax

class FAVIWriter

Remarks

Class responsible for writing frames out to an AVI file

Variables

Name Description

Protected variable

FThreadSafeBool

 

bCapturing

Whether we are capturing or not

Protected variable

TUniquePtr< FCa...

 

CapturedFrames

Container that manages frames that we have already captured

Protected variable

int32

 

FrameNumber

The current frame number

Public variable

FAVIWriterOptio...

 

Options

Creation options

Constructors

Name Description

Protected function

FAVIWriter

(
    const FAVIWriterOptions& InOptions
)

Protected constructor to avoid abuse.

Destructors

Name Description

Public function Virtual

~FAVIWriter()

Public destruction

Functions

Name Description

Public function Static

FAVIWriter &...

 

CreateInstance

(
    const FAVIWriterOptions& InOptions
)

Create a new avi writer from the specified options

Public function

void

 

DropFrames

(
    int32 NumFramesToDrop
)

Public function

void

 

Finalize()

Public function Const

TArray< FCap...

 

GetFrameData

(
    uint32 WaitTimeMs
)

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

Public function Const

int32

 

GetFrameNumber()

Public function Const

uint32

 

GetHeight()

Public function Const

int32

 

GetNumOutstandingFrames()

Retrieve the number of oustanding frames we have not processed yet

Public function Const

uint32

 

GetWidth()

Public function

void

 

Initialize()

Public function Const

bool

 

IsCapturing()

Public function

void

 

Update

(
    double FrameTimeSeconds,
    TArray< FColor > FrameData
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss