FCapturedFrames | Unreal Engine 5.6 Documentation

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


Name	FCapturedFrames
Type	struct
Header File	/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h
Include Path	#include "AVIWriter.h"

Syntax

struct FCapturedFrames

Name	Remarks	Include Path	Unreal Specifiers
FCapturedFrames ( const FString& InArchiveDirectory, int32 InMaxInMemoryFrames )	Construct from a directory to place archives in, and a maximum number of frames we can hold in	AVIWriter.h

Name	Remarks	Include Path	Unreal Specifiers
~FCapturedFrames()		AVIWriter.h

Name	Type	Remarks	Include Path
ArchivedFrames	TArray< uint32 >	Array of unique frame indices that have been archived	AVIWriter.h
ArchiveDirectory	FString	The directory in which we will place temporarily archived frames	AVIWriter.h
ArchiveFrameMutex	FCriticalSection	A mutex to protect the archived frame indices	AVIWriter.h
FrameReady	FEvent *	An event that triggers when there are in-memory frames ready for collection	AVIWriter.h
InMemoryFrameMutex	FCriticalSection	Mutex to protect the in memory frames	AVIWriter.h
InMemoryFrames	TArray< FCapturedFrame >	Array of in-memory captured frames	AVIWriter.h
MaxInMemoryFrames	int32	The maximum number of frames we are to store in memory before archiving	AVIWriter.h
TotalArchivedFrames	uint32	The total number of frames that have been archived since capturing started	AVIWriter.h
UnarchiveTask	TOptional< TFuture< void > >	Unarchive task result	AVIWriter.h

Name	Remarks	Include Path
void Add ( FCapturedFrame Frame )	Add a captured frame to this container. Only to be called from the owner tasread.	AVIWriter.h
int32 GetNumOutstandingFrames()	Retrieve the number of oustanding frames we have not processed yet	AVIWriter.h
TArray< FCapturedFrame > ReadFrames ( uint32 WaitTimeMs )	Read frames from this container (potentially from a thread)	AVIWriter.h