1. Epic GamesDeveloper
  3. FLocalFileNetworkReplayStreamer

FLocalFileNetworkReplayStreamer

Local file streamer that supports playback/recording to a single file on disk

API > API/Runtime > API/Runtime/LocalFileNetworkReplayStreaming

Inheritance Hierarchy

References

   
Module LocalFileNetworkReplayStreaming
Header /Engine/Source/Runtime/NetworkReplayStreaming/LocalFileNetworkReplayStreaming/Public/LocalFileNetworkReplayStreaming.h
Include #include "LocalFileNetworkReplayStreaming.h"

Syntax

class FLocalFileNetworkReplayStreamer :  
    public INetworkReplayStreamer,  
    public TSharedFromThis< FLocalFileNetworkReplayStreamer >

Remarks

Local file streamer that supports playback/recording to a single file on disk

Variables

  Type Name Description
Protected variable TSharedPtr< FQueuedLocalFileRequest, ESPMode::ThreadSafe > ActiveRequest  
Protected variable bool bCacheFileReadsInMemory  
Protected variable bool bStopStreamingCalled  
Protected variable FLocalFileStreamFArchive CheckpointAr Handle to the archive that will read/write checkpoint files
Protected variable FLocalFileReplayInfo CurrentReplayInfo Currently playing or recording replay metadata
Protected variable FString CurrentStreamName Remember the name of the current stream, if any.
Public variable TMap< int32, TSharedPtr< FCachedFileRequest > > DeltaCheckpointCache Map of checkpoint index to cached value
Protected variable FString DemoSavePath  
Protected variable TMap< FString, TArray< uint8 > > FileContentsCache  
Protected variable FLocalFileStreamFArchive HeaderAr Handle to the archive that will read/write the demo header
Protected variable uint32 HighPriorityEndTime  
Protected variable double LastChunkTime  
Protected variable int64 LastGotoTimeInMS  
Protected variable double LastRefreshTime  
Protected variable TArray< TSharedPtr< FQueuedLocalFileRequest, ESPMode::ThreadSafe > > QueuedRequests  
Public variable TMap< int32, TSharedPtr< FCachedFileRequest > > RequestCache Map of chunk index to cached value
Protected variable FLocalFileStreamFArchive StreamAr Handle to the archive that will read/write network packets
Protected variable int32 StreamChunkIndex  
Protected variable int64 StreamDataOffset  
Protected variable EReplayStreamerState StreamerState Overall state of the streamer
Protected variable TInterval< uint32 > StreamTimeRange  

Constructors

  Type Name Description
Public function    
Public function  

