1. Epic GamesDeveloper
  3. ITargetDevice

ITargetDevice

Interface for target devices.

API > API/Developer > API/Developer/TargetPlatform > API/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
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function Virtual void Closes a previously opened connection with a process on the target.
Public function bool

Connect ()

 Connect to the physical device.
Public function Virtual Const ITargetDeviceOutputPtr Create device output router
Public function void Disconnect from the physical device.
Public function Virtual Const void

ExecuteConsoleCommand ( const FString& ExecCommand
)

 Execute console command on the device
Public function Virtual Const FName Get the "All devices" default variant
Public function Virtual Const FString Get the "All devices" name
Public function Virtual Const ETargetDeviceConnectionTypes Gets the device connection type.
Public function Const ETargetDeviceTypes Gets the device type.
Public function Const FTargetDeviceId

GetId ()

 Gets the unique device identifier.
Public function Virtual Const FString Gets the device model identifier.
Public function Const FString

GetName ()

 Gets the name of the device.
Public function FString Gets the name of the operating system running on this device.
Public function Virtual Const FString Gets the device OS Version.
Public function int32 Creates a snapshot of processes currently running on the device.
Public function Virtual bool

GetProcessSnapshotAsync ( TFunction< void(const TArray< FTargetDeviceProcessInfo >&)> CompleteHandler
)

 Creates a snapshot of processes currently running on the device.
Public function Const const ITargetPlatform & Gets the TargetPlatform that this device belongs to.
Public function bool

GetUserCredentials ( FString& OutUserName,
FString& OutUserPassword
)

 Get credentials for the user account to use on the device
Public function Virtual Const bool Checks whether this device is authorized to be used with this computer.
Public function bool Checks whether this device is connected.
Public function Const bool Checks whether this is the default device.
Public function Virtual Const bool Get the "All devices" flag for the platform
Public function Virtual Const bool

IsProtocolAvailable ( uint32 ProtocolIndex
)

 Checks if connections using the given ProtocolIndex are available for this device at the moment.
Public function Virtual ITargetDeviceSocketPtr

OpenConnection ( uint32 ProtocolIndex
)

 Opens a direct connection with the device allowing data exchange with a process running on the target.
Public function bool

PowerOff ( bool Force
)

 Powers off the device.
Public function bool

PowerOn ()

 Powers on the device.
Public function bool

Reboot ( bool bReconnect
)

 Reboot the device.
Public function Virtual Const void

ReloadGlobalShadersMap ( const FString& GlobalShaderMapDirectory
)

 Execute console command on the device to reload the global shader map
Public function void

SetUserCredentials ( const FString& UserName,
const FString& UserPassword
)

 Set credentials for the user account to use on the device
Public function Const bool Checks whether the target device supports the specified feature.
Public function Virtual bool

TerminateLaunchedProcess ( const FString& ProcessIdentifier
)

 Cancel the application running on the device
Public function 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

On this page