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

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

   
Name TMovieSceneSerializer
Type class
Header File /Engine/Source/Editor/SerializedRecorderInterface/Public/Serializers/MovieSceneSectionSerialization.h
Include Path #include "Serializers/MovieSceneSectionSerialization.h"

Syntax

template<typename HeaderData, typename FrameData>  
class TMovieSceneSerializer

Constructors

Name Remarks Include Path Unreal Specifiers

TMovieSceneSerializer()

   Serializers/MovieSceneSectionSerialization.h  

Constants

Name Type Remarks Include Path
Runnable FMovieSceneSerializerRunnable< HeaderData, FrameData > * Runnable that the thread runs Serializers/MovieSceneSectionSerialization.h
Thread FRunnableThread * Thread we run on Serializers/MovieSceneSectionSerialization.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
FramesWritten int How many frames have been written Serializers/MovieSceneSectionSerialization.h  
ResultData TArray< TMovieSceneSerializedFrame< FrameData > > Data from a read. Serializers/MovieSceneSectionSerialization.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Guid FGuid Unique guid for this serializer Serializers/MovieSceneSectionSerialization.h  
LocalCaptureDir FString Local Directory Serializers/MovieSceneSectionSerialization.h  
SessionInfos TArray< FMovieSceneSessionInfo > The session infos Serializers/MovieSceneSectionSerialization.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Close()

 Close the serializer, flushes any commands and shuts down threads Serializers/MovieSceneSectionSerialization.h  

bool DoesFileExist ( const FString& InFileName
)

 Get whether file exists Serializers/MovieSceneSectionSerialization.h  

FString GetBuildDate ( int32 InSessionIndex
) const

 Get the build date for the capture. Serializers/MovieSceneSectionSerialization.h  

int32 GetBuildVersion ( int32 InSessionIndex
) const

 Get the engine version the file was captured with. Serializers/MovieSceneSectionSerialization.h  

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

 Query the range of data in the file. Completion callback will be called on the game thread. Serializers/MovieSceneSectionSerialization.h  

FString GetDeviceName ( int32 InSessionIndex
) const

 Get the name of the device the file was captured on. Serializers/MovieSceneSectionSerialization.h  

FString GetInstanceName ( int32 InSessionIndex
) const

 Get the name of the engine instance the file was captured on. Serializers/MovieSceneSectionSerialization.h  

FString GetLocalCaptureDir()

 Get the local capture directory Serializers/MovieSceneSectionSerialization.h  

int32 GetNumSessions()

 Get the number of sessions that were captured to this file Serializers/MovieSceneSectionSerialization.h  

FString GetPlatformName ( int32 InSessionIndex
) const

 Get the name of the platform the file was captured on. Serializers/MovieSceneSectionSerialization.h  

FGuid GetSessionId ( int32 InSessionIndex
) const

 Get the engine version the file was captured with. Serializers/MovieSceneSectionSerialization.h  

bool IsOpen()

 Check whether this serializer is currently open Serializers/MovieSceneSectionSerialization.h  

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

 Open the serializer for reading Serializers/MovieSceneSectionSerialization.h  

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

 Open the serializer for writing Serializers/MovieSceneSectionSerialization.h  

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

 Read a frame range. Completion callback will be called on the game thread. Serializers/MovieSceneSectionSerialization.h  
== Template Statics Defined    
     
     

SERIALIZEDRECORDERINTERFACE_API FMovieSceneSerializerRunnable< FSpawnFileHeader, FSpawnProperty > * Runnable ()

      
External Tempplate statics. Need to define here due to linkage issues    

SERIALIZEDRECORDERINTERFACE_API FMovieSceneSerializerRunnable< FActorFileHeader, FActorProperty > * Runnable ()

      
     

void SetLocalCaptureDir ( const FString& PathIn
)

 Set the local capture directory Serializers/MovieSceneSectionSerialization.h  

SERIALIZEDRECORDERINTERFACE_API FRunnableThread * Thread ()

      

SERIALIZEDRECORDERINTERFACE_API FRunnableThread * Thread ()

      

SERIALIZEDRECORDERINTERFACE_API FRunnableThread * Thread ()

      

SERIALIZEDRECORDERINTERFACE_API FRunnableThread * Thread ()

      

SERIALIZEDRECORDERINTERFACE_API FRunnableThread * Thread ()

      

SERIALIZEDRECORDERINTERFACE_API FRunnableThread * Thread ()

      

SERIALIZEDRECORDERINTERFACE_API FRunnableThread * Thread ()

      

void WriteFrameData ( uint64 InFrameId,
const FrameData& InFrame
)

 Write one frame data out to disk Serializers/MovieSceneSectionSerialization.h  

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

 Write array of frame data out to disk Serializers/MovieSceneSectionSerialization.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page