1. Epic GamesDeveloper
  3. INetworkReplayStreamer

INetworkReplayStreamer

Generic interface for network replay streaming

API > API/Runtime > API/Runtime/NetworkReplayStreaming

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.

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

Syntax

class INetworkReplayStreamer

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

INetworkReplayStreamer()

   NetworkReplayStreaming.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~INetworkReplayStreamer()

   NetworkReplayStreaming.h  

Constants

Name Type Remarks Include Path
OnReplayGetAnalyticsAttributes FOnReplayGetAnalyticsAttributes Called from base streamer interface AppendCommonReplayAttributes to set common attributes NetworkReplayStreaming.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ExtendedError TPimplPtr< UE::Net::FNetResult, EPimplPtrMode::DeepCopy >   NetworkReplayStreaming.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

void AddUserToReplay ( const FString& UserString
)

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

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

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

void DownloadHeader ( const FDownloadHeaderCallback& Delegate
)

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

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

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

 Retrieves the streams that are available for viewing. NetworkReplayStreaming.h  

virtual void Exec ( const TCHAR* Cmd,
FOutputDevice& Ar
)

   NetworkReplayStreaming.h  

void FlushCheckpoint ( const uint32 TimeInMS
)

   NetworkReplayStreaming.h  

FArchive * GetCheckpointArchive()

   NetworkReplayStreaming.h  
Gets the current base directory where Demos are stored. NetworkReplayStreaming.h  

FArchive * GetHeaderArchive()

   NetworkReplayStreaming.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS ENetworkReplayError::Type GetLastError()

 Returns the last error that occurred while streaming replays NetworkReplayStreaming.h  

uint32 GetMaxFriendlyNameSize()

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

FString GetReplayID()

 Returns the active replay name NetworkReplayStreaming.h  

virtual EReplayStreamerState GetReplayStreamerState()

 Return current recording/playback state NetworkReplayStreaming.h  

FArchive * GetStreamingArchive()

   NetworkReplayStreaming.h  

uint32 GetTotalDemoTime()

 Time in milliseconds NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

virtual bool HasError()

   NetworkReplayStreaming.h  

bool IsCheckpointTypeSupported ( EReplayCheckpointType CheckpointType
) const

   NetworkReplayStreaming.h  

bool IsDataAvailable()

   NetworkReplayStreaming.h  

bool IsDataAvailableForTimeRange ( const uint32 StartTimeInMS,
const uint32 EndTimeInMS
)

   NetworkReplayStreaming.h  

bool IsLive()

 Returns true if the playing stream is currently in progress NetworkReplayStreaming.h  

bool IsLoadingCheckpoint()

   NetworkReplayStreaming.h  

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

 Used to commit a replay to permanent storage. NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

void RefreshHeader()

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

 Used to change the name of a replay. NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

 Used to change the friendly name of a replay. NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

virtual void SetAnalyticsProvider ( TSharedPtr< IAnalyticsProvider >& InProvider
)

   NetworkReplayStreaming.h  
Changes the base directory where Demos are stored. NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

void SetHighPriorityTimeRange ( const uint32 StartTimeInMS,
const uint32 EndTimeInMS
)

   NetworkReplayStreaming.h  

void SetTimeBufferHintSeconds ( const float InTimeBufferHintSeconds
)

 Sets a hint for how much data needs to be kept in memory. NetworkReplayStreaming.h  

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

   NetworkReplayStreaming.h  

void StopStreaming()

   NetworkReplayStreaming.h  

void UpdatePlaybackTime ( uint32 TimeInMS
)

   NetworkReplayStreaming.h  

void UpdateTotalDemoTime ( uint32 TimeInMS
)

   NetworkReplayStreaming.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page