INetworkReplayStreamer

Generic interface for network replay streaming

Windows
MacOS
Linux

Inheritance Hierarchy

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

Name Description

Public function Virtual

~INetworkReplayStreamer()

Functions

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

void

 

DeleteFinishedStream

(
    const FString& StreamName,
    const int32 UserIndex,
    const FDeleteFinishedStreamCallback...
)

Public function

void

 

DeleteFinishedStream

(
    const FString& StreamName,
    const FDeleteFinishedStreamCallback...
)

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

Public function

void

 

DownloadHeader

(
    const FDownloadHeaderCallback& Del...
)

Public function

void

 

EnumerateEvents

(
    const FString& Group,
    const FEnumerateEventsCallback& De...
)

Public function

void

 

EnumerateEvents

(
    const FString& ReplayName,
    const FString& Group,
    const FEnumerateEventsCallback& De...
)

Public function

void

 

EnumerateEvents

(
    const FString& ReplayName,
    const FString& Group,
    const int32 UserIndex,
    const FEnumerateEventsCallback& De...
)

Public function

void

 

EnumerateRecentStreams

(
    const FNetworkReplayVersion& Repla...,
    const int32 UserIndex,
    const FEnumerateStreamsCallback& D...
)

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

Public function

void

 

EnumerateStreams

(
    const FNetworkReplayVersion& Repla...,
    const int32 UserIndex,
    const FString& MetaString,
    const TArray< FString >& ExtraParm...,
    const FEnumerateStreamsCallback& D...
)

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 ...

 

GetCheckpointArchive()

Public function Const

EStreamingOp...

 

GetDemoPath

(
    FString& DemoPath
)

Gets the current base directory where Demos are stored.

Public function

FArchive ...

 

GetHeaderArchive()

Public function Const

ENetworkRepl...

 

GetLastError()

Returns the last error that occurred while streaming replays

Public function Const

uint32

 

GetMaxFriendlyNameSize()

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

Public function Const

FString

 

GetReplayID()

Returns the active replay name

Public function

FArchive ...

 

GetStreamingArchive()

Public function Const

uint32

 

GetTotalDemoTime()

Public function

void

 

GotoCheckpointIndex

(
    const int32 CheckpointIndex,
    const FGotoCallback& Delegate,
    EReplayCheckpointType CheckpointTyp...
)

Public function

void

 

GotoTimeInMS

(
    const uint32 TimeInMS,
    const FGotoCallback& Delegate,
    EReplayCheckpointType CheckpointTyp...
)

Public function Const

bool

 

IsCheckpointTypeSupported

(
    EReplayCheckpointType CheckpointTyp...
)

Public function Const

bool

 

IsDataAvailable()

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

 

IsLoadingCheckpoint()

Public function

void

 

KeepReplay

(
    const FString& ReplayName,
    const bool bKeep,
    const int32 UserIndex,
    const FKeepReplayCallback& Delegat...
)

Public function

void

 

KeepReplay

(
    const FString& ReplayName,
    const bool bKeep,
    const FKeepReplayCallback& Delegat...
)

Used to commit a replay to permanent storage.

Public function

void

 

RefreshHeader()

Public function

void

 

RenameReplay

(
    const FString& ReplayName,
    const FString& NewName,
    const int32 UserIndex,
    const FRenameReplayCallback& Deleg...
)

Public function

void

 

RenameReplay

(
    const FString& ReplayName,
    const FString& NewName,
    const FRenameReplayCallback& Deleg...
)

Used to change the name of a replay.

Public function

void

 

RenameReplayFriendlyName

(
    const FString& ReplayName,
    const FString& NewFriendlyName,
    const int32 UserIndex,
    const FRenameReplayCallback& Deleg...
)

Public function

void

 

RenameReplayFriendlyName

(
    const FString& ReplayName,
    const FString& NewFriendlyName,
    const FRenameReplayCallback& Deleg...
)

Used to change the friendly name of a replay.

Public function

void

 

RequestEventData

(
    const FString& ReplayName,
    const FString& EventID,
    const int32 UserIndex,
    const FRequestEventDataCallback& D...
)

Public function

void

 

RequestEventData

(
    const FString& ReplayName,
    const FString& EventID,
    const FRequestEventDataCallback& D...
)

Public function

void

 

RequestEventData

(
    const FString& EventID,
    const FRequestEventDataCallback& D...
)

Public function

void

 

RequestEventGroupData

(
    const FString& Group,
    const FRequestEventGroupDataCallbac...
)

Public function

void

 

RequestEventGroupData

(
    const FString& ReplayName,
    const FString& Group,
    const int32 UserIndex,
    const FRequestEventGroupDataCallbac...
)

Public function

void

 

RequestEventGroupData

(
    const FString& ReplayName,
    const FString& Group,
    const FRequestEventGroupDataCallbac...
)

Public function

void

 

SearchEvents

(
    const FString& EventGroup,
    const FSearchEventsCallback& Deleg...
)

Public function Virtual

void

 

SetAnalyticsProvider

(
    TSharedPtr< IAnalyticsProvider >& ...
)

Public function

EStreamingOp...

 

SetDemoPath

(
    const FString& DemoPath
)

Changes the base directory where Demos are stored.

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

 

StartStreaming

(
    const FStartStreamingParameters& P...,
    const FStartStreamingCallback& Del...
)

Public function

void

 

StopStreaming()

Public function

void

 

UpdatePlaybackTime

(
    uint32 TimeInMS
)

Public function

void

 

UpdateTotalDemoTime

(
    uint32 TimeInMS
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss