UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FNullNetworkReplayStreamer Class Reference

#include <NullNetworkReplayStreaming.h>

+ Inheritance diagram for FNullNetworkReplayStreamer:

Public Member Functions

 FNullNetworkReplayStreamer ()
 
virtual void StartStreaming (const FStartStreamingParameters &Params, const FStartStreamingCallback &Delegate) override
 
virtual void StopStreaming () override
 
virtual FArchiveGetHeaderArchive () override
 
virtual FArchiveGetStreamingArchive () override
 
virtual FArchiveGetCheckpointArchive () override
 
virtual void FlushCheckpoint (const uint32 TimeInMS) override
 
virtual void GotoCheckpointIndex (const int32 CheckpointIndex, const FGotoCallback &Delegate, EReplayCheckpointType CheckpointType) override
 
virtual void GotoTimeInMS (const uint32 TimeInMS, const FGotoCallback &Delegate, EReplayCheckpointType CheckpointType) override
 
virtual void UpdateTotalDemoTime (uint32 TimeInMS) override
 
virtual void UpdatePlaybackTime (uint32 TimeInMS) override
 
virtual uint32 GetTotalDemoTime () const override
 
virtual bool IsDataAvailable () const override
 
virtual void SetHighPriorityTimeRange (const uint32 StartTimeInMS, const uint32 EndTimeInMS) override
 
virtual bool IsDataAvailableForTimeRange (const uint32 StartTimeInMS, const uint32 EndTimeInMS) override
 
virtual bool IsLoadingCheckpoint () const override
 
virtual bool IsLive () const override
 
virtual void DeleteFinishedStream (const FString &StreamName, const FDeleteFinishedStreamCallback &Delegate) override
 
virtual void DeleteFinishedStream (const FString &StreamName, const int32 UserIndex, const FDeleteFinishedStreamCallback &Delegate) override
 
virtual void EnumerateStreams (const FNetworkReplayVersion &InReplayVersion, const int32 UserIndex, const FString &MetaString, const TArray< FString > &ExtraParms, const FEnumerateStreamsCallback &Delegate) override
 
virtual void EnumerateRecentStreams (const FNetworkReplayVersion &ReplayVersion, const int32 UserIndex, const FEnumerateStreamsCallback &Delegate) override
 
virtual void AddUserToReplay (const FString &UserString) override
 
virtual void AddEvent (const uint32 TimeInMS, const FString &Group, const FString &Meta, const TArray< uint8 > &Data) override
 
virtual void AddOrUpdateEvent (const FString &Name, const uint32 TimeInMS, const FString &Group, const FString &Meta, const TArray< uint8 > &Data) override
 
virtual void EnumerateEvents (const FString &Group, const FEnumerateEventsCallback &EnumerationCompleteDelegate) override
 
virtual void EnumerateEvents (const FString &ReplayName, const FString &Group, const FEnumerateEventsCallback &EnumerationCompleteDelegate) override
 
virtual void EnumerateEvents (const FString &ReplayName, const FString &Group, const int32 UserIndex, const FEnumerateEventsCallback &Delegate) override
 
virtual void RequestEventData (const FString &EventID, const FRequestEventDataCallback &Delegate) override
 
virtual void RequestEventData (const FString &ReplayName, const FString &EventID, const FRequestEventDataCallback &Delegate) override
 
virtual void RequestEventData (const FString &ReplayName, const FString &EventId, const int32 UserIndex, const FRequestEventDataCallback &Delegate) override
 
virtual void RequestEventGroupData (const FString &Group, const FRequestEventGroupDataCallback &Delegate) override
 
virtual void RequestEventGroupData (const FString &ReplayName, const FString &Group, const FRequestEventGroupDataCallback &Delegate) override
 
virtual void RequestEventGroupData (const FString &ReplayName, const FString &Group, const int32 UserIndex, const FRequestEventGroupDataCallback &Delegate) override
 
virtual void SearchEvents (const FString &EventGroup, const FSearchEventsCallback &Delegate) override
 
virtual void KeepReplay (const FString &ReplayName, const bool bKeep, const FKeepReplayCallback &Delegate) override
 
virtual void KeepReplay (const FString &ReplayName, const bool bKeep, const int32 UserIndex, const FKeepReplayCallback &Delegate) override
 
