Navigation
API > API/Developer > API/Developer/TargetPlatform
Interface for target devices.
| Name | ITargetDevice |
| Type | class |
| Header File | /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h |
| Include Path | #include "Interfaces/ITargetDevice.h" |
Syntax
class ITargetDevice
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ITargetDevice() |
Virtual destructor. | Interfaces/ITargetDevice.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CloseConnection
(
ITargetDeviceSocketPtr Socket |
Closes a previously opened connection with a process on the target. | Interfaces/ITargetDevice.h | |
bool Connect() |
Connect to the physical device. | Interfaces/ITargetDevice.h | |
virtual ITargetDeviceOutputPtr CreateDeviceOutputRouter
(
FOutputDevice* Output |
Create device output router | Interfaces/ITargetDevice.h | |
void Disconnect() |
Disconnect from the physical device. | Interfaces/ITargetDevice.h | |
virtual void ExecuteConsoleCommand
(
const FString& ExecCommand |
Execute console command on the device | Interfaces/ITargetDevice.h | |
virtual FName GetAllDevicesDefaultVariant() |
Get the "All devices" default variant | Interfaces/ITargetDevice.h | |
virtual FString GetAllDevicesName() |
Get the "All devices" name | Interfaces/ITargetDevice.h | |
virtual FStringView GetArchitecture() |
Gets the device architecture. | Interfaces/ITargetDevice.h | |
virtual ETargetDeviceConnectionTypes GetDeviceConnectionType() |
Gets the device connection type. | Interfaces/ITargetDevice.h | |
ETargetDeviceTypes GetDeviceType() |
Gets the device type. | Interfaces/ITargetDevice.h | |
| Gets the unique device identifier. | Interfaces/ITargetDevice.h | ||
virtual FString GetModelId() |
Gets the device model identifier. | Interfaces/ITargetDevice.h | |
FString GetName () |
Gets the name of the device. | Interfaces/ITargetDevice.h | |
FString GetOperatingSystemName() |
Gets the name of the operating system running on this device. | Interfaces/ITargetDevice.h | |
virtual FString GetOSVersion() |
Gets the device OS Version. | Interfaces/ITargetDevice.h | |
virtual const ITargetPlatformControls & GetPlatformControls() |
Interfaces/ITargetDevice.h | ||
virtual const ITargetPlatformSettings & GetPlatformSettings() |
Interfaces/ITargetDevice.h | ||
int32 GetProcessSnapshot
(
TArray< FTargetDeviceProcessInfo >& OutProcessInfos |
Creates a snapshot of processes currently running on the device. | Interfaces/ITargetDevice.h | |
virtual bool GetProcessSnapshotAsync
(
TFunction< void(const TArray< FTargetDeviceProcessInfo >&)> CompleteHandler |
Creates a snapshot of processes currently running on the device. | Interfaces/ITargetDevice.h | |
bool GetUserCredentials
(
FString& OutUserName, |
Get credentials for the user account to use on the device | Interfaces/ITargetDevice.h | |
virtual bool IsAuthorized () |
Checks whether this device is authorized to be used with this computer. | Interfaces/ITargetDevice.h | |
bool IsConnected() |
Checks whether this device is connected. | Interfaces/ITargetDevice.h | |
bool IsDefault () |
Checks whether this is the default device. | Interfaces/ITargetDevice.h | |
virtual bool IsPlatformAggregated() |
Get the "All devices" flag for the platform | Interfaces/ITargetDevice.h | |
virtual bool IsProtocolAvailable
(
uint32 ProtocolIndex |
Checks if connections using the given ProtocolIndex are available for this device at the moment. | Interfaces/ITargetDevice.h | |
virtual ITargetDeviceSocketPtr OpenConnection
(
uint32 ProtocolIndex |
Opens a direct connection with the device allowing data exchange with a process running on the target. | Interfaces/ITargetDevice.h | |
bool PowerOff
(
bool Force |
Powers off the device. | Interfaces/ITargetDevice.h | |
bool PowerOn() |
Powers on the device. | Interfaces/ITargetDevice.h | |
bool Reboot
(
bool bReconnect |
Reboot the device. | Interfaces/ITargetDevice.h | |
virtual void ReloadGlobalShadersMap
(
const FString& GlobalShaderMapDirectory |
Execute console command on the device to reload the global shader map | Interfaces/ITargetDevice.h | |
void SetUserCredentials
(
const FString& UserName, |
Set credentials for the user account to use on the device | Interfaces/ITargetDevice.h | |
bool SupportsFeature
(
ETargetDeviceFeatures Feature |
Checks whether the target device supports the specified feature. | Interfaces/ITargetDevice.h | |
virtual bool TerminateLaunchedProcess
(
const FString& ProcessIdentifier |
Cancel the application running on the device | Interfaces/ITargetDevice.h | |
bool TerminateProcess
(
const int64 ProcessId |
Terminates a process that was launched on the device using the Launch() or Run() methods. | Interfaces/ITargetDevice.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const ITargetPlatform & GetTargetPlatform () |
Temporary until we get rid of this. | Interfaces/ITargetDevice.h |