Navigation
API > API/Runtime > API/Runtime/AVIWriter
Class responsible for writing frames out to an AVI file
| Name | FAVIWriter |
| Type | class |
| Header File | /Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h |
| Include Path | #include "AVIWriter.h" |
Syntax
class FAVIWriter
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAVIWriter
(
const FAVIWriterOptions& InOptions |
Protected constructor to avoid abuse. | AVIWriter.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAVIWriter() |
Public destruction | AVIWriter.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Options | FAVIWriterOptions | Creation options | AVIWriter.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DropFrames
(
int32 NumFramesToDrop |
AVIWriter.h | ||
void Finalize() |
AVIWriter.h | ||
TArray< FCapturedFrame > GetFrameData
(
uint32 WaitTimeMs |
Access captured frame data. Safe to be called from any thread. | AVIWriter.h | |
int32 GetFrameNumber() |
AVIWriter.h | ||
uint32 GetHeight() |
AVIWriter.h | ||
int32 GetNumOutstandingFrames() |
Retrieve the number of oustanding frames we have not processed yet | AVIWriter.h | |
uint32 GetWidth() |
AVIWriter.h | ||
void Initialize() |
AVIWriter.h | ||
bool IsCapturing() |
AVIWriter.h | ||
| AVIWriter.h |
Protected
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FAVIWriter * CreateInstance
(
const FAVIWriterOptions& InOptions |
Create a new avi writer from the specified options | AVIWriter.h |