1. Epic GamesDeveloper
  3. INetworkReplayStreamer

INetworkReplayStreamer

Generic interface for network replay streaming

API > API/Runtime > API/Runtime/NetworkReplayStreaming

References

   
Module NetworkReplayStreaming
Header /Engine/Source/Runtime/NetworkReplayStreaming/NetworkReplayStreaming/Public/NetworkReplayStreaming.h
Include #include "NetworkReplayStreaming.h"

Syntax

class INetworkReplayStreamer

Remarks

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.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

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

  
Public function void

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

  
Public function void

AddUserToReplay ( const FString& UserString
)

 Adds a join-in-progress user to the set of users associated with the currently recording replay (if any)
Public function Virtual Const TArray< FAnalyticsEventAttribute >  
Public function void

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

  
Public function void

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

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

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

 Retrieves the streams that have been recently viewed. May execute asynchronously.
Public function 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.
Public function Virtual void

Exec ( const TCHAR* Cmd,
FOutputDevice& Ar
)

  
Public function void

FlushCheckpoint ( const uint32 TimeInMS
)

  
Public function FArchive *  
Public function Const EStreamingOperationResult

GetDemoPath ( FString& DemoPath
)

 Gets the current base directory where Demos are stored.
Public function FArchive *  
Public function Virtual Const PRAGMA_DISABLE_DEPRECATION_WARNINGS ENetworkReplayError::Type Returns the last error that occurred while streaming replays
Public function Const uint32 Returns the maximum size of the friendly name text for this streamer, or 0 for unlimited.
Public function Const FString Returns the active replay name
Public function Virtual Const EReplayStreamerState Return current recording/playback state
Public function FArchive *  
Public function Const uint32 Time in milliseconds
Public function void

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

  
Public function void

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

  
Public function Virtual UE::Net::EHandleNetResult  
Public function Virtual Const bool  
Public function Const bool  
Public function Const bool  
Public function bool

IsDataAvailableForTimeRange ( const uint32 StartTimeInMS,
const uint32 EndTimeInMS
)

  
Public function Const bool

IsLive ()

 Returns true if the playing stream is currently in progress
Public function Const bool  
Public function void

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

 Used to commit a replay to permanent storage.
Public function void

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

  
Public function void  
Public function void

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

  
Public function void

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

 Used to change the name of a replay.
Public function void

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

  
Public function void

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

 Used to change the friendly name of a replay.
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function Virtual void  
Public function EStreamingOperationResult

SetDemoPath ( const FString& DemoPath
)

 Changes the base directory where Demos are stored.
Public function Virtual void  
Public function void

SetHighPriorityTimeRange ( const uint32 StartTimeInMS,
const uint32 EndTimeInMS
)

  
Public function void

SetTimeBufferHintSeconds ( const float InTimeBufferHintSeconds
)

 Sets a hint for how much data needs to be kept in memory.
Public function void  
Public function void  
Public function void

UpdatePlaybackTime ( uint32 TimeInMS
)

  
Public function void  

Constants

Name Description
OnReplayGetAnalyticsAttributes Called from base streamer interface AppendCommonReplayAttributes to set common attributes

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page