Navigation
API > API/Plugins > API/Plugins/RemoteControl
Remote control logger. Generated Log UI and collect logs from APIs and protocols
| Name | FRemoteControlLogger |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControl/Public/RemoteControlLogger.h |
| Include Path | #include "RemoteControlLogger.h" |
Syntax
class FRemoteControlLogger : public TSharedFromThis< FRemoteControlLogger >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FRemoteControlLogger
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRemoteControlLogger() |
RemoteControlLogger.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FRemoteControlLogger() |
RemoteControlLogger.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FLogCallback | TFunctionRef< FText(void)> | Callback for logging, it should return FText to log | RemoteControlLogger.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsEnabled | bool | Is the logger enabled | RemoteControlLogger.h | |
| MessageLogListing | TSharedPtr< IMessageLogListing > | Log listening interface | RemoteControlLogger.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearLog() |
Removes all messages from log | RemoteControlLogger.h | |
void EnableLog
(
const bool bEnable |
Enable/Disable the log for Remote Control | RemoteControlLogger.h | |
TSharedPtr< IMessageLogListing > GetMessageLogListing() |
Log listening interface | RemoteControlLogger.h | |
bool IsEnabled() |
Return the current state of the log | RemoteControlLogger.h | |
void Log
(
const FName& InputType, |
Log the message | RemoteControlLogger.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FRemoteControlLogger & Get() |
Get singleton logger instance | RemoteControlLogger.h |