NetworkReplayStreaming.h File Reference

#include "AnalyticsEventAttribute.h"
#include "Containers/Array.h"
#include "Containers/Set.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "Delegates/Delegate.h"
#include "HAL/Platform.h"
#include "Misc/CoreMisc.h"
#include "Misc/DateTime.h"
#include "Misc/NetworkVersion.h"
#include "Modules/ModuleInterface.h"
#include "Modules/ModuleManager.h"
#include "Net/Core/Connection/NetResult.h"
#include "Net/Core/Connection/NetResultManager.h"
#include "Serialization/JsonSerializerMacros.h"
#include "Templates/PimplPtr.h"
#include "Templates/SharedPointer.h"
#include "UObject/NameTypes.h"

Go to the source code of this file.

Classes
class	FReplayEventListItem
class	FReplayEventList
struct	FNetworkReplayStreamInfo
struct	FStreamingResultBase
struct	FStartStreamingResult
struct	FReplayCheckpointInfo
	Information about a checkpoint that was loaded as a result of a Goto Request. More...
struct	FGotoResult
struct	FDeleteFinishedStreamResult
struct	FEnumerateStreamsResult
struct	FEnumerateEventsResult
struct	FRequestEventDataResult
struct	FRequestEventGroupDataResult
struct	FDownloadHeaderResult
struct	FSearchEventsResult
struct	FKeepReplayResult
struct	FRenameReplayResult
struct	FStartStreamingParameters
class	INetworkReplayStreamer
class	INetworkReplayStreamingFactory
class	FNetworkReplayStreaming

Namespaces
namespace	ENetworkReplayError

Enumerations
enum class	EStreamingOperationResult {   Success , Unsupported , ReplayNotFound , ReplayCorrupt ,   NotEnoughSpace , NotEnoughSlots , Unspecified , UnfinishedTask ,   EventNotFound , DecryptFailure }
enum class	EReplayCheckpointType : uint8 { Full , Delta }
enum class	EReplayStreamerState : uint8 { Idle , Recording , Playback }

