UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
INetworkReplayStreamer Class Referenceabstract

#include <NetworkReplayStreaming.h>

+ Inheritance diagram for INetworkReplayStreamer:

Public Member Functions

NETWORKREPLAYSTREAMING_API INetworkReplayStreamer ()
 
virtual NETWORKREPLAYSTREAMING_API ~INetworkReplayStreamer ()
 
virtual void StartStreaming (const FStartStreamingParameters &Params, const FStartStreamingCallback &Delegate)=0
 
virtual void StopStreaming ()=0
 
virtual FArchiveGetHeaderArchive ()=0
 
virtual FArchiveGetStreamingArchive ()=0
 
virtual FArchiveGetCheckpointArchive ()=0
 
virtual void FlushCheckpoint (const uint32 TimeInMS)=0
 
virtual void GotoCheckpointIndex (const int32 CheckpointIndex, const FGotoCallback &Delegate, EReplayCheckpointType CheckpointType)=0
 
virtual void GotoTimeInMS (const uint32 TimeInMS, const FGotoCallback &Delegate, EReplayCheckpointType CheckpointType)=0
 
virtual bool IsCheckpointTypeSupported (EReplayCheckpointType CheckpointType) const =0
 
virtual void UpdateTotalDemoTime (uint32 TimeInMS)=0
 
virtual void UpdatePlaybackTime (uint32 TimeInMS)=0
 
virtual uint32 GetTotalDemoTime () const =0
 
virtual bool IsDataAvailable () const =0
 
virtual void SetHighPriorityTimeRange (const uint32 StartTimeInMS, const uint32 EndTimeInMS)=0
 
virtual bool IsDataAvailableForTimeRange (const uint32 StartTimeInMS, const uint32 EndTimeInMS)=0
 
virtual bool IsLoadingCheckpoint () const =0
 
virtual void AddEvent (const uint32 TimeInMS, const FString &Group, const FString &Meta, const TArray< uint8 > &Data)=0
 
virtual void AddOrUpdateEvent (const FString &Name, const uint32 TimeInMS, const FString &Group, const FString &Meta, const TArray< uint8 > &Data)=0
 
virtual void EnumerateEvents (const FString &Group, const FEnumerateEventsCallback &Delegate)=0
 
virtual void EnumerateEvents (const FString &ReplayName, const FString &Group, const FEnumerateEventsCallback &Delegate)=0
 
virtual void EnumerateEvents (const FString &ReplayName, const FString &Group, const int32 UserIndex, const FEnumerateEventsCallback &Delegate)=0
 
virtual void RequestEventData (const FString &EventID, const FRequestEventDataCallback &Delegate)=0
 
virtual void RequestEventData (const FString &ReplayName, const FString &EventID, const FRequestEventDataCallback &Delegate)=0
 
virtual void RequestEventData (const FString &ReplayName, const FString &EventID, const int32 UserIndex, const FRequestEventDataCallback &Delegate)=0
 
virtual void RequestEventGroupData (const FString &Group, const FRequestEventGroupDataCallback &Delegate)=0
 
virtual void RequestEventGroupData (const FString &ReplayName, const FString &Group, const FRequestEventGroupDataCallback &Delegate)=0
 
virtual void RequestEventGroupData (const FString &ReplayName, const FString &Group, const int32 UserIndex, const FRequestEventGroupDataCallback &Delegate)=0
 
virtual void SearchEvents (const FString &EventGroup, const FSearchEventsCallback &Delegate)=0
 
virtual void RefreshHeader ()=0
 
virtual void DownloadHeader (const FDownloadHeaderCallback &Delegate)=0
 
virtual void KeepReplay (const FString &ReplayName, const bool bKeep, const FKeepReplayCallback &Delegate)=0
 
virtual void KeepReplay (const FString &ReplayName, const bool bKeep, const int32 UserIndex, const FKeepReplayCallback &Delegate)=0
 
virtual void RenameReplayFriendlyName (const FString &ReplayName, const FString &NewFriendlyName, const FRenameReplayCallback &Delegate)=0
 
virtual void RenameReplayFriendlyName (const FString &ReplayName, const FString &NewFriendlyName, const int32 UserIndex, const FRenameReplayCallback &Delegate)=0
 
virtual void RenameReplay (const FString &ReplayName, const FString &NewName, const FRenameReplayCallback &Delegate)=0
 
