1. Epic GamesDeveloper
  3. UStormSyncNotificationSubsystem

UStormSyncNotificationSubsystem

This subsystem main purpose is to listen for tcp related events triggered from StormSyncTransport layers and module, to provide in-editor integration and handle UI/UX feedback to the end user.

API > API/Plugins > API/Plugins/StormSyncEditor

This subsystem main purpose is to listen for tcp related events triggered from StormSyncTransport layers and module, to provide in-editor integration and handle UI/UX feedback to the end user.

   
Name UStormSyncNotificationSubsystem
Type class
Header File /Engine/Plugins/VirtualProduction/StormSync/Source/StormSyncEditor/Public/Subsystems/StormSyncNotificationSubsystem.h
Include Path #include "Subsystems/StormSyncNotificationSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class UStormSyncNotificationSubsystem : public UEditorSubsystem

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
LogName const TCHAR * The name of the message output log we will send messages to Subsystems/StormSyncNotificationSubsystem.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
MessageLog TUniquePtr< FMessageLog > Unique ptr to our message log Subsystems/StormSyncNotificationSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< SNotificationItem > AddSimpleNotification ( const FText& InNotificationText
)

   Subsystems/StormSyncNotificationSubsystem.h  

TSharedPtr< SNotificationItem > AddSimpleNotification ( const FNotificationInfo& InInfo
)

   Subsystems/StormSyncNotificationSubsystem.h  

void Error ( const FText& InMessageLogText
)

   Subsystems/StormSyncNotificationSubsystem.h  

void HandlePullResponse ( const TSharedPtr< FStormSyncTransportPullResponse >& InResponse
)

   Subsystems/StormSyncNotificationSubsystem.h  

void HandlePushResponse ( const TSharedPtr< FStormSyncTransportPushResponse >& InResponse
)

   Subsystems/StormSyncNotificationSubsystem.h  

void HandleSyncResponse ( const TSharedPtr< FStormSyncTransportSyncResponse >& InResponse,
const FText& InSuccessTextFormat,
const FText& InErrorTextFormat
)

   Subsystems/StormSyncNotificationSubsystem.h  

void Info ( const FText& InMessageLogText
)

   Subsystems/StormSyncNotificationSubsystem.h  

void NewPage ( const FText& InLabel,
const bool bInAppendDateTime
)

   Subsystems/StormSyncNotificationSubsystem.h  

void Notify ( const EMessageSeverity::Type InSeverity,
const FText& InMessageLogText,
const bool bInForce
)

   Subsystems/StormSyncNotificationSubsystem.h  

void Warning ( const FText& InMessageLogText
)

   Subsystems/StormSyncNotificationSubsystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void AddProgressBarNotification ( const FString& InRemoteAddress,
const FString& InRemoteHostName
)

 Called on OnPreStartSendingBuffer(), creates and display a new notification widget, displaying current status of buffer upload. Subsystems/StormSyncNotificationSubsystem.h  

virtual void Deinitialize()

   Subsystems/StormSyncNotificationSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& InCollection
)

   Subsystems/StormSyncNotificationSubsystem.h  

virtual void OnDismissButtonClicked ( const FString InRemoteAddress
)

 Dismiss button click handler Subsystems/StormSyncNotificationSubsystem.h  

void OnPreStartSendingBuffer ( const FString& InRemoteAddress,
const FString& InRemoteHostname,
int32 InFileCount
)

 Callback handler for FStormSyncCoreDelegates::OnPreStartSendingBuffer delegate Subsystems/StormSyncNotificationSubsystem.h  

void OnReceivingBytes ( const FString& InRemoteAddress,
int32 InBytesCount
)

 Callback handler for FStormSyncCoreDelegates::OnPreStartSendingBuffer delegate Subsystems/StormSyncNotificationSubsystem.h  

void OnStartSendingBuffer ( const FString& InRemoteAddress,
int32 InBufferSize
)

 Callback handler for FStormSyncCoreDelegates::OnStartSendingBuffer delegate Subsystems/StormSyncNotificationSubsystem.h  

virtual void UpdateProgressBarNotificationOnIncomingBytes ( const FString& InRemoteAddress,
const int32 InReceivedBytes
)

 Called from OnReceivingBytes() and updates notification widget with received bytes count Subsystems/StormSyncNotificationSubsystem.h  

virtual void UpdateProgressBarNotificationOnStart ( const FString& InRemoteAddress,
const int32 InBufferSize
)

 Called from OnStartSendingBuffer() right before sending the stream. Subsystems/StormSyncNotificationSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers
Static convenience method to return storm sync notification subsystem Subsystems/StormSyncNotificationSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page