1. Epic GamesDeveloper
  3. FSaveGameNetworkReplayStreamer

FSaveGameNetworkReplayStreamer

Local file streamer that supports playback/recording to files on disk, and transferring replays to and from SaveGame slots.

API > API/Runtime > API/Runtime/SaveGameNetworkReplayStreaming

Local file streamer that supports playback/recording to files on disk, and transferring replays to and from SaveGame slots.

EnumerateStreams may be used to list all available replays that are in SaveGame slots. The Name member in any FNetworkReplayStreamInfo returned will be the SaveGame slot where the replay lives.

EnumerateRecentStreams may be used to list all available replays that are not in SaveGame slots. The Name member in any FNetworkReplayStreamInfo returned will be the relative path where the replay lives.

StartStreaming can be used to play replays both in and not in SaveGame slots. StartStreaming does not automatically put a replay in a SaveGame slot.

KeepReplay can be used to move a non SaveGame slot replay into a SaveGame slot. The original replay is left untouched.

DeleteFinishedStream can be used to delete replays both in and not in SaveGame slots.

Only one Save Game operation is permitted to occur at a single time (even across Streamers).

TODO: Proper handling of UserIndex.

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

Syntax

class FSaveGameNetworkReplayStreamer : public FLocalFileNetworkReplayStreamer

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FSaveGameNetworkReplayStreamer ( const FString& DemoSavePath,
const FString& PlaybackReplayName
)

   SaveGameNetworkReplayStreaming.h  
  SaveGameNetworkReplayStreaming.h  

Structs

Name Remarks
FSaveGameMetaData  
FSaveGameOptionInfo  
FSaveGameReplayVersionedInfo  
FSaveGameSanitizedNames  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
WeakOptionInfo TWeakPtr< FSaveGameOptionInfo > Although this isn't used on the GameThread, it should only be created / destroyed from the same thread. SaveGameNetworkReplayStreaming.h  

Functions

Public

Overridden from FLocalFileNetworkReplayStreamer

Name Remarks Include Path Unreal Specifiers

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

 INetworkReplayStreamer implementation SaveGameNetworkReplayStreaming.h  

Protected

Name Remarks Include Path Unreal Specifiers

void DeleteFinishedStream_Internal ( const FString& ReplayName,
const int32 UserIndex,
FDeleteFinishedStreamResult& Result
) const

   SaveGameNetworkReplayStreaming.h  

void DeleteFinishedStreamSaved ( const FString& ReplayName,
const int32 UserIndex,
const FDeleteFinishedStreamCallback& Delegate
) const

   SaveGameNetworkReplayStreaming.h  

void EnumerateEvents_Internal ( const FString& ReplayName,
const FString& Group,
const int32 UserIndex,
FEnumerateEventsResult& Result
) const

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

void EnumerateStreams_Internal ( const FNetworkReplayVersion& ReplayVersion,
const int32 UserIndex,
const FString& MetaString,
const TArray< FString >& ExtraParms,
FEnumerateStreamsResult& Result
)

   SaveGameNetworkReplayStreaming.h  

FString GetFullPlaybackName()

   SaveGameNetworkReplayStreaming.h  

FString GetLocalPlaybackName()

   SaveGameNetworkReplayStreaming.h  

int32 GetReplayIndexFromName ( const FString& ReplayName
) const

   SaveGameNetworkReplayStreaming.h  

virtual bool GetSaveGameOption ( const FSaveGameOptionInfo& OptionInfo,
FString& OptionValue
) const

 Called during KeepReplay to get options when saving a replay. SaveGameNetworkReplayStreaming.h  

bool IsSaveGameFileName ( const FString& ReplayName
) const

 Returns whether the input name corresponds to a save game. SaveGameNetworkReplayStreaming.h  

void KeepReplay_Internal ( const FString& ReplayName,
const bool bKeep,
const int32 UserIndex,
FKeepReplayResult& Result
)

   SaveGameNetworkReplayStreaming.h  

void KeepReplaySaved ( const FString& ReplayName,
const bool bKeep,
const int32 UserIndex,
const FKeepReplayCallback& Result
)

   SaveGameNetworkReplayStreaming.h  

void PopulateStreamInfoFromMetaData ( const FSaveGameMetaData& MetaData,
FNetworkReplayStreamInfo& OutStreamInfo
) const

   SaveGameNetworkReplayStreaming.h  

bool ReadMetaDataFromLocalStream ( FArchive& Archive,
FSaveGameMetaData& OutMetaData
) const

   SaveGameNetworkReplayStreaming.h  

bool ReadMetaDataFromSaveGame ( ISaveGameSystem& SaveGameSystem,
const FSaveGameSanitizedNames& SanitizedNames,
const int32 UserIndex,
FSaveGameMetaData& OutMetaData,
FStreamingResultBase& OutResult
) const

   SaveGameNetworkReplayStreaming.h  

void RenameReplayFriendlyName_Internal ( const FString& ReplayName,
const FString& NewFriendlyName,
const int32 UserIndex,
FRenameReplayResult& Result
) const

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

void ReplayIndexToSanitizedNames ( const int32 ReplayIndex,
FSaveGameSanitizedNames& OutSanitizedNames
) const

   SaveGameNetworkReplayStreaming.h  

void RequestEventData_Internal ( const FString& ReplayName,
const FString& EventID,
const int32 UserIndex,
FRequestEventDataResult& Result
)

   SaveGameNetworkReplayStreaming.h  

void RequestEventDataSaved ( const FString& ReplayName,
const FString& EventID,
const int32 UserIndex,
const FRequestEventDataCallback& Delegate
)

   SaveGameNetworkReplayStreaming.h  

void RequestEventGroupData_Internal ( const FString& ReplayName,
const FString& Group,
const int32 UserIndex,
FRequestEventGroupDataResult& Result
)

   SaveGameNetworkReplayStreaming.h  

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

   SaveGameNetworkReplayStreaming.h  

bool SerializeMetaData ( FArchive& Archive,
FSaveGameMetaData& MetaData
) const

   SaveGameNetworkReplayStreaming.h  

bool SerializeVersionedMetaData ( FArchive& Archive,
FSaveGameMetaData& MetaData
) const

   SaveGameNetworkReplayStreaming.h  

void StartStreaming_Internal ( const FStartStreamingParameters& Params,
FStartStreamingResult& Result
)

   SaveGameNetworkReplayStreaming.h  

void StartStreamingSaved ( const FStartStreamingParameters& Params,
const FStartStreamingCallback& Delegate
)

   SaveGameNetworkReplayStreaming.h  

bool StreamNameToSanitizedNames ( const FString& StreamName,
FSaveGameSanitizedNames& OutSanitizedNames
) const

   SaveGameNetworkReplayStreaming.h  

Overridden from FLocalFileNetworkReplayStreamer

Name Remarks Include Path Unreal Specifiers

virtual TArrayView< const FString > GetAdditionalRelativeDemoPaths()

   SaveGameNetworkReplayStreaming.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FString & GetDefaultDemoSavePath()

   SaveGameNetworkReplayStreaming.h  

static const FString & GetDefaultPlaybackName()

   SaveGameNetworkReplayStreaming.h  

static const FString & GetTempDemoRelativeSavePath()

   SaveGameNetworkReplayStreaming.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page