FLocalFileNetworkReplayStreamer ( const FString& InDemoSavePath
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddCachedFileRequestToQueue ( EQueuedLocalFileRequestType::Type RequestType,
int32 InCacheKey,
TFunction< void(TLocalFileRequestCommonData< DelegateResultType >&)>&& InFunction,
TFunction< void(TLocalFileRequestCommonData< DelegateResultType >&)>&& InCompletionCallback
)

  
Public function void

AddDelegateFileRequestToQueue ( EQueuedLocalFileRequestType::Type RequestType,
const DelegateType& Delegate,
TFunction< void(TLocalFileRequestCommonData< DelegateResultType >&)>&& InFunction
)

  
Public function void

AddDelegateFileRequestToQueue ( EQueuedLocalFileRequestType::Type RequestType,
TFunction< void(TLocalFileRequestCommonData< DelegateResultType >&)>&& InFunction,
TFunction< void(TLocalFileRequestCommonData< DelegateResultType >&)>&& InCompletionCallback
)

  
Public function Virtual void

AddEvent ( const uint32 TimeInMS,
const FString& Group,
const FString& Meta,
const TArray< uint8 >& Data
)

  
Public function void

AddGenericRequestToQueue ( EQueuedLocalFileRequestType::Type RequestType,
TFunction< void(StorageType&)>&& InFunction,
TFunction< void(StorageType&)>&& InCompletionCallback
)

  
Public function Virtual void

AddOrUpdateEvent ( const FString& Name,
const uint32 TimeInMS,
const FString& Group,
const FString& Meta,
const TArray< uint8 >& Data
)

  
Protected function void

AddRequestToCache ( int32 ChunkIndex,
const TArray< uint8 >& RequestData
)

  
Protected function void

AddRequestToCache ( int32 ChunkIndex,
TArray< uint8 >&& RequestData
)

  
Public function void

AddSimpleRequestToQueue ( EQueuedLocalFileRequestType::Type RequestType,
TFunction< void()>&& InFunction,
TFunction< void()>&& InCompletionCallback
)

  
Public function Virtual void

AddUserToReplay ( const FString& UserString
)

  
Public function Const bool  
Protected function void  
Public function Static bool

CleanUpOldReplays ( const FString& DemoPath,
TArrayView< const FString > AdditionalRelativeDemoPaths
)

  
Protected function void  
Public function Virtual Const bool

CompressBuffer ( const TArray< uint8 >& InBuffer,
TArray< uint8 >& OutCompressed
)

  
Protected function void  
Protected function void  
Protected function void  
Protected function Virtual Const TSharedPtr< FArchive >

CreateLocalFileReader ( const FString& InFilename
)

  
Protected function Virtual Const TSharedPtr< FArchive >

CreateLocalFileWriter ( const FString& InFilename
)

  
Protected function Virtual Const TSharedPtr< FArchive >

CreateLocalFileWriterForOverwrite ( const FString& InFilename
)

  
Public function Virtual Const bool

DecompressBuffer ( const TArray< uint8 >& InCompressed,
TArray< uint8 >& OutBuffer
)

  
Public function Virtual Const bool

DecryptBuffer ( TArrayView< const uint8 > Ciphertext,
TArray< uint8 >& Plaintext,
TArrayView< const uint8 > EncryptionKey
)

  
Public function Virtual void

DeleteFinishedStream ( const FString& StreamName,
const int32 UserIndex,
const FDeleteFinishedStreamCallback& Delegate
)

  
Public function Virtual void

DeleteFinishedStream ( const FString& StreamName,
const FDeleteFinishedStreamCallback& Delegate
)

  
Protected function void

DeleteFinishedStream_Internal ( const FString& StreamName,
const int32 UserIndex,
const FDeleteFinishedStreamCallback& Delegate
)

  
Public function Virtual void

DownloadHeader ( const FDownloadHeaderCallback& Delegate
)

  
Public function Virtual Const bool

EncryptBuffer ( TArrayView< const uint8 > Plaintext,
TArray< uint8 >& Ciphertext,
TArrayView< const uint8 > EncryptionKey
)

  
Public function Virtual void

EnumerateEvents ( const FString& ReplayName,
const FString& Group,
const int32 UserIndex,
const FEnumerateEventsCallback& Delegate
)

  
Public function Virtual void

EnumerateEvents ( const FString& ReplayName,
const FString& Group,
const FEnumerateEventsCallback& Delegate
)

  
Public function Virtual void

EnumerateEvents ( const FString& Group,
const FEnumerateEventsCallback& Delegate
)

  
Protected function void

EnumerateEvents_Internal ( const FString& ReplayName,
const FString& Group,
const int32 UserIndex,
const FEnumerateEventsCallback& Delegate
)

  
Public function Virtual void

EnumerateRecentStreams ( const FNetworkReplayVersion& ReplayVersion,
const int32 UserIndex,
const FEnumerateStreamsCallback& Delegate
)

  
Public function Virtual void

EnumerateStreams ( const FNetworkReplayVersion& InReplayVersion,
const int32 UserIndex,
const FString& MetaString,
const TArray< FString >& ExtraParms,
const FEnumerateStreamsCallback& Delegate
)

  
Protected function Const void

FixupFriendlyNameLength ( const FString& UnfixedName,
FString& FixedName
)

  
Public function Virtual void

FlushCheckpoint ( const uint32 TimeInMS
)

  
Protected function void

FlushCheckpointInternal ( const uint32 TimeInMS
)

  
Protected function void

FlushStream ( const uint32 TimeInMS
)

  
Public function Virtual void

GenerateEncryptionKey ( TArray< uint8 >& EncryptionKey
)

  
Protected function Virtual Const TArrayView< const FString > Must be relative to the base demo path.
Protected function Const FString Returns a name formatted as "demoX", where X is between 1 and MAX_DEMOS, inclusive.
Protected function Const const TArray< uint8 > &

GetCachedFileContents ( const FString& Filename
)

  
Public function Virtual FArchive *  
Protected function Virtual Const int32

GetDecompressedSizeBackCompat ( FArchive& InCompressed
)

  
Public function Static const FString &  
Public function Static bool

GetDemoFreeStorageSpace ( uint64& DiskFreeSpace,
const FString& DemoPath
)

  
Protected function Const FString

GetDemoFullFilename ( const FString& FileName
)

  
Public function Static FString

GetDemoFullFilename ( const FString& DemoPath,
const FString& FileName
)

  
Public function Virtual Const EStreamingOperationResult

GetDemoPath ( FString& DemoPath
)

  
Protected function Const FString  
Public function Virtual FArchive *  
Public function Virtual Const uint32  
Public function Virtual Const FString  
Public function Virtual Const EReplayStreamerState  
Public function Virtual FArchive *  
Public function Virtual Const uint32  
Public function Virtual void

GotoCheckpointIndex ( const int32 CheckpointIndex,
const FGotoCallback& Delegate,
EReplayCheckpointType CheckpointType
)

  
Public function Virtual void

GotoTimeInMS ( const uint32 TimeInMS,
const FGotoCallback& Delegate,
EReplayCheckpointType CheckpointType
)

  
Public function Const bool  
Public function Virtual Const bool

IsCheckpointTypeSupported ( EReplayCheckpointType CheckpointType
)

  
Public function Virtual Const bool  
Public function Virtual bool

IsDataAvailableForTimeRange ( const uint32 StartTimeInMS,
const uint32 EndTimeInMS
)

  
Protected function Const bool  
Protected function Const bool  
Public function Virtual Const bool

IsLive ()

  
Public function Virtual Const bool  
Protected function Const bool

IsNamedStreamLive ( const FString& StreamName
)

  
Public function Const bool  
Public function Virtual void

KeepReplay ( const FString& ReplayName,
const bool bKeep,
const FKeepReplayCallback& Delegate
)

  
Public function Virtual void

KeepReplay ( const FString& ReplayName,
const bool bKeep,
const int32 UserIndex,
const FKeepReplayCallback& Delegate
)

  
Protected function void

KeepReplay_Internal ( const FString& ReplayName,
const bool bKeep,
const int32 UserIndex,
const FKeepReplayCallback& Delegate
)

  
Public function void

OnFileRequestComplete ( const TSharedPtr< FQueuedLocalFileRequest, ESPMode::ThreadSafe >& Request
)

  
Protected function bool  
Protected function Const bool

ReadReplayInfo ( FArchive& Archive,
FLocalFileReplayInfo& OutReplayInfo,
FLocalFileSerializationInfo& SerializationInfo,
EReadReplayInfoFlags Flags
)

  
Protected function Const bool

ReadReplayInfo ( const FString& StreamName,
FLocalFileReplayInfo& OutReplayInfo,
EReadReplayInfoFlags Flags
)

  
Protected function Const bool

ReadReplayInfo ( const FString& StreamName,
FLocalFileReplayInfo& OutReplayInfo
)

  
Protected function Const bool

ReadReplayInfo ( FArchive& Archive,
FLocalFileReplayInfo& OutReplayInfo,
EReadReplayInfoFlags Flags
)

  
Public function Virtual void  
Public function Virtual void

RenameReplay ( const FString& ReplayName,
const FString& NewName,
const int32 UserIndex,
const FRenameReplayCallback& Delegate
)

  
Public function Virtual void

RenameReplay ( const FString& ReplayName,
const FString& NewName,
const FRenameReplayCallback& Delegate
)

  
Protected function void

RenameReplay_Internal ( const FString& ReplayName,
const FString& NewName,
const int32 UserIndex,
const FRenameReplayCallback& Delegate
)

  
Public function Virtual void

RenameReplayFriendlyName ( const FString& ReplayName,
const FString& NewFriendlyName,
const FRenameReplayCallback& Delegate
)

  
Public function Virtual void

RenameReplayFriendlyName ( const FString& ReplayName,
const FString& NewFriendlyName,
const int32 UserIndex,
const FRenameReplayCallback& Delegate
)

  
Protected function void

RenameReplayFriendlyName_Internal ( const FString& ReplayName,
const FString& NewFriendlyName,
const int32 UserIndex,
const FRenameReplayCallback& Delegate
)

  
Public function Virtual void

RequestEventData ( const FString& ReplayName,
const FString& EventID,
const FRequestEventDataCallback& Delegate
)

  
Public function Virtual void

RequestEventData ( const FString& EventID,
const FRequestEventDataCallback& Delegate
)

  
Public function Virtual void

RequestEventData ( const FString& ReplayName,
const FString& EventId,
const int32 UserIndex,
const FRequestEventDataCallback& Delegate
)

  
Protected function void

RequestEventData_Internal ( const FString& ReplayName,
const FString& EventId,
const int32 UserIndex,
const FRequestEventDataCallback& Delegate
)

  
Public function Virtual void

RequestEventGroupData ( const FString& ReplayName,
const FString& Group,
const int32 UserIndex,
const FRequestEventGroupDataCallback& Delegate
)

  
Public function Virtual void

RequestEventGroupData ( const FString& ReplayName,
const FString& Group,
const FRequestEventGroupDataCallback& Delegate
)

  
Public function Virtual void

RequestEventGroupData ( const FString& Group,
const FRequestEventGroupDataCallback& Delegate
)

  
Public function Virtual void

SearchEvents ( const FString& EventGroup,
const FSearchEventsCallback& Delegate
)

  
Public function Virtual EStreamingOperationResult

SetDemoPath ( const FString& DemoPath
)

  
Public function Virtual void

SetHighPriorityTimeRange ( const uint32 StartTimeInMS,
const uint32 EndTimeInMS
)

  
Protected function PRAGMA_DISABLE_DEPRECATION_WARNINGS void

SetLastError ( const ENetworkReplayError::Type InLastError
)

  
Protected function PRAGMA_ENABLE_DEPRECATION_WARNINGS void

SetLastError ( FLocalFileReplayResult&& Result
)

  
Public function Virtual void

SetTimeBufferHintSeconds ( const float InTimeBufferHintSeconds
)

  
Public function Virtual void

StartStreaming ( const FStartStreamingParameters& Params,
const FStartStreamingCallback& Delegate
)

 INetworkReplayStreamer implementation
Public function Virtual void  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function void

Tick ( float DeltaSeconds
)

  
Protected function void  
Public function Virtual void

UpdatePlaybackTime ( uint32 TimeInMS
)

  
Public function Virtual void

UpdateTotalDemoTime ( uint32 TimeInMS
)

  
Protected function void  
Protected function bool

WriteReplayInfo ( const FString& StreamName,
const FLocalFileReplayInfo& ReplayInfo
)

  
Protected function bool

WriteReplayInfo ( FArchive& Archive,
const FLocalFileReplayInfo& ReplayInfo
)

  
Protected function bool

WriteReplayInfo ( FArchive& Archive,
const FLocalFileReplayInfo& InReplayInfo,
FLocalFileSerializationInfo& SerializationInfo
)

  

Classes

  Type Name Description
Protected struct FLocalFileSerializationInfo    

Typedefs

Name Description
FLocalFileReplayResult  

Constants

Name Description
FileMagic  
LatestVersion  
MaxFriendlyNameLen  
OnReplayFinishedWriting  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page