Navigation
API > API/Runtime > API/Runtime/TraceBasedDebuggersAnalysis
| Name | FRecordingControls |
| Type | struct |
| Header File | /Engine/Source/Runtime/Experimental/TraceBasedDebuggersAnalysis/Public/Widgets/RecordingControls.h |
| Include Path | #include "Widgets/RecordingControls.h" |
Syntax
struct FRecordingControls : public TSharedFromThis< FRecordingControls >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FRecordingControls
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRecordingControls
(
const FName InStatusBarId, |
Widgets/RecordingControls.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRecordingControls() |
Widgets/RecordingControls.h |
Structs
| Name | Remarks |
|---|---|
| FAsyncConnectionAttemptTask |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BaseRecordingOptionsMenuName | const FName | Parent menu plugins can extend to add entries to all debugger options menus. | Widgets/RecordingControls.h |
| DefaultNumberOfConnectionRetries | int32 | Widgets/RecordingControls.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnRecordingStarted | FOnSessionEvent | Delegate executed when recording got started in a given session | Widgets/RecordingControls.h | |
| OnRecordingStopped | FOnSessionEvent | Delegate executed when recording got stopped in a given session | Widgets/RecordingControls.h | |
| OnSessionSelected | FOnSessionEvent | Delegate executed when a given session got selected | Widgets/RecordingControls.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bInitialized | bool | Widgets/RecordingControls.h | ||
| bRecordingButtonHovered | bool | Widgets/RecordingControls.h | ||
| CurrentSelectedSessionId | FGuid | Widgets/RecordingControls.h | ||
| InFlightAsyncConnectionRequests | TMap< FGuid, TSharedPtr< FAsyncConnectionAttemptTask > > | Widgets/RecordingControls.h | ||
| IntervalBetweenAutoplayConnectionAttemptsSeconds | float | Widgets/RecordingControls.h | ||
| LiveSessionEndedMessageHandle | FStatusBarMessageHandle | Widgets/RecordingControls.h | ||
| RecordingAnimation | FCurveSequence | Widgets/RecordingControls.h | ||
| RecordingMessageHandle | FStatusBarMessageHandle | Widgets/RecordingControls.h | ||
| RecordingPathMessageHandle | FStatusBarMessageHandle | Widgets/RecordingControls.h | ||
| RecordingStartedHandle | FDelegateHandle | Widgets/RecordingControls.h | ||
| RecordingStoppedHandle | FDelegateHandle | Widgets/RecordingControls.h | ||
| StatusBarID | const FName | Widgets/RecordingControls.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddToMenu
(
FName ExistingMenu |
Widgets/RecordingControls.h | ||
void Deinitialize() |
Widgets/RecordingControls.h | ||
TSharedPtr< FSessionInfo > GetCurrentSessionInfo() |
Return the details about the currently selected session | Widgets/RecordingControls.h | |
void Initialize() |
Widgets/RecordingControls.h |
Public Virtual
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TNotNull< TUniquePtr< FStartRecordingCommandMessage > > BuildStartRecordingParamsInternal () |
Derived classes must override this method to provide the specific message type required to start recording That type must inherit from FStartRecordingCommandMessage. | Widgets/RecordingControls.h | |
void CloseSessionByRemoteSessionIDInternal
(
const FGuid& InSessionId |
Widgets/RecordingControls.h | ||
bool ConnectToLiveSession_DirectInternal
(
const FGuid& InSessionId |
Widgets/RecordingControls.h | ||
bool ConnectToLiveSession_RelayInternal
(
const FGuid& InSessionId |
Widgets/RecordingControls.h | ||
TSharedRef< SWidget > GenerateTargetSessionDropdown() |
Widgets/RecordingControls.h | ||
const FTraceSessionDescriptor & GetCurrentSessionDescriptorInternal() |
Widgets/RecordingControls.h | ||
FSlateIcon GetIconForSession
(
FGuid SessionId |
Widgets/RecordingControls.h | ||
FString GetSaveDirPath() |
Widgets/RecordingControls.h | ||
ETraceTransportMode GetTransportMode
(
EBuildTargetType InBuildTarget |
Widgets/RecordingControls.h | ||
bool IsRecording() |
Widgets/RecordingControls.h | ||
bool IsRecordingPossibleForSession
(
const TSharedPtr< FSessionInfo >& InSessionInfo |
Widgets/RecordingControls.h | ||
bool IsRecordingToggleButtonEnabled() |
Widgets/RecordingControls.h | ||
void OnToggleRecordingStateInternal
(
const TSharedRef< FSessionInfo >& InSessionInfo |
Widgets/RecordingControls.h | ||
void SelectTargetSession
(
FGuid SessionId |
Widgets/RecordingControls.h | ||
void SendStartRecordingCommandInternal
(
const FMessageAddress& InAddress, |
Widgets/RecordingControls.h | ||
void SendStopRecordingCommandInternal
(
const FMessageAddress& InAddress |
Widgets/RecordingControls.h | ||
void SetSessionRecordingState
(
bool bIsRecording, |
Widgets/RecordingControls.h | ||
| Widgets/RecordingControls.h | |||
void ToggleRecordingState
(
const TSharedPtr< FSessionInfo >& InSessionInfo |
Widgets/RecordingControls.h | ||
void ToggleSingleSessionRecordingState
(
const TSharedRef< FSessionInfo >& InSessionInfo |
Widgets/RecordingControls.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddToMenuInternal
(
FToolMenuSection& InSection |
Widgets/RecordingControls.h | ||
virtual TSharedRef< SWidget > GenerateTargetSessionSelector() |
Widgets/RecordingControls.h | ||
virtual FRecordingControlsConfig GetControlsConfig () |
Override to opt in to the options combo button and toolbar-style entries. | Widgets/RecordingControls.h | |
virtual int32 GetMaxConnectionRetriesInternal() |
Widgets/RecordingControls.h | ||
virtual ETraceTransportMode GetTransportModeOverrideForTargetTypeInternal
(
EBuildTargetType InBuildTarget |
Widgets/RecordingControls.h | ||
virtual bool IsRecordingAvailableForSessionInternal
(
const TSharedRef< FSessionInfo >& InSessionInfo |
Widgets/RecordingControls.h | ||
virtual void OnGenerateTargetSessionSelectorInternal
(
FMenuBuilder& InMenuBuilder |
Widgets/RecordingControls.h | ||
virtual bool ShouldFilterOutSessionInternal
(
const TSharedRef< FSessionInfo >& InSessionInfo |
Widgets/RecordingControls.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static EVisibility IsRecordingToggleButtonVisible() |
Widgets/RecordingControls.h | ||
static TSharedPtr< SNotificationItem > PushConnectionAttemptNotification
(
const FNotificationInfo& InNotificationInfo |
Widgets/RecordingControls.h | ||
static void UpdateConnectionAttemptNotification
(
const TSharedPtr< SNotificationItem >& InNotification, |
Widgets/RecordingControls.h |