ITargetDevice

Interface for target devices.

Windows
MacOS
Linux

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

Name Description

Public function Virtual

~ITargetDevice()

Virtual destructor.

Functions

Name Description

Public function

bool

 

Connect()

Connect to the physical device.

Public function Virtual Const

ITargetDevic...

 

CreateDeviceOutputRouter

(
    FOutputDevice* Output
)

Create device output router

Public function

bool

 

Deploy

(
    const FString& SourceFolder,
    FString& OutAppId
)

Deploys an application in the specified folder to the device.

Public function

void

 

Disconnect()

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

 

GetAllDevicesDefaultVariant()

Get the "All devices" default variant

Public function Virtual Const

FString

 

GetAllDevicesName()

Get the "All devices" name

Public function Const

ETargetDevic...

 

GetDeviceType()

Gets the device type.

Public function Const

FTargetDevic...

 

GetId()

Gets the unique device identifier.

Public function Const

FString

 

GetName()

Gets the name of the device.

Public function

FString

 

GetOperatingSystemName()

Gets the name of the operating system running on this device.

Public function

int32

 

GetProcessSnapshot

(
    TArray< FTargetDeviceProcessInfo > ...
)

Creates a snapshot of processes currently running on the device.

Public function Virtual

bool

 

GetProcessSnapshotAsync

(
    TFunction< void< FTarg...
)

Creates a snapshot of processes currently running on the device.

Public function Const

const ITarge...

 

GetTargetPlatform()

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

 

IsAuthorized()

Checks whether this device is authorized to be used with this computer.

Public function

bool

 

IsConnected()

Checks whether this device is connected.

Public function Const

bool

 

IsDefault()

Checks whether this is the default device.

Public function Virtual Const

bool

 

IsPlatformAggregated()

Get the "All devices" flag for the platform

Public function

bool

 

Launch

(
    const FString& AppId,
    EBuildConfiguration BuildConfigurat...,
    EBuildTargetType TargetType,
    const FString& Params,
    uint32* OutProcessId
)

Launches a previously deployed build.

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

bool

 

Run

(
    const FString& ExecutablePath,
    const FString& Params,
    uint32* OutProcessId
)

Runs an executable on the device.

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

 

SupportsFeature

(
    ETargetDeviceFeatures Feature
)

Checks whether the target device supports the specified feature.

Public function Const

bool

 

SupportsSdkVersion

(
    const FString& VersionString
)

Checks whether this device supports the specified SDK version.

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.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss