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 > Runtime > LocalFileNetworkReplayStreaming > FLocalFileNetworkReplayStreamer

Light Theme

Dark Theme

FLocalFileNetworkReplayStreamer

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

Windows

MacOS

Linux

Inheritance Hierarchy

INetworkReplayStreamer

TSharedFromThis

FLocalFileNetworkReplayStreamer

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

	Name	Description
TSharedPtr< FQu...	ActiveRequest
bool	bCacheFileReadsInMemory
bool	bStopStreamingCalled
FLocalFileStrea...	CheckpointAr	Handle to the archive that will read/write checkpoint files
FLocalFileRepla...	CurrentReplayInfo	Currently playing or recording replay metadata
FString	CurrentStreamName	Remember the name of the current stream, if any.
TMap< int32, TS...	DeltaCheckpointCache	Map of checkpoint index to cached value
FString	DemoSavePath
TMap< FString, ...	FileContentsCache
FLocalFileStrea...	HeaderAr	Handle to the archive that will read/write the demo header
uint32	HighPriorityEndTime
double	LastChunkTime
int64	LastGotoTimeInMS
double	LastRefreshTime
TArray< TShared...	QueuedRequests
TMap< int32, TS...	RequestCache	Map of chunk index to cached value
FLocalFileStrea...	StreamAr	Handle to the archive that will read/write network packets
int32	StreamChunkIndex
int64	StreamDataOffset
ENetworkReplayE...	StreamerLastError
EStreamerState	StreamerState	Overall state of the streamer
TInterval< uint...	StreamTimeRange

Constructors

	Name	Description
	FLocalFileNetworkReplayStreamer()
	FLocalFileNetworkReplayStreamer ( const FString& InDemoSavePath )

Destructors

	Name	Description
	~FLocalFileNetworkReplayStreamer()

Functions

	Name	Description
void	AddCachedFileRequestToQueue ( EQueuedLocalFileRequestType::Type R..., int32 InCacheKey, TFunction< void..., TFunction< void... )
void	AddDelegateFileRequestToQueue ( EQueuedLocalFileRequestType::Type R..., const DelegateType& Delegate, TFunction< void... )
void	AddDelegateFileRequestToQueue ( EQueuedLocalFileRequestType::Type R..., TFunction< void..., TFunction< void... )
void	AddGenericRequestToQueue ( EQueuedLocalFileRequestType::Type R..., TFunction< void>&& ..., TFunction< void>&& ... )
void	AddRequestToCache ( int32 ChunkIndex, const TArray< uint8 >& RequestData )
void	AddSimpleRequestToQueue ( EQueuedLocalFileRequestType::Type R..., TFunction< void()>&& InFunction, TFunction< void()>&& InCompletionC... )
bool	AllowEncryptedWrite()
void	CancelStreamingRequests()
void	CleanupRequestCache()
bool	CompressBuffer ( const TArray< uint8 >& InBuffer, TArray< uint8 >& OutCompressed )
void	ConditionallyFlushStream()
void	ConditionallyLoadNextChunk()
void	ConditionallyRefreshReplayInfo()
TSharedPtr< ...	CreateLocalFileReader ( const FString& InFilename )
TSharedPtr< ...	CreateLocalFileWriter ( const FString& InFilename )
TSharedPtr< ...	CreateLocalFileWriterForOverwrite ( const FString& InFilename )
bool	DecompressBuffer ( const TArray< uint8 >& InCompresse..., TArray< uint8 >& OutBuffer )
bool	DecryptBuffer ( TArrayView< const uint8 > Ciphertex..., TArray< uint8 >& Plaintext, TArrayView< const uint8 > Encryptio... )
void	DeleteFinishedStream_Internal ( const FString& StreamName, const int32 UserIndex, const FDeleteFinishedStreamCallback... )
bool	EncryptBuffer ( TArrayView< const uint8 > Plaintext, TArray< uint8 >& Ciphertext, TArrayView< const uint8 > Encryptio... )
void	EnumerateEvents_Internal ( const FString& ReplayName, const FString& Group, const int32 UserIndex, const FEnumerateEventsCallback& De... )
void	FixupFriendlyNameLength ( const FString& UnfixedName, FString& FixedName )
void	FlushCheckpointInternal ( const uint32 TimeInMS )
void	FlushStream ( const uint32 TimeInMS )
void	GenerateEncryptionKey ( TArray< uint8 >& EncryptionKey )
FString	GetAutomaticDemoName()	Returns a name formatted as "demoX", where X is between 1 and MAX_DEMOS, inclusive.
const TArray...	GetCachedFileContents ( const FString& Filename )
const FStrin...	GetDefaultDemoSavePath()
FString	GetDemoFullFilename ( const FString& FileName )
FString	GetDemoPath()
bool	HasPendingFileRequests()
bool	IsFileRequestInProgress()
bool	IsFileRequestPendingOrInProgress ( const EQueuedLocalFileRequestType::... )
bool	IsNamedStreamLive ( const FString& StreamName )
bool	IsStreaming()
void	KeepReplay_Internal ( const FString& ReplayName, const bool bKeep, const int32 UserIndex, const FKeepReplayCallback& Delegat... )
void	OnFileRequestComplete ( const TSharedPtr< FQueuedLocalFileR... )
bool	ProcessNextFileRequest()
bool	ReadReplayInfo ( FArchive& Archive, FLocalFileReplayInfo& OutReplayInf..., EReadReplayInfoFlags Flags )
bool	ReadReplayInfo ( FArchive& Archive, FLocalFileReplayInfo& OutReplayInf..., FLocalFileSerializationInfo& Seria..., EReadReplayInfoFlags Flags )
bool	ReadReplayInfo ( const FString& StreamName, FLocalFileReplayInfo& OutReplayInf... )
bool	ReadReplayInfo ( const FString& StreamName, FLocalFileReplayInfo& OutReplayInf..., EReadReplayInfoFlags Flags )
void	RenameReplay_Internal ( const FString& ReplayName, const FString& NewName, const int32 UserIndex, const FRenameReplayCallback& Deleg... )
void	RenameReplayFriendlyName_Internal ( const FString& ReplayName, const FString& NewFriendlyName, const int32 UserIndex, const FRenameReplayCallback& Deleg... )
void	RequestEventData_Internal ( const FString& ReplayName, const FString& EventId, const int32 UserIndex, const FRequestEventDataCallback& D... )
void	SetLastError ( const ENetworkReplayError::Type InL... )
bool	SupportsCompression()
bool	SupportsEncryption()
void	Tick ( float DeltaSeconds )
void	UpdateCurrentReplayInfo ( FLocalFileReplayInfo& ReplayInfo )
void	WriteHeader()
bool	WriteReplayInfo ( FArchive& Archive, const FLocalFileReplayInfo& Replay... )
bool	WriteReplayInfo ( const FString& StreamName, const FLocalFileReplayInfo& Replay... )
bool	WriteReplayInfo ( FArchive& Archive, const FLocalFileReplayInfo& InRepl..., FLocalFileSerializationInfo& Seria... )

Overridden from INetworkReplayStreamer

	Name	Description