virtual void RenameReplay (const FString &ReplayName, const FString &NewName, const int32 UserIndex, const FRenameReplayCallback &Delegate)=0
 
virtual bool IsLive () const =0
 
virtual FString GetReplayID () const =0
 
virtual EReplayStreamerState GetReplayStreamerState () const
 
virtual void DeleteFinishedStream (const FString &StreamName, const FDeleteFinishedStreamCallback &Delegate)=0
 
virtual void DeleteFinishedStream (const FString &StreamName, const int32 UserIndex, const FDeleteFinishedStreamCallback &Delegate)=0
 
virtual void EnumerateStreams (const FNetworkReplayVersion &ReplayVersion, const int32 UserIndex, const FString &MetaString, const TArray< FString > &ExtraParms, const FEnumerateStreamsCallback &Delegate)=0
 
virtual void EnumerateRecentStreams (const FNetworkReplayVersion &ReplayVersion, const int32 UserIndex, const FEnumerateStreamsCallback &Delegate)=0
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS virtual NETWORKREPLAYSTREAMING_API ENetworkReplayError::Type GetLastError () const
 
NETWORKREPLAYSTREAMING_API virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS bool HasError () const
 
virtual NETWORKREPLAYSTREAMING_API UE::Net::EHandleNetResult HandleLastError (UE::Net::FNetResultManager &ResultManager)
 
virtual NETWORKREPLAYSTREAMING_API void SetExtendedError (UE::Net::FNetResult &&Result)
 
virtual void AddUserToReplay (const FString &UserString)=0
 
virtual void SetTimeBufferHintSeconds (const float InTimeBufferHintSeconds)=0
 
virtual uint32 GetMaxFriendlyNameSize () const =0
 
virtual EStreamingOperationResult SetDemoPath (const FString &DemoPath)=0
 
virtual EStreamingOperationResult GetDemoPath (FString &DemoPath) const =0
 
virtual void SetAnalyticsProvider (TSharedPtr< IAnalyticsProvider > &InProvider)
 
virtual NETWORKREPLAYSTREAMING_API TArray< FAnalyticsEventAttributeAppendCommonReplayAttributes (TArray< FAnalyticsEventAttribute > &&Attrs) const
 
virtual void Exec (const TCHAR *Cmd, FOutputDevice &Ar)
 

Static Public Attributes

static NETWORKREPLAYSTREAMING_API FOnReplayGetAnalyticsAttributes OnReplayGetAnalyticsAttributes
 

Detailed Description

Generic interface for network replay streaming

When a delegate is provided as an argument, it is expected that the implementation calls that delegate upon completion, and indicates success / failure through an appropriate result type passed into the delegate.

Constructor & Destructor Documentation

◆ INetworkReplayStreamer()

PRAGMA_ENABLE_DEPRECATION_WARNINGS INetworkReplayStreamer::INetworkReplayStreamer ( )
default

◆ ~INetworkReplayStreamer()

INetworkReplayStreamer::~INetworkReplayStreamer ( )
virtualdefault

Member Function Documentation

◆ AddEvent()

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

◆ AddOrUpdateEvent()

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

◆ AddUserToReplay()

virtual void INetworkReplayStreamer::AddUserToReplay ( const FString &  UserString)
pure virtual

Adds a join-in-progress user to the set of users associated with the currently recording replay (if any)

Parameters
UserStringa string that uniquely identifies the user, usually their FUniqueNetId

Implemented in FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, and FNullNetworkReplayStreamer.

◆ AppendCommonReplayAttributes()

TArray< FAnalyticsEventAttribute > INetworkReplayStreamer::AppendCommonReplayAttributes ( TArray< FAnalyticsEventAttribute > &&  Attrs) const
virtual

◆ DeleteFinishedStream() [1/2]

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

Attempts to delete the stream with the specified name. May execute asynchronously.

Parameters
StreamNameThe name of the stream to delete
DelegateA delegate that will be executed if bound when the delete operation completes

Implemented in FSaveGameNetworkReplayStreamer, FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, and FNullNetworkReplayStreamer.

◆ DeleteFinishedStream() [2/2]

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

◆ DownloadHeader()

virtual void INetworkReplayStreamer::DownloadHeader ( const FDownloadHeaderCallback Delegate)
pure virtual

◆ EnumerateEvents() [1/3]

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

◆ EnumerateEvents() [2/3]

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

◆ EnumerateEvents() [3/3]

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

◆ EnumerateRecentStreams()

virtual void INetworkReplayStreamer::EnumerateRecentStreams ( const FNetworkReplayVersion ReplayVersion,
const int32  UserIndex,
const FEnumerateStreamsCallback Delegate 
)
pure virtual

Retrieves the streams that have been recently viewed. May execute asynchronously.

Parameters
DelegateA delegate that will be executed if bound when the list of streams is available

Implemented in FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, FNullNetworkReplayStreamer, and FSaveGameNetworkReplayStreamer.

◆ EnumerateStreams()

virtual void INetworkReplayStreamer::EnumerateStreams ( const FNetworkReplayVersion ReplayVersion,
const int32  UserIndex,
const FString &  MetaString,
const TArray< FString > &  ExtraParms,
const FEnumerateStreamsCallback Delegate 
)
pure virtual

Retrieves the streams that are available for viewing. May execute asynchronously. Allows the caller to pass in a custom list of query parameters

Implemented in FHttpNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, FNullNetworkReplayStreamer, FSaveGameNetworkReplayStreamer, and FInMemoryNetworkReplayStreamer.

◆ Exec()

virtual void INetworkReplayStreamer::Exec ( const TCHAR Cmd,
FOutputDevice Ar 
)
inlinevirtual

◆ FlushCheckpoint()

virtual void INetworkReplayStreamer::FlushCheckpoint ( const uint32  TimeInMS)
pure virtual

◆ GetCheckpointArchive()

virtual FArchive * INetworkReplayStreamer::GetCheckpointArchive ( )
pure virtual

◆ GetDemoPath()

virtual EStreamingOperationResult INetworkReplayStreamer::GetDemoPath ( FString &  DemoPath) const
pure virtual

Gets the current base directory where Demos are stored. Note, this will always fail for streamers that don't support replays stored on disk.

Implemented in FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, and FNullNetworkReplayStreamer.

◆ GetHeaderArchive()

virtual FArchive * INetworkReplayStreamer::GetHeaderArchive ( )
pure virtual

◆ GetLastError()

PRAGMA_DISABLE_DEPRECATION_WARNINGS ENetworkReplayError::Type INetworkReplayStreamer::GetLastError ( ) const
virtual

Returns the last error that occurred while streaming replays

◆ GetMaxFriendlyNameSize()

virtual uint32 INetworkReplayStreamer::GetMaxFriendlyNameSize ( ) const
pure virtual

Returns the maximum size of the friendly name text for this streamer, or 0 for unlimited.

Implemented in FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, and FNullNetworkReplayStreamer.

◆ GetReplayID()

virtual FString INetworkReplayStreamer::GetReplayID ( ) const
pure virtual

◆ GetReplayStreamerState()

virtual EReplayStreamerState INetworkReplayStreamer::GetReplayStreamerState ( ) const
inlinevirtual

◆ GetStreamingArchive()

virtual FArchive * INetworkReplayStreamer::GetStreamingArchive ( )
pure virtual

◆ GetTotalDemoTime()

virtual uint32 INetworkReplayStreamer::GetTotalDemoTime ( ) const
pure virtual

◆ GotoCheckpointIndex()

virtual void INetworkReplayStreamer::GotoCheckpointIndex ( const int32  CheckpointIndex,
const FGotoCallback Delegate,
EReplayCheckpointType  CheckpointType 
)
pure virtual

◆ GotoTimeInMS()

virtual void INetworkReplayStreamer::GotoTimeInMS ( const uint32  TimeInMS,
const FGotoCallback Delegate,
EReplayCheckpointType  CheckpointType 
)
pure virtual

◆ HandleLastError()

UE::Net::EHandleNetResult INetworkReplayStreamer::HandleLastError ( UE::Net::FNetResultManager ResultManager)
virtual

◆ HasError()

bool INetworkReplayStreamer::HasError ( ) const
virtual

◆ IsCheckpointTypeSupported()

virtual bool INetworkReplayStreamer::IsCheckpointTypeSupported ( EReplayCheckpointType  CheckpointType) const
pure virtual

◆ IsDataAvailable()

virtual bool INetworkReplayStreamer::IsDataAvailable ( ) const
pure virtual

◆ IsDataAvailableForTimeRange()

virtual bool INetworkReplayStreamer::IsDataAvailableForTimeRange ( const uint32  StartTimeInMS,
const uint32  EndTimeInMS 
)
pure virtual

◆ IsLive()

virtual bool INetworkReplayStreamer::IsLive ( ) const
pure virtual

Returns true if the playing stream is currently in progress

Implemented in FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, and FNullNetworkReplayStreamer.

◆ IsLoadingCheckpoint()

virtual bool INetworkReplayStreamer::IsLoadingCheckpoint ( ) const
pure virtual

◆ KeepReplay() [1/2]

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

Used to commit a replay to permanent storage.

Parameters
ReplayNameName of the replay to keep.
bKeepWhether or not we actually want to keep this replay.

Implemented in FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, FNullNetworkReplayStreamer, and FSaveGameNetworkReplayStreamer.

◆ KeepReplay() [2/2]

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

◆ RefreshHeader()

virtual void INetworkReplayStreamer::RefreshHeader ( )
pure virtual

◆ RenameReplay() [1/2]

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

Used to change the name of a replay. Note, this will change the name used to refer to the replay (if successful).

Parameters
ReplayNameName of the replay to rename.
NewNameThe new name for the replay.

Implemented in FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, FNullNetworkReplayStreamer, and FSaveGameNetworkReplayStreamer.

◆ RenameReplay() [2/2]

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

◆ RenameReplayFriendlyName() [1/2]

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

Used to change the friendly name of a replay. Note, changing the friendly name does not change the name used to refer to replay.

Parameters
ReplayNameName of the replay to rename.
NewFriendlyNameThe new friendly name for the replay.

Implemented in FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, FNullNetworkReplayStreamer, and FSaveGameNetworkReplayStreamer.

◆ RenameReplayFriendlyName() [2/2]

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

◆ RequestEventData() [1/3]

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

◆ RequestEventData() [2/3]

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

◆ RequestEventData() [3/3]

virtual void INetworkReplayStreamer::RequestEventData ( const FString &  ReplayName,
const FString &  EventID,
const int32  UserIndex,
const FRequestEventDataCallback Delegate 
)
pure virtual

◆ RequestEventGroupData() [1/3]

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

◆ RequestEventGroupData() [2/3]

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

◆ RequestEventGroupData() [3/3]

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

◆ SearchEvents()

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

◆ SetAnalyticsProvider()

virtual void INetworkReplayStreamer::SetAnalyticsProvider ( TSharedPtr< IAnalyticsProvider > &  InProvider)
inlinevirtual

◆ SetDemoPath()

virtual EStreamingOperationResult INetworkReplayStreamer::SetDemoPath ( const FString &  DemoPath)
pure virtual

Changes the base directory where Demos are stored. Note, this will always fail for streamers that don't support replays stored on disk. This method should not be called after StartStreaming, or while async operations are pending on a streamer.

Implemented in FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, and FNullNetworkReplayStreamer.

◆ SetExtendedError()

void INetworkReplayStreamer::SetExtendedError ( UE::Net::FNetResult &&  Result)
virtual

◆ SetHighPriorityTimeRange()

virtual void INetworkReplayStreamer::SetHighPriorityTimeRange ( const uint32  StartTimeInMS,
const uint32  EndTimeInMS 
)
pure virtual

◆ SetTimeBufferHintSeconds()

virtual void INetworkReplayStreamer::SetTimeBufferHintSeconds ( const float  InTimeBufferHintSeconds)
pure virtual

Sets a hint for how much data needs to be kept in memory. If set to a value greater than zero, a streamer implementation may free any in-memory data that would be required to go to a time before the beginning of the buffer.

Implemented in FHttpNetworkReplayStreamer, FInMemoryNetworkReplayStreamer, FLocalFileNetworkReplayStreamer, and FNullNetworkReplayStreamer.

◆ StartStreaming()

◆ StopStreaming()

virtual void INetworkReplayStreamer::StopStreaming ( )
pure virtual

◆ UpdatePlaybackTime()

virtual void INetworkReplayStreamer::UpdatePlaybackTime ( uint32  TimeInMS)
pure virtual

◆ UpdateTotalDemoTime()

virtual void INetworkReplayStreamer::UpdateTotalDemoTime ( uint32  TimeInMS)
pure virtual

Member Data Documentation

◆ OnReplayGetAnalyticsAttributes

FOnReplayGetAnalyticsAttributes INetworkReplayStreamer::OnReplayGetAnalyticsAttributes
static

Called from base streamer interface AppendCommonReplayAttributes to set common attributes


The documentation for this class was generated from the following files: