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

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

   
Name FLocalFileNetworkReplayStreamer
Type class
Header File /Engine/Source/Runtime/NetworkReplayStreaming/LocalFileNetworkReplayStreaming/Public/LocalFileNetworkReplayStreaming.h
Include Path #include "LocalFileNetworkReplayStreaming.h"

Syntax

class FLocalFileNetworkReplayStreamer :  
    public INetworkReplayStreamer,  
    public TSharedFromThis< FLocalFileNetworkReplayStreamer >

Inheritance Hierarchy

  • TSharedFromThis< FLocalFileNetworkReplayStreamer > → FLocalFileNetworkReplayStreamer

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  LocalFileNetworkReplayStreaming.h  

FLocalFileNetworkReplayStreamer ( const FString& InDemoSavePath
)

   LocalFileNetworkReplayStreaming.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FLocalFileNetworkReplayStreamer()

   LocalFileNetworkReplayStreaming.h  

Structs

Name Remarks
FLocalFileSerializationInfo  

Typedefs

Name Type Remarks Include Path
FLocalFileReplayResult UE::Net::TNetResult< ELocalFileReplayResult >   LocalFileNetworkReplayStreaming.h

Constants

Name Type Remarks Include Path
FileMagic const uint32   LocalFileNetworkReplayStreaming.h
LatestVersion const uint32   LocalFileNetworkReplayStreaming.h
MaxFriendlyNameLen const uint32   LocalFileNetworkReplayStreaming.h
OnReplayFinishedWriting FOnLocalFileReplayFinishedWriting   LocalFileNetworkReplayStreaming.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DeltaCheckpointCache TMap< int32, TSharedPtr< FCachedFileRequest > > Map of checkpoint index to cached value LocalFileNetworkReplayStreaming.h  
RequestCache TMap< int32, TSharedPtr< FCachedFileRequest > > Map of chunk index to cached value LocalFileNetworkReplayStreaming.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
TaskReplayInfo FLocalFileReplayInfo Manipulated by queued replay tasks, likely from another thread LocalFileNetworkReplayStreaming.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

virtual void AddUserToReplay ( const FString& UserString
)

   LocalFileNetworkReplayStreaming.h  

bool AllowEncryptedWrite()

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

virtual void DownloadHeader ( const FDownloadHeaderCallback& Delegate
)

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

virtual void FlushCheckpoint ( const uint32 TimeInMS
)

   LocalFileNetworkReplayStreaming.h  

virtual void GenerateEncryptionKey ( TArray< uint8 >& EncryptionKey
)

   LocalFileNetworkReplayStreaming.h  

virtual FArchive * GetCheckpointArchive()

   LocalFileNetworkReplayStreaming.h  

virtual EStreamingOperationResult GetDemoPath ( FString& DemoPath
) const

   LocalFileNetworkReplayStreaming.h  

virtual FArchive * GetHeaderArchive()

   LocalFileNetworkReplayStreaming.h  

virtual uint32 GetMaxFriendlyNameSize()

   LocalFileNetworkReplayStreaming.h  

virtual FString GetReplayID()

   LocalFileNetworkReplayStreaming.h  

virtual EReplayStreamerState GetReplayStreamerState()

   LocalFileNetworkReplayStreaming.h  

virtual FArchive * GetStreamingArchive()

   LocalFileNetworkReplayStreaming.h  

virtual uint32 GetTotalDemoTime()

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

bool HasPendingFileRequests()

   LocalFileNetworkReplayStreaming.h  

virtual bool IsCheckpointTypeSupported ( EReplayCheckpointType CheckpointType
) const

   LocalFileNetworkReplayStreaming.h  

virtual bool IsDataAvailable()

   LocalFileNetworkReplayStreaming.h  

virtual bool IsDataAvailableForTimeRange ( const uint32 StartTimeInMS,
const uint32 EndTimeInMS
)

   LocalFileNetworkReplayStreaming.h  

virtual bool IsLive()

   LocalFileNetworkReplayStreaming.h  

virtual bool IsLoadingCheckpoint()

   LocalFileNetworkReplayStreaming.h  

bool IsStreaming()

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

virtual void RefreshHeader()

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

virtual EStreamingOperationResult SetDemoPath ( const FString& DemoPath
)

   LocalFileNetworkReplayStreaming.h  

virtual void SetHighPriorityTimeRange ( const uint32 StartTimeInMS,
const uint32 EndTimeInMS
)

   LocalFileNetworkReplayStreaming.h  

