ue5-api-AVIWriter.jsonl

{"className": "FAVIWriter::CreateInstance", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "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 )", "variables": []}
{"className": "FAVIWriter::DropFrames", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "void DropFrames ( int32 NumFramesToDrop )", "variables": []}
{"className": "FAVIWriter::Finalize", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "void Finalize()", "variables": []}
{"className": "FAVIWriter::GetFrameData", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Access captured frame data. Safe to be called from any thread.", "module": "AVIWriter", "code": "[TArray](API\\Runtime\\Core\\Containers\\TArray)< [FCapturedFrame](API\\Runtime\\AVIWriter\\FCapturedFrame) > GetFrameData ( uint32 WaitTimeMs ) const", "variables": []}
{"className": "FAVIWriter::GetFrameNumber", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "int32 GetFrameNumber() const", "variables": []}
{"className": "FAVIWriter::GetHeight", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "uint32 GetHeight() const", "variables": []}
{"className": "FAVIWriter::GetNumOutstandingFrames", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Retrieve the number of oustanding frames we have not processed yet", "module": "AVIWriter", "code": "int32 GetNumOutstandingFrames() const", "variables": []}
{"className": "FAVIWriter::GetWidth", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "uint32 GetWidth() const", "variables": []}
{"className": "FAVIWriter::Initialize", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "void Initialize()", "variables": []}
{"className": "FAVIWriter::IsCapturing", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "bool IsCapturing() const", "variables": []}
{"className": "FAVIWriter::Update", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "void Update ( double FrameTimeSeconds, [TArray](API\\Runtime\\Core\\Containers\\TArray)< [FColor](API\\Runtime\\Core\\Math\\FColor) > FrameData )", "variables": []}
{"className": "FAVIWriter::FAVIWriter", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Protected constructor to avoid abuse.", "module": "AVIWriter", "code": "FAVIWriter ( const [FAVIWriterOptions](API\\Runtime\\AVIWriter\\FAVIWriterOptions) & InOptions )", "variables": []}
{"className": "FAVIWriter::~FAVIWriter", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Public destruction", "module": "AVIWriter", "code": "virtual ~FAVIWriter()", "variables": []}
{"className": "FAVIWriter", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Class responsible for writing frames out to an AVI file", "module": "AVIWriter", "code": "class FAVIWriter", "variables": [{"type": "FThreadSafeBool", "name": "bCapturing", "description": "Whether we are capturing or not"}, {"type": "TUniquePtr<FCa...", "name": "CapturedFrames", "description": "Container that manages frames that we have already captured"}, {"type": "int32", "name": "FrameNumber", "description": "The current frame number"}, {"type": "FAVIWriterOptio...", "name": "Options", "description": "Creation options"}]}
{"className": "FAVIWriterOptions::FAVIWriterOptions", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "FAVIWriterOptions()", "variables": []}
{"className": "FAVIWriterOptions", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Creation options for the AVI writer", "module": "AVIWriter", "code": "struct FAVIWriterOptions", "variables": [{"type": "bool", "name": "bSynchronizeFrames", "description": "When true, the game thread will block until captured frames have been processed by the avi writer"}, {"type": "int32", "name": "CaptureFramerateDenominator", "description": "The denominator of the captured video, ie (30/1) will capture at 30 frames per second."}, {"type": "int32", "name": "CaptureFramerateNumerator", "description": "The numerator of the captured video, ie (30/1) will capture at 30 frames per second."}, {"type": "FString", "name": "CodecName", "description": "Optional codec to use for compression"}, {"type": "TOptional< floa...", "name": "CompressionQuality", "description": "Optional compression quality, as a value between 0 and 1"}, {"type": "uint32", "name": "Height", "description": ""}, {"type": "FString", "name": "OutputFilename", "description": "Output filename"}, {"type": "uint32", "name": "Width", "description": ""}]}
{"className": "FCapturedFrame::operator=", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "[FCapturedFrame](API\\Runtime\\AVIWriter\\FCapturedFrame) & operator= ( [FCapturedFrame](API\\Runtime\\AVIWriter\\FCapturedFrame) && In )", "variables": []}
{"className": "FCapturedFrame::FCapturedFrame", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "FCapturedFrame()", "variables": []}
{"className": "FCapturedFrame::FCapturedFrame", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "FCapturedFrame ( double InStartTimeSeconds, double InEndTimeSeconds, uint32 InFrameIndex, [TArray](API\\Runtime\\Core\\Containers\\TArray)< [FColor](API\\Runtime\\Core\\Math\\FColor) > InFrameData )", "variables": []}
{"className": "FCapturedFrame::FCapturedFrame", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "FCapturedFrame ( [FCapturedFrame](API\\Runtime\\AVIWriter\\FCapturedFrame) && In )", "variables": []}
{"className": "FCapturedFrame::~FCapturedFrame", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "~FCapturedFrame()", "variables": []}
{"className": "FCapturedFrame", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Data structure representing a captured frame", "module": "AVIWriter", "code": "struct FCapturedFrame", "variables": [{"type": "double", "name": "EndTimeSeconds", "description": "The End time of this frame"}, {"type": "TArray<FColor...", "name": "FrameData", "description": "The frame data itself (empty for a dropped frame)"}, {"type": "uint32", "name": "FrameIndex", "description": "The frame index of this frame in the stream"}, {"type": "FEvent*", "name": "FrameProcessedEvent", "description": "Triggered when the frame has been processed"}, {"type": "double", "name": "StartTimeSeconds", "description": "The start time of this frame"}]}
{"className": "FCapturedFrames::Add", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Add a captured frame to this container. Only to be called from the owner tasread.", "module": "AVIWriter", "code": "void Add ( [FCapturedFrame](API\\Runtime\\AVIWriter\\FCapturedFrame) Frame )", "variables": []}
{"className": "FCapturedFrames::GetNumOutstandingFrames", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Retrieve the number of oustanding frames we have not processed yet", "module": "AVIWriter", "code": "int32 GetNumOutstandingFrames() const", "variables": []}
{"className": "FCapturedFrames::ReadFrames", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Read frames from this container (potentially from a thread)", "module": "AVIWriter", "code": "[TArray](API\\Runtime\\Core\\Containers\\TArray)< [FCapturedFrame](API\\Runtime\\AVIWriter\\FCapturedFrame) > ReadFrames ( uint32 WaitTimeMs )", "variables": []}
{"className": "FCapturedFrames::FCapturedFrames", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Construct from a directory to place archives in, and a maximum number of frames we can hold in", "module": "AVIWriter", "code": "FCapturedFrames ( const [FString](API\\Runtime\\Core\\Containers\\FString) & InArchiveDirectory, int32 InMaxInMemoryFrames )", "variables": []}
{"className": "FCapturedFrames::~FCapturedFrames", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "", "module": "AVIWriter", "code": "~FCapturedFrames()", "variables": []}
{"className": "FCapturedFrames", "headerPath": "/Engine/Source/Runtime/AVIWriter/Public/AVIWriter.h", "description": "Container for managing captured frames. Temporarily archives frames to the file system when capture rate drops.", "module": "AVIWriter", "code": "struct FCapturedFrames", "variables": []}