virtual void RenameReplayFriendlyName (const FString &ReplayName, const FString &NewFriendlyName, const FRenameReplayCallback &Delegate) override
 
virtual void RenameReplayFriendlyName (const FString &ReplayName, const FString &NewFriendlyName, const int32 UserIndex, const FRenameReplayCallback &Delegate) override
 
virtual void RenameReplay (const FString &ReplayName, const FString &NewName, const FRenameReplayCallback &Delegate) override
 
virtual void RenameReplay (const FString &ReplayName, const FString &NewName, const int32 UserIndex, const FRenameReplayCallback &Delegate) override
 
virtual FString GetReplayID () const override
 
virtual EReplayStreamerState GetReplayStreamerState () const override
 
virtual void SetTimeBufferHintSeconds (const float InTimeBufferHintSeconds) override
 
virtual void RefreshHeader () override
 
virtual void DownloadHeader (const FDownloadHeaderCallback &Delegate) override
 
virtual void Tick (float DeltaSeconds) override
 
virtual ETickableTickType GetTickableTickType () const override
 
virtual TStatId GetStatId () const override
 
virtual bool IsTickableWhenPaused () const override
 
virtual uint32 GetMaxFriendlyNameSize () const override
 
virtual EStreamingOperationResult SetDemoPath (const FString &DemoPath) override
 
virtual EStreamingOperationResult GetDemoPath (FString &DemoPath) const override
 
virtual bool IsCheckpointTypeSupported (EReplayCheckpointType CheckpointType) const override
 
- Public Member Functions inherited from INetworkReplayStreamer
NETWORKREPLAYSTREAMING_API INetworkReplayStreamer ()
 
virtual NETWORKREPLAYSTREAMING_API ~INetworkReplayStreamer ()
 
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 SetAnalyticsProvider (TSharedPtr< IAnalyticsProvider > &InProvider)
 
virtual NETWORKREPLAYSTREAMING_API TArray< FAnalyticsEventAttributeAppendCommonReplayAttributes (TArray< FAnalyticsEventAttribute > &&Attrs) const
 
virtual void Exec (const TCHAR *Cmd, FOutputDevice &Ar)
 
- Public Member Functions inherited from FTickableGameObject
 UE_NONCOPYABLE (FTickableGameObject)
 
ENGINE_API FTickableGameObject (ETickableTickType StartingTickType=ETickableTickType::NewObject)
 
virtual ENGINE_API ~FTickableGameObject ()
 
virtual bool IsTickableInEditor () const
 
virtual UWorldGetTickableGameObjectWorld () const
 
ENGINE_API void SetTickableTickType (ETickableTickType NewTickType)
 
- Public Member Functions inherited from FTickableObjectBase
virtual bool IsTickable () const
 
virtual bool IsAllowedToTick () const
 

Additional Inherited Members

- Static Public Member Functions inherited from FTickableGameObject
static ENGINE_API void TickObjects (UWorld *World, ELevelTick LevelTickType, bool bIsPaused, float DeltaSeconds)
 
- Static Public Attributes inherited from INetworkReplayStreamer
static NETWORKREPLAYSTREAMING_API FOnReplayGetAnalyticsAttributes OnReplayGetAnalyticsAttributes
 
- Static Protected Member Functions inherited from FTickableObjectBase
static ENGINE_API void SimpleTickObjects (FTickableStatics &Statics, TFunctionRef< void(FTickableObjectBase *)> TickFunc)
 

Detailed Description

Default streamer that goes straight to the HD

Constructor & Destructor Documentation

◆ FNullNetworkReplayStreamer()

FNullNetworkReplayStreamer::FNullNetworkReplayStreamer ( )
inline

Member Function Documentation

◆ AddEvent()

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

◆ AddOrUpdateEvent()

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

◆ AddUserToReplay()

void FNullNetworkReplayStreamer::AddUserToReplay ( const FString &  UserString)
overridevirtual

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

Implements INetworkReplayStreamer.

◆ DeleteFinishedStream() [1/2]

void FNullNetworkReplayStreamer::DeleteFinishedStream ( const FString &  StreamName,
const FDeleteFinishedStreamCallback Delegate 
)
overridevirtual

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

Implements INetworkReplayStreamer.

◆ DeleteFinishedStream() [2/2]

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

◆ DownloadHeader()

virtual void FNullNetworkReplayStreamer::DownloadHeader ( const FDownloadHeaderCallback Delegate)
inlineoverridevirtual

◆ EnumerateEvents() [1/3]

void FNullNetworkReplayStreamer::EnumerateEvents ( const FString &  Group,
const FEnumerateEventsCallback EnumerationCompleteDelegate 
)
overridevirtual

◆ EnumerateEvents() [2/3]

void FNullNetworkReplayStreamer::EnumerateEvents ( const FString &  ReplayName,
const FString &  Group,
const FEnumerateEventsCallback EnumerationCompleteDelegate 
)
overridevirtual

◆ EnumerateEvents() [3/3]

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

◆ EnumerateRecentStreams()

void FNullNetworkReplayStreamer::EnumerateRecentStreams ( const FNetworkReplayVersion ReplayVersion,
const int32  UserIndex,
const FEnumerateStreamsCallback Delegate 
)
overridevirtual

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

Implements INetworkReplayStreamer.

◆ EnumerateStreams()

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

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

Implements INetworkReplayStreamer.

◆ FlushCheckpoint()

void FNullNetworkReplayStreamer::FlushCheckpoint ( const uint32  TimeInMS)
overridevirtual

◆ GetCheckpointArchive()

FArchive * FNullNetworkReplayStreamer::GetCheckpointArchive ( )
overridevirtual

◆ GetDemoPath()

EStreamingOperationResult FNullNetworkReplayStreamer::GetDemoPath ( FString &  DemoPath) const
overridevirtual

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

Implements INetworkReplayStreamer.

◆ GetHeaderArchive()

FArchive * FNullNetworkReplayStreamer::GetHeaderArchive ( )
overridevirtual

◆ GetMaxFriendlyNameSize()

virtual uint32 FNullNetworkReplayStreamer::GetMaxFriendlyNameSize ( ) const
inlineoverridevirtual

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

Implements INetworkReplayStreamer.

◆ GetReplayID()

virtual FString FNullNetworkReplayStreamer::GetReplayID ( ) const
inlineoverridevirtual

Returns the active replay name

Implements INetworkReplayStreamer.

◆ GetReplayStreamerState()

virtual EReplayStreamerState FNullNetworkReplayStreamer::GetReplayStreamerState ( ) const
inlineoverridevirtual

Return current recording/playback state

Reimplemented from INetworkReplayStreamer.

◆ GetStatId()

TStatId FNullNetworkReplayStreamer::GetStatId ( ) const
overridevirtual

Return the stat id used to track the performance of this object

Implements FTickableObjectBase.

◆ GetStreamingArchive()

FArchive * FNullNetworkReplayStreamer::GetStreamingArchive ( )
overridevirtual

◆ GetTickableTickType()

virtual ETickableTickType FNullNetworkReplayStreamer::GetTickableTickType ( ) const
inlineoverridevirtual

Virtual that can be overloaded by the inheriting class and is called before first tick. It is used to determine whether an object can possibly tick, and if not, it will not get added to the tickable objects array. If the tickable tick type is Conditional then the virtual IsTickable will be called to determine whether to tick the object on each given frame.

Returns
an enum defining the rules for ticking this object.

Reimplemented from FTickableObjectBase.

◆ GetTotalDemoTime()

virtual uint32 FNullNetworkReplayStreamer::GetTotalDemoTime ( ) const
inlineoverridevirtual

Time in milliseconds

Implements INetworkReplayStreamer.

◆ GotoCheckpointIndex()

void FNullNetworkReplayStreamer::GotoCheckpointIndex ( const int32  CheckpointIndex,
const FGotoCallback Delegate,
EReplayCheckpointType  CheckpointType 
)
overridevirtual

◆ GotoTimeInMS()

void FNullNetworkReplayStreamer::GotoTimeInMS ( const uint32  TimeInMS,
const FGotoCallback Delegate,
EReplayCheckpointType  CheckpointType 
)
overridevirtual

◆ IsCheckpointTypeSupported()

virtual bool FNullNetworkReplayStreamer::IsCheckpointTypeSupported ( EReplayCheckpointType  CheckpointType) const
inlineoverridevirtual

◆ IsDataAvailable()

bool FNullNetworkReplayStreamer::IsDataAvailable ( ) const
overridevirtual

◆ IsDataAvailableForTimeRange()

virtual bool FNullNetworkReplayStreamer::IsDataAvailableForTimeRange ( const uint32  StartTimeInMS,
const uint32  EndTimeInMS 
)
inlineoverridevirtual

◆ IsLive()

bool FNullNetworkReplayStreamer::IsLive ( ) const
overridevirtual

Returns true if the playing stream is currently in progress

Implements INetworkReplayStreamer.

◆ IsLoadingCheckpoint()

virtual bool FNullNetworkReplayStreamer::IsLoadingCheckpoint ( ) const
inlineoverridevirtual

◆ IsTickableWhenPaused()

virtual bool FNullNetworkReplayStreamer::IsTickableWhenPaused ( ) const
inlineoverridevirtual

FTickableGameObject implementation

Reimplemented from FTickableGameObject.

◆ KeepReplay() [1/2]

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

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.

Implements INetworkReplayStreamer.

◆ KeepReplay() [2/2]

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

◆ RefreshHeader()

virtual void FNullNetworkReplayStreamer::RefreshHeader ( )
inlineoverridevirtual

◆ RenameReplay() [1/2]

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

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.

Implements INetworkReplayStreamer.

◆ RenameReplay() [2/2]

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

◆ RenameReplayFriendlyName() [1/2]

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

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.

Implements INetworkReplayStreamer.

◆ RenameReplayFriendlyName() [2/2]

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

◆ RequestEventData() [1/3]

void FNullNetworkReplayStreamer::RequestEventData ( const FString &  EventID,
const FRequestEventDataCallback Delegate 
)
overridevirtual

◆ RequestEventData() [2/3]

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

◆ RequestEventData() [3/3]

void FNullNetworkReplayStreamer::RequestEventData ( const FString &  ReplayName,
const FString &  EventId,
const int32  UserIndex,
const FRequestEventDataCallback Delegate 
)
overridevirtual

◆ RequestEventGroupData() [1/3]

void FNullNetworkReplayStreamer::RequestEventGroupData ( const FString &  Group,
const FRequestEventGroupDataCallback Delegate 
)
overridevirtual

◆ RequestEventGroupData() [2/3]

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

◆ RequestEventGroupData() [3/3]

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

◆ SearchEvents()

void FNullNetworkReplayStreamer::SearchEvents ( const FString &  EventGroup,
const FSearchEventsCallback Delegate 
)
overridevirtual

◆ SetDemoPath()

virtual EStreamingOperationResult FNullNetworkReplayStreamer::SetDemoPath ( const FString &  DemoPath)
inlineoverridevirtual

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.

Implements INetworkReplayStreamer.

◆ SetHighPriorityTimeRange()

virtual void FNullNetworkReplayStreamer::SetHighPriorityTimeRange ( const uint32  StartTimeInMS,
const uint32  EndTimeInMS 
)
inlineoverridevirtual

◆ SetTimeBufferHintSeconds()

virtual void FNullNetworkReplayStreamer::SetTimeBufferHintSeconds ( const float  InTimeBufferHintSeconds)
inlineoverridevirtual

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.

Implements INetworkReplayStreamer.

◆ StartStreaming()

void FNullNetworkReplayStreamer::StartStreaming ( const FStartStreamingParameters Params,
const FStartStreamingCallback Delegate 
)
overridevirtual

INetworkReplayStreamer implementation

Implements INetworkReplayStreamer.

◆ StopStreaming()

void FNullNetworkReplayStreamer::StopStreaming ( )
overridevirtual

◆ Tick()

void FNullNetworkReplayStreamer::Tick ( float  DeltaSeconds)
overridevirtual

FTickableObjectBase implementation

Implements FTickableObjectBase.

◆ UpdatePlaybackTime()

virtual void FNullNetworkReplayStreamer::UpdatePlaybackTime ( uint32  TimeInMS)
inlineoverridevirtual

◆ UpdateTotalDemoTime()

void FNullNetworkReplayStreamer::UpdateTotalDemoTime ( uint32  TimeInMS)
overridevirtual

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