Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > SerializedRecorderInterface > Serializers > TMovieSceneSerializer

Light Theme

Dark Theme

TMovieSceneSerializer

A class to asynchronously read and write to serialized frame debugger data files

Windows

MacOS

Linux

References

Module	SerializedRecorderInterface
Header	/Engine/Source/Editor/SerializedRecorderInterface/Public/Serializers/MovieSceneSectionSerialization.h
Include	#include "Serializers/MovieSceneSectionSerialization.h"

Syntax

template<typename HeaderData, typename FrameData>
class TMovieSceneSerializer

Remarks

A class to asynchronously read and write to serialized frame debugger data files

Variables

		Name	Description
	int	FramesWritten	How many frames have been written
	TArray< TMovieS...	ResultData	Data from a read.

Constructors

	Name	Description
	TMovieSceneSerializer()

Functions

	Name	Description
void	Close()	Close the serializer, flushes any commands and shuts down threads
bool	DoesFileExist ( const FString& InFileName )	Get whether file exists
FString	GetBuildDate ( int32 InSessionIndex )	Get the build date for the capture.
int32	GetBuildVersion ( int32 InSessionIndex )	Get the engine version the file was captured with.
void	GetDataRanges ( TFunction< void, uint64)> In... )	Query the range of data in the file. Completion callback will be called on the game thread.
FString	GetDeviceName ( int32 InSessionIndex )	Get the name of the device the file was captured on.
FString	GetInstanceName ( int32 InSessionIndex )	Get the name of the engine instance the file was captured on.
FString	GetLocalCaptureDir()	Get the local capture directory
int32	GetNumSessions()	Get the number of sessions that were captured to this file
FString	GetPlatformName ( int32 InSessionIndex )	Get the name of the platform the file was captured on.
FGuid	GetSessionId ( int32 InSessionIndex )	Get the engine version the file was captured with.
bool	IsOpen()	Check whether this serializer is currently open
bool	OpenForRead ( const FString& InFileName, HeaderData& OutHeader, FText& OutFailReason )	Open the serializer for reading
bool	OpenForWrite ( const FString& InFilename, HeaderData& Header, FText& OutFailReason )	Open the serializer for writing
void	ReadFramesAtFrameRange ( uint64 InStartFrameId, uint64 InEndFrameId, TFunction< void()> InCompletionCall... )	Read a frame range. Completion callback will be called on the game thread.
SERIALIZEDRE...	Runnable()
SERIALIZEDRE...	Runnable()
SERIALIZEDRE...	Runnable()
SERIALIZEDRE...	Runnable()
SERIALIZEDRE...	Runnable()
SERIALIZEDRE...	Runnable()
SERIALIZEDRE...	Runnable()
SERIALIZEDRE...	Runnable()
SERIALIZEDRE...	Runnable()	== Template Statics Defined
SERIALIZEDRE...	Runnable()
void	SetLocalCaptureDir ( const FString& PathIn )	Set the local capture directory
SERIALIZEDRE...	Thread()
SERIALIZEDRE...	Thread()
SERIALIZEDRE...	Thread()
SERIALIZEDRE...	Thread()
SERIALIZEDRE...	Thread()
SERIALIZEDRE...	Thread()
SERIALIZEDRE...	Thread()
SERIALIZEDRE...	Thread()
SERIALIZEDRE...	Thread()
SERIALIZEDRE...	Thread()
void	WriteFrameData ( uint64 InFrameId, const FrameData& InFrame )	Write one frame data out to disk
void	WriteFrameData ( uint64 InFrameId, const TArray< FrameData >& InFrame... )	Write array of frame data out to disk

Constants

Name	Description
Runnable	Runnable that the thread runs
Thread	Thread we run on

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss