ITargetDevice

Interface for target devices.

Unreal Engine C++ API Reference > Developer > TargetPlatform > Interfaces

References

   
Module TargetPlatform
Header /Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITargetDevice.h
Include #include "Interfaces/ITargetDevice.h"

Syntax

class ITargetDevice  

Remarks

Interface for target devices.

Destructors

Type Name Description
  ~ITargetDevice () Virtual destructor.

Functions

Type Name Description
void CloseConnection ( ITargetDeviceSocketPtr Socket ) Closes a previously opened connection with a process on the target.
bool Connect () Connect to the physical device.
ITargetDevic... CreateDeviceOutputRouter ( FOutputDevice* Output ) Create device output router
void Disconnect () Disconnect from the physical device.
void ExecuteConsoleCommand ( const FString& ExecCommand ) Execute console command on the device
FName GetAllDevicesDefaultVariant () Get the "All devices" default variant
FString GetAllDevicesName () Get the "All devices" name
ETargetDevic... GetDeviceConnectionType () Gets the device connection type.
ETargetDevic... GetDeviceType () Gets the device type.
FTargetDevic... GetId () Gets the unique device identifier.
FString GetModelId () Gets the device model identifier.
FString GetName () Gets the name of the device.
FString GetOperatingSystemName () Gets the name of the operating system running on this device.
FString GetOSVersion () Gets the device OS Version.
int32 GetProcessSnapshot ( TArray< FTargetDeviceProcessInfo > ... ) Creates a snapshot of processes currently running on the device.
bool GetProcessSnapshotAsync ( TFunction< void(const TArray< FTarg... ) Creates a snapshot of processes currently running on the device.
const ITarge... GetTargetPlatform () Gets the TargetPlatform that this device belongs to.
bool GetUserCredentials ( FString& OutUserName, FString& OutUserPassword ) Get credentials for the user account to use on the device
bool IsAuthorized () Checks whether this device is authorized to be used with this computer.
bool IsConnected () Checks whether this device is connected.
bool IsDefault () Checks whether this is the default device.
bool IsPlatformAggregated () Get the "All devices" flag for the platform
bool IsProtocolAvailable ( uint32 ProtocolIndex ) Checks if connections using the given ProtocolIndex are available for this device at the moment.
ITargetDevic... OpenConnection ( uint32 ProtocolIndex ) Opens a direct connection with the device allowing data exchange with a process running on the target.
bool PowerOff ( bool Force ) Powers off the device.
bool PowerOn () Powers on the device.
bool Reboot ( bool bReconnect ) Reboot the device.
void ReloadGlobalShadersMap ( const FString& GlobalShaderMapDire... ) Execute console command on the device to reload the global shader map
void SetUserCredentials ( const FString& UserName, const FString& UserPassword ) Set credentials for the user account to use on the device
bool SupportsFeature ( ETargetDeviceFeatures Feature ) Checks whether the target device supports the specified feature.
bool TerminateLaunchedProcess ( const FString& ProcessIdentifier ) Cancel the application running on the device
bool TerminateProcess ( const int64 ProcessId ) Terminates a process that was launched on the device using the Launch() or Run() methods.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library