void	AddEvent ( const uint32 TimeInMS, const FString& Group, const FString& Meta, const TArray< uint8 >& Data )
void	AddOrUpdateEvent ( const FString& Name, const uint32 TimeInMS, const FString& Group, const FString& Meta, const TArray< uint8 >& Data )
void	AddUserToReplay ( const FString& UserString )	Adds a join-in-progress user to the set of users associated with the currently recording replay (if any)
void	DeleteFinishedStream ( const FString& StreamName, const int32 UserIndex, const FDeleteFinishedStreamCallback... )
void	DeleteFinishedStream ( const FString& StreamName, const FDeleteFinishedStreamCallback... )	Attempts to delete the stream with the specified name. May execute asynchronously.
void	DownloadHeader ( const FDownloadHeaderCallback& Del... )
void	EnumerateEvents ( const FString& Group, const FEnumerateEventsCallback& De... )
void	EnumerateEvents ( const FString& ReplayName, const FString& Group, const FEnumerateEventsCallback& De... )
void	EnumerateEvents ( const FString& ReplayName, const FString& Group, const int32 UserIndex, const FEnumerateEventsCallback& De... )
void	EnumerateRecentStreams ( const FNetworkReplayVersion& Repla..., const int32 UserIndex, const FEnumerateStreamsCallback& D... )	Retrieves the streams that have been recently viewed. May execute asynchronously.
void	EnumerateStreams ( const FNetworkReplayVersion& Repla..., const int32 UserIndex, const FString& MetaString, const TArray< FString >& ExtraParm..., const FEnumerateStreamsCallback& D... )	Retrieves the streams that are available for viewing.
void	FlushCheckpoint ( const uint32 TimeInMS )
FArchive ...	GetCheckpointArchive()
EStreamingOp...	GetDemoPath ( FString& DemoPath )	Gets the current base directory where Demos are stored.
FArchive ...	GetHeaderArchive()
ENetworkRepl...	GetLastError()	Returns the last error that occurred while streaming replays
uint32	GetMaxFriendlyNameSize()	Returns the maximum size of the friendly name text for this streamer, or 0 for unlimited.
FString	GetReplayID()	Returns the active replay name
FArchive ...	GetStreamingArchive()
uint32	GetTotalDemoTime()
void	GotoCheckpointIndex ( const int32 CheckpointIndex, const FGotoCallback& Delegate, EReplayCheckpointType CheckpointTyp... )
void	GotoTimeInMS ( const uint32 TimeInMS, const FGotoCallback& Delegate, EReplayCheckpointType CheckpointTyp... )
bool	IsCheckpointTypeSupported ( EReplayCheckpointType CheckpointTyp... )
bool	IsDataAvailable()
bool	IsDataAvailableForTimeRange ( const uint32 StartTimeInMS, const uint32 EndTimeInMS )
bool	IsLive()	Returns true if the playing stream is currently in progress
bool	IsLoadingCheckpoint()
void	KeepReplay ( const FString& ReplayName, const bool bKeep, const int32 UserIndex, const FKeepReplayCallback& Delegat... )
void	KeepReplay ( const FString& ReplayName, const bool bKeep, const FKeepReplayCallback& Delegat... )	Used to commit a replay to permanent storage.
void	RefreshHeader()
void	RenameReplay ( const FString& ReplayName, const FString& NewName, const int32 UserIndex, const FRenameReplayCallback& Deleg... )
void	RenameReplay ( const FString& ReplayName, const FString& NewName, const FRenameReplayCallback& Deleg... )	Used to change the name of a replay.
void	RenameReplayFriendlyName ( const FString& ReplayName, const FString& NewFriendlyName, const int32 UserIndex, const FRenameReplayCallback& Deleg... )
void	RenameReplayFriendlyName ( const FString& ReplayName, const FString& NewFriendlyName, const FRenameReplayCallback& Deleg... )	Used to change the friendly name of a replay.
void	RequestEventData ( const FString& EventID, const FRequestEventDataCallback& D... )
void	RequestEventData ( const FString& ReplayName, const FString& EventId, const int32 UserIndex, const FRequestEventDataCallback& D... )
void	RequestEventData ( const FString& ReplayName, const FString& EventID, const FRequestEventDataCallback& D... )
void	RequestEventGroupData ( const FString& Group, const FRequestEventGroupDataCallbac... )
void	RequestEventGroupData ( const FString& ReplayName, const FString& Group, const int32 UserIndex, const FRequestEventGroupDataCallbac... )
void	RequestEventGroupData ( const FString& ReplayName, const FString& Group, const FRequestEventGroupDataCallbac... )
void	SearchEvents ( const FString& EventGroup, const FSearchEventsCallback& Deleg... )
EStreamingOp...	SetDemoPath ( const FString& DemoPath )	Changes the base directory where Demos are stored.
void	SetHighPriorityTimeRange ( const uint32 StartTimeInMS, const uint32 EndTimeInMS )
void	SetTimeBufferHintSeconds ( const float InTimeBufferHintSeconds )	Sets a hint for how much data needs to be kept in memory.
void	StartStreaming ( const FStartStreamingParameters& P..., const FStartStreamingCallback& Del... )	INetworkReplayStreamer implementation
void	StopStreaming()
void	UpdatePlaybackTime ( uint32 TimeInMS )
void	UpdateTotalDemoTime ( uint32 TimeInMS )

Classes

	Name	Description
	FLocalFileSerializationInfo

Enums

	Name	Description
	EStreamerState	EStreamerState - Overall state of the streamer

Constants

Name	Description
FileMagic
LatestVersion
MaxFriendlyNameLen

Deprecated Functions

	Name	Description
int32	GetDecompressedSize ( FArchive& InCompressed )	No longer used
bool	ReadReplayInfo ( FArchive& Archive, FLocalFileReplayInfo& OutReplayInf..., FLocalFileSerializationInfo& Seria... )	Now takes a set of read flags
bool	ReadReplayInfo ( FArchive& Archive, FLocalFileReplayInfo& OutReplayInf... )	Now takes a set of read flags

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

Take our survey

Dismiss