1. Epic GamesDeveloper
  3. TMovieSceneSerializer

TMovieSceneSerializer

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

API > API/Editor > API/Editor/SerializedRecorderInterface > API/Editor/SerializedRecorderInterface/Serializers

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

  Type Name Description
Public variable int FramesWritten How many frames have been written
Public variable TArray< TMovieSceneSerializedFrame< FrameData > > ResultData Data from a read.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

Close ()

 Close the serializer, flushes any commands and shuts down threads
Public function bool

DoesFileExist ( const FString& InFileName
)

 Get whether file exists
Public function Const FString

GetBuildDate ( int32 InSessionIndex
)

 Get the build date for the capture.
Public function Const int32

GetBuildVersion ( int32 InSessionIndex
)

 Get the engine version the file was captured with.
Public function void

GetDataRanges ( TFunction< void(uint64, uint64)> InCompletionCallback
)

 Query the range of data in the file. Completion callback will be called on the game thread.
Public function Const FString

GetDeviceName ( int32 InSessionIndex
)

 Get the name of the device the file was captured on.
Public function Const FString

GetInstanceName ( int32 InSessionIndex
)

 Get the name of the engine instance the file was captured on.
Public function FString Get the local capture directory
Public function int32 Get the number of sessions that were captured to this file
Public function Const FString

GetPlatformName ( int32 InSessionIndex
)

 Get the name of the platform the file was captured on.
Public function Const FGuid

GetSessionId ( int32 InSessionIndex
)

 Get the engine version the file was captured with.
Public function Const bool

IsOpen ()

 Check whether this serializer is currently open
Public function bool

OpenForRead ( const FString& InFileName,
HeaderData& OutHeader,
FText& OutFailReason
)

 Open the serializer for reading
Public function bool

OpenForWrite ( const FString& InFilename,
HeaderData& Header,
FText& OutFailReason
)

 Open the serializer for writing
Public function void

ReadFramesAtFrameRange ( uint64 InStartFrameId,
uint64 InEndFrameId,
TFunction< void()> InCompletionCallback
)

 Read a frame range. Completion callback will be called on the game thread.
Public function SERIALIZEDRECORDERINTERFACE_API FMovieSceneSerializerRunnable< FPropertyFileHeader, FPropertyFileHea... == Template Statics Defined
Public function SERIALIZEDRECORDERINTERFACE_API FMovieSceneSerializerRunnable< FTransformFileHeader, FSerializedTran...  
Public function SERIALIZEDRECORDERINTERFACE_API FMovieSceneSerializerRunnable< FAnimationFileHeader, FSerializedAnim...  
Public function SERIALIZEDRECORDERINTERFACE_API FMovieSceneSerializerRunnable< FSpawnFileHeader, FSpawnProperty > &#...  
Public function SERIALIZEDRECORDERINTERFACE_API FMovieSceneSerializerRunnable< FManifestFileHeader, FManifestPropert... External Tempplate statics. Need to define here due to linkage issues
Public function SERIALIZEDRECORDERINTERFACE_API FMovieSceneSerializerRunnable< FActorFileHeader, FActorProperty > &#...  
Public function SERIALIZEDRECORDERINTERFACE_API FMovieSceneSerializerRunnable< FSerializedTypeFileHeader, FSerialize...  
Public function void

SetLocalCaptureDir ( const FString& PathIn
)

 Set the local capture directory
Public function SERIALIZEDRECORDERINTERFACE_API FRunnableThread *

Thread ()

  
Public function SERIALIZEDRECORDERINTERFACE_API FRunnableThread *

Thread ()

  
Public function SERIALIZEDRECORDERINTERFACE_API FRunnableThread *

Thread ()

  
Public function SERIALIZEDRECORDERINTERFACE_API FRunnableThread *

Thread ()

  
Public function SERIALIZEDRECORDERINTERFACE_API FRunnableThread *

Thread ()

  
Public function SERIALIZEDRECORDERINTERFACE_API FRunnableThread *

Thread ()

  
Public function SERIALIZEDRECORDERINTERFACE_API FRunnableThread *

Thread ()

  
Public function void

WriteFrameData ( uint64 InFrameId,
const FrameData& InFrame
)

 Write one frame data out to disk
Public function void

WriteFrameData ( uint64 InFrameId,
const TArray< FrameData >& InFrames
)

 Write array of frame data out to disk

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page