virtual void SetTimeBufferHintSeconds ( const float InTimeBufferHintSeconds
)

   LocalFileNetworkReplayStreaming.h  

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

 INetworkReplayStreamer implementation LocalFileNetworkReplayStreaming.h  

virtual void StopStreaming()

   LocalFileNetworkReplayStreaming.h  

virtual bool SupportsCompression()

   LocalFileNetworkReplayStreaming.h  

virtual bool SupportsEncryption()

   LocalFileNetworkReplayStreaming.h  

void Tick ( float DeltaSeconds
)

   LocalFileNetworkReplayStreaming.h  

virtual void UpdatePlaybackTime ( uint32 TimeInMS
)

   LocalFileNetworkReplayStreaming.h  

virtual void UpdateTotalDemoTime ( uint32 TimeInMS
)

   LocalFileNetworkReplayStreaming.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

void CancelStreamingRequests()

   LocalFileNetworkReplayStreaming.h  

void CleanupRequestCache()

   LocalFileNetworkReplayStreaming.h  

void ConditionallyFlushStream()

   LocalFileNetworkReplayStreaming.h  

void ConditionallyLoadNextChunk()

   LocalFileNetworkReplayStreaming.h  

void ConditionallyRefreshReplayInfo()

   LocalFileNetworkReplayStreaming.h  

virtual TSharedPtr< FArchive > CreateLocalFileReader ( const FString& InFilename
) const

   LocalFileNetworkReplayStreaming.h  

virtual TSharedPtr< FArchive > CreateLocalFileWriter ( const FString& InFilename
) const

   LocalFileNetworkReplayStreaming.h  

virtual TSharedPtr< FArchive > CreateLocalFileWriterForOverwrite ( const FString& InFilename
) const

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

void FixupFriendlyNameLength ( const FString& UnfixedName,
FString& FixedName
) const

   LocalFileNetworkReplayStreaming.h  

void FlushCheckpointInternal ( const uint32 TimeInMS
)

   LocalFileNetworkReplayStreaming.h  

void FlushStream ( const uint32 TimeInMS
)

   LocalFileNetworkReplayStreaming.h  

virtual TArrayView< const FString > GetAdditionalRelativeDemoPaths()

 Must be relative to the base demo path. LocalFileNetworkReplayStreaming.h  
Returns a name formatted as "demoX", where X is between 1 and MAX_DEMOS, inclusive. LocalFileNetworkReplayStreaming.h  

const TArray< uint8 > & GetCachedFileContents ( const FString& Filename
) const

   LocalFileNetworkReplayStreaming.h  

virtual int32 GetDecompressedSizeBackCompat ( FArchive& InCompressed
) const

   LocalFileNetworkReplayStreaming.h  

FString GetDemoFullFilename ( const FString& FileName
) const

   LocalFileNetworkReplayStreaming.h  

FString GetDemoPath ()

   LocalFileNetworkReplayStreaming.h  

bool IsFileRequestInProgress()

   LocalFileNetworkReplayStreaming.h  

bool IsFileRequestPendingOrInProgress ( const EQueuedLocalFileRequestType::Type RequestType
) const

   LocalFileNetworkReplayStreaming.h  

bool IsNamedStreamLive ( const FString& StreamName
) const

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

bool ProcessNextFileRequest()

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

bool ReadReplayInfo ( const FString& StreamName,
FLocalFileReplayInfo& OutReplayInfo
) const

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS void SetLastError ( const ENetworkReplayError::Type InLastError
)

   LocalFileNetworkReplayStreaming.h  

PRAGMA_ENABLE_DEPRECATION_WARNINGS void SetLastError ( FLocalFileReplayResult&& Result
)

   LocalFileNetworkReplayStreaming.h  

void UpdateCurrentReplayInfo ( FLocalFileReplayInfo& ReplayInfo,
EUpdateReplayInfoFlags UpdateFlags
)

   LocalFileNetworkReplayStreaming.h  

void WriteHeader()

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

bool WriteReplayInfo ( FArchive& Archive,
const FLocalFileReplayInfo& ReplayInfo
)

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   LocalFileNetworkReplayStreaming.h  

static const FString & GetDefaultDemoSavePath()

   LocalFileNetworkReplayStreaming.h  

static bool GetDemoFreeStorageSpace ( uint64& DiskFreeSpace,
const FString& DemoPath
)

   LocalFileNetworkReplayStreaming.h  

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

   LocalFileNetworkReplayStreaming.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page