UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCapturedFrames Struct Reference

#include <AVIWriter.h>

Public Member Functions

 FCapturedFrames (const FString &InArchiveDirectory, int32 InMaxInMemoryFrames)
 
 ~FCapturedFrames ()
 
void Add (FCapturedFrame Frame)
 
TArray< FCapturedFrameReadFrames (uint32 WaitTimeMs)
 
int32 GetNumOutstandingFrames () const
 

Detailed Description

Container for managing captured frames. Temporarily archives frames to the file system when capture rate drops.

Constructor & Destructor Documentation

◆ FCapturedFrames()

FCapturedFrames::FCapturedFrames ( const FString &  InArchiveDirectory,
int32  InMaxInMemoryFrames 
)

Construct from a directory to place archives in, and a maximum number of frames we can hold in

◆ ~FCapturedFrames()

FCapturedFrames::~FCapturedFrames ( )

Member Function Documentation

◆ Add()

void FCapturedFrames::Add ( FCapturedFrame  Frame)

Add a captured frame to this container. Only to be called from the owner tasread.

◆ GetNumOutstandingFrames()

int32 FCapturedFrames::GetNumOutstandingFrames ( ) const

Retrieve the number of oustanding frames we have not processed yet

◆ ReadFrames()

TArray< FCapturedFrame > FCapturedFrames::ReadFrames ( uint32  WaitTimeMs)

Read frames from this container (potentially from a thread)


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