description: Create a new avi writer from the specified options

module: AVIWriter

code: static [FAVIWriter](API\Runtime\AVIWriter\FAVIWriter) * CreateInstance ( const [FAVIWriterOptions](API\Runtime\AVIWriter\FAVIWriterOptions) & InOptions )


code: void DropFrames ( int32 NumFramesToDrop )


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

code: [TArray](API\Runtime\Core\Containers\TArray)< [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) > GetFrameData ( uint32 WaitTimeMs ) const


description: Retrieve the number of oustanding frames we have not processed yet

code: int32 GetNumOutstandingFrames() const


code: void Update ( double FrameTimeSeconds, [TArray](API\Runtime\Core\Containers\TArray)< [FColor](API\Runtime\Core\Math\FColor) > FrameData )


description: Protected constructor to avoid abuse.

code: FAVIWriter ( const [FAVIWriterOptions](API\Runtime\AVIWriter\FAVIWriterOptions) & InOptions )


description: Public destruction

code: virtual ~FAVIWriter()


className: FAVIWriter

description: Class responsible for writing frames out to an AVI file

code: class FAVIWriter

bCapturing

type: FThreadSafeBool

description: Whether we are capturing or not

CapturedFrames

type: TUniquePtr<FCa...

description: Container that manages frames that we have already captured

FrameNumber

description: The current frame number

Options

type: FAVIWriterOptio...

description: Creation options


className: FAVIWriterOptions

description: Creation options for the AVI writer

code: struct FAVIWriterOptions

bSynchronizeFrames

type: bool

description: When true, the game thread will block until captured frames have been processed by the avi writer

CaptureFramerateDenominator

description: The denominator of the captured video, ie (30/1) will capture at 30 frames per second.

CaptureFramerateNumerator

description: The numerator of the captured video, ie (30/1) will capture at 30 frames per second.

CodecName

type: FString

description: Optional codec to use for compression

CompressionQuality

type: TOptional< floa...

description: Optional compression quality, as a value between 0 and 1

OutputFilename

description: Output filename


code: [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) & operator= ( [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) && In )


code: FCapturedFrame ( double InStartTimeSeconds, double InEndTimeSeconds, uint32 InFrameIndex, [TArray](API\Runtime\Core\Containers\TArray)< [FColor](API\Runtime\Core\Math\FColor) > InFrameData )


code: FCapturedFrame ( [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) && In )


className: FCapturedFrame

description: Data structure representing a captured frame

code: struct FCapturedFrame

EndTimeSeconds

type: double

description: The End time of this frame

FrameData

type: TArray<FColor...

description: The frame data itself (empty for a dropped frame)

FrameIndex

description: The frame index of this frame in the stream

FrameProcessedEvent

type: FEvent*

description: Triggered when the frame has been processed

StartTimeSeconds

description: The start time of this frame


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

code: void Add ( [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) Frame )


description: Read frames from this container (potentially from a thread)

code: [TArray](API\Runtime\Core\Containers\TArray)< [FCapturedFrame](API\Runtime\AVIWriter\FCapturedFrame) > ReadFrames ( uint32 WaitTimeMs )


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

code: FCapturedFrames ( const [FString](API\Runtime\Core\Containers\FString) & InArchiveDirectory, int32 InMaxInMemoryFrames )


className: FCapturedFrames

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

code: struct FCapturedFrames