Functions
enum	ENetworkReplayError::UE_DEPRECATED (5.1, "No longer used") Type
PRAGMA_DISABLE_DEPRECATION_WARNINGS const TCHAR *	ENetworkReplayError::ToString (const ENetworkReplayError::Type FailureType)
	DECLARE_DELEGATE_TwoParams (FOnStreamReadyDelegate, const bool, const bool)
	DECLARE_DELEGATE_TwoParams (FOnCheckpointReadyDelegate, const bool, const int64)
	DECLARE_DELEGATE_OneParam (FOnDeleteFinishedStreamComplete, const bool)
	DECLARE_DELEGATE_OneParam (FOnEnumerateStreamsComplete, const TArray< FNetworkReplayStreamInfo > &)
	DECLARE_DELEGATE_TwoParams (FEnumerateEventsCompleteDelegate, const FReplayEventList &, bool)
	DECLARE_DELEGATE_TwoParams (FOnRequestEventDataComplete, const TArray< uint8 > &, bool) DECLARE_DELEGATE_OneParam(FOnDownloadHeaderComplete
	DECLARE_DELEGATE_OneParam (FStartStreamingCallback, const FStartStreamingResult &)
	DECLARE_DELEGATE_OneParam (FGotoCallback, const FGotoResult &)
	DECLARE_DELEGATE_OneParam (FDeleteFinishedStreamCallback, const FDeleteFinishedStreamResult &)
	DECLARE_DELEGATE_OneParam (FEnumerateStreamsCallback, const FEnumerateStreamsResult &)
	DECLARE_DELEGATE_OneParam (FEnumerateEventsCallback, const FEnumerateEventsResult &)
	DECLARE_DELEGATE_OneParam (FRequestEventDataCallback, const FRequestEventDataResult &)
	DECLARE_DELEGATE_OneParam (FRequestEventGroupDataCallback, const FRequestEventGroupDataResult &)
	DECLARE_DELEGATE_OneParam (FDownloadHeaderCallback, const FDownloadHeaderResult &)
	DECLARE_DELEGATE_OneParam (FSearchEventsCallback, const FSearchEventsResult &)
	DECLARE_DELEGATE_OneParam (FKeepReplayCallback, const FKeepReplayResult &)
	DECLARE_DELEGATE_OneParam (FRenameReplayCallback, const FRenameReplayResult &)
FString NETWORKREPLAYSTREAMING_API	LexToString (const EReplayStreamerState State)
	DECLARE_MULTICAST_DELEGATE_TwoParams (FOnReplayGetAnalyticsAttributes, const class INetworkReplayStreamer *, TArray< FAnalyticsEventAttribute > &)

Variables
const	bool

Enumeration Type Documentation

EReplayCheckpointType

enum class EReplayCheckpointType : uint8

strong

End KeepReplay Types

Enumerator
Full
Delta

EReplayStreamerState

enum class EReplayStreamerState : uint8

strong

Enumerator
Idle
Recording
Playback

EStreamingOperationResult

enum class EStreamingOperationResult

strong

Below are all available new style delegate declarations for the INetworkReplayStreamer interface.

All delegates should be named in the form F<MethodName>Callback. All delegates should have an associated Result type. All delegates should take one, and only one, argument which will be a const reference to the appropriate Result type.

All result types should be named in the form F<MethodName>Result. All result types should inherit from FStreamingResultBase. All result types should be default constructible to a sensible error state, with OperationResult = Unspecified.

FGotoCallback and FGotoResult are used for GotoCheckpointIndex and GotoTimeInMS, as they perform logically similar operations. EnumerateRecentStreams uses the same delegate and result types as EnumerateStreams. Possible results for replay commands.

Enumerator
Success
Unsupported	The operation succeeded.
ReplayNotFound	The operation is not supported by the current streamer.
ReplayCorrupt	The requested replay was not found.
NotEnoughSpace	The requested replay was found but was corrupt.
NotEnoughSlots	The operation failed due to insufficient storage space.
Unspecified	The operation failed due to reaching a predefined replay limit.
UnfinishedTask	The operation failed for unspecified reasons.
EventNotFound	The operation failed due to an outstanding task.
DecryptFailure	The operation failed because the event could not be found.

Function Documentation

DECLARE_DELEGATE_OneParam() [1/13]

DECLARE_DELEGATE_OneParam	(	FDeleteFinishedStreamCallback	,
		const FDeleteFinishedStreamResult &
	)

DECLARE_DELEGATE_OneParam() [2/13]

DECLARE_DELEGATE_OneParam	(	FDownloadHeaderCallback	,
		const FDownloadHeaderResult &
	)

DECLARE_DELEGATE_OneParam() [3/13]

DECLARE_DELEGATE_OneParam	(	FEnumerateEventsCallback	,
		const FEnumerateEventsResult &
	)

DECLARE_DELEGATE_OneParam() [4/13]

DECLARE_DELEGATE_OneParam	(	FEnumerateStreamsCallback	,
		const FEnumerateStreamsResult &
	)

DECLARE_DELEGATE_OneParam() [5/13]

DECLARE_DELEGATE_OneParam	(	FGotoCallback	,
		const FGotoResult &
	)

DECLARE_DELEGATE_OneParam() [6/13]

DECLARE_DELEGATE_OneParam	(	FKeepReplayCallback	,
		const FKeepReplayResult &
	)

DECLARE_DELEGATE_OneParam() [7/13]

DECLARE_DELEGATE_OneParam	(	FOnDeleteFinishedStreamComplete	,
		const bool
	)

Delegate called when DeleteFinishedStream() completes.

Parameters

bWasSuccessful

Whether the stream was deleted.

DECLARE_DELEGATE_OneParam() [8/13]

DECLARE_DELEGATE_OneParam	(	FOnEnumerateStreamsComplete	,
		const TArray< FNetworkReplayStreamInfo > &
	)

Delegate called when EnumerateStreams() completes.

Parameters

Streams

An array containing information about the streams that were found.

DECLARE_DELEGATE_OneParam() [9/13]

DECLARE_DELEGATE_OneParam	(	FRenameReplayCallback	,
		const FRenameReplayResult &
	)

DECLARE_DELEGATE_OneParam() [10/13]

DECLARE_DELEGATE_OneParam	(	FRequestEventDataCallback	,
		const FRequestEventDataResult &
	)

DECLARE_DELEGATE_OneParam() [11/13]

DECLARE_DELEGATE_OneParam	(	FRequestEventGroupDataCallback	,
		const FRequestEventGroupDataResult &
	)

DECLARE_DELEGATE_OneParam() [12/13]

DECLARE_DELEGATE_OneParam	(	FSearchEventsCallback	,
		const FSearchEventsResult &
	)

DECLARE_DELEGATE_OneParam() [13/13]

DECLARE_DELEGATE_OneParam	(	FStartStreamingCallback	,
		const FStartStreamingResult &
	)

DECLARE_DELEGATE_TwoParams() [1/4]

DECLARE_DELEGATE_TwoParams	(	FEnumerateEventsCompleteDelegate	,
		const FReplayEventList &	,
		bool
	)

Delegate called when EnumerateEvents() completes.

Parameters

ReplayEventList

A list of events that were found

@param bWasSuccessful Whether enumerating events was successful

DECLARE_DELEGATE_TwoParams() [2/4]

DECLARE_DELEGATE_TwoParams	(	FOnCheckpointReadyDelegate	,
		const bool	,
		const int64
	)

Delegate called when GotoCheckpointIndex() completes.

Parameters

bWasSuccessful

Whether streaming was started.

DECLARE_DELEGATE_TwoParams() [3/4]

DECLARE_DELEGATE_TwoParams	(	FOnRequestEventDataComplete	,
		const TArray< uint8 > &	,
		bool
	)

Delegate called when RequestEventData() completes.

Parameters

ReplayEventListItem

A replay event with its data parameter filled in

@param bWasSuccessful Whether enumerating events was successful

Delegate called when DownloadHeader() completes.

Parameters

bWasSuccessful

Whether the header was successfully downloaded.

DECLARE_DELEGATE_TwoParams() [4/4]

DECLARE_DELEGATE_TwoParams	(	FOnStreamReadyDelegate	,
		const bool	,
		const bool
	)

Delegate called when StartStreaming() completes.

Parameters

bWasSuccessful	Whether streaming was started.
bRecord	Whether streaming is recording or not (vs playing)

DECLARE_MULTICAST_DELEGATE_TwoParams()

DECLARE_MULTICAST_DELEGATE_TwoParams	(	FOnReplayGetAnalyticsAttributes	,
		const class INetworkReplayStreamer *	,
		TArray< FAnalyticsEventAttribute > &
	)

LexToString()

FString NETWORKREPLAYSTREAMING_API LexToString

(

const EReplayStreamerState

State

)

Variable Documentation

bool

const bool