ITargetDeviceProxy

Interface for target device proxies.

Windows
MacOS
Linux

References

Module

TargetDeviceServices

Header

/Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxy.h

Include

#include "ITargetDeviceProxy.h"

Syntax

class ITargetDeviceProxy

Remarks

Interface for target device proxies.

Destructors

Name Description

Public function Virtual

~ITargetDeviceProxy()

Virtual destructor.

Functions

Name Description

Public function Const

const bool

 

CanMultiLaunch()

Checks whether the device can launch multiple games or applications simultaneously.

Public function Const

bool

 

CanPowerOff()

Checks whether this device can be powered off remotely.

Public function Const

bool

 

CanPowerOn()

Checks whether this device can be powered on remotely.

Public function Const

bool

 

CanReboot()

Checks whether this device can be rebooted remotely.

Public function Const

bool

 

CanSupportVariants()

Checks whether this device's target platform supports variants.

Public function

bool

 

DeployApp

(
    FName InVariant,
    const TMap< FString, FString >& Fi...,
    const FGuid& TransactionId
)

Deploys the specified list of files to the device.

Public function Const

const FStrin...

 

GetDeviceUser()

Gets the name of the (device's) user that is logged in on a device.

Public function Const

const FStrin...

 

GetDeviceUserPassword()

Gets the password of the (device's) user that is logged in on a device.

Public function Const

const FStrin...

 

GetHostName()

Gets the name of the host machine that claimed the device.

Public function Const

const FStrin...

 

GetHostUser()

Gets the name of the user that claimed the device.

Public function Const

const FStrin...

 

GetMake()

Gets the device make (i.e. Apple or Sony).

Public function Const

const FStrin...

 

GetModel()

Gets the device model (i.e. PS3 or XBox).

Public function Const

const FStrin...

 

GetName()

Gets the name of the device (i.e. network name or IP address).

Public function Const

int32

 

GetNumVariants()

Gets the number of variants this device supports

Public function Const

FText

 

GetPlatformDisplayName

(
    FName InVariant
)

Gets the Vanilla platform of the device variant.

Public function Const

const FStrin...

 

GetTargetDeviceId

(
    FName InVariant
)

Gets the identifier of the device.

Public function Const

const TSet< ...

 

GetTargetDeviceIds

(
    FName InVariant
)

Gets a list of device identifiers for an aggregate (Alldevices_on_) proxy

Public function Const

FName

 

GetTargetDeviceVariant

(
    const FString& InDeviceId
)

Gets the variant name of the target device.

Public function Const

FName

 

GetTargetPlatformId

(
    FName InVariant
)

Gets the target platform of the device variant.

Public function Const

FString

 

GetTargetPlatformName

(
    FName InVariant
)

Gets the target platform of the device variant.

Public function Const

const FStrin...

 

GetType()

Gets the device type (i.e. Console, PC or Mobile).

Public function Const

FName

 

GetVanillaPlatformId

(
    FName InVariant
)

Gets the Vanilla platform of the device variant.

Public function Const

int32

 

GetVariants

(
    TArray< FName >& OutVariants
)

Gets the list of variants this device supports

Public function Const

bool

 

HasDeviceId

(
    const FString& InDeviceId
)

Checks whether this device proxy contains a variant for the provided target device.

Public function Const

bool

 

HasTargetPlatform

(
    FName InTargetPlatformId
)

Checks whether this device proxy contains a variant for the provided platform.

Public function Const

bool

 

HasVariant

(
    FName InVariant
)

Checks whether this device proxy contains a variant

Public function Virtual Const

bool

 

IsAggregated()

Checks if this is an aggregate (Alldevices_on_) proxy.

Public function Const

bool

 

IsAuthorized()

Checks whether the device is authorized.

Public function Const

bool

 

IsConnected()

Checks whether the device is currently connected.

Public function Const

bool

 

IsShared()

Checks whether this device is being shared with other users.

Public function

bool

 

LaunchApp

(
    FName InVariant,
    const FString& AppId,
    EBuildConfiguration BuildConfigurat...,
    const FString& Params
)

Launches a previously deployed build on the target device.

Public function

FOnTargetDev...

 

OnDeployCommitted()

Returns a delegate to be invoked when a build has been deployed to the target device.

Public function

FOnTargetDev...

 

OnDeployFailed()

Returns a delegate to be invoked when a build failed to deploy to the target device.

Public function

FOnTargetDev...

 

OnLaunchFailed()

Returns a delegate to be invoked when a build failed to launch on the target device.

Public function

void

 

PowerOff

(
    bool Force
)

Powers off the device.

Public function

void

 

PowerOn()

Powers on the device.

Public function

void

 

Reboot()

Reboots the device.

Public function

void

 

Run

(
    FName InVariant,
    const FString& ExecutablePath,
    const FString& Params
)

Attempts to run an executable on the device.

Public function

bool

 

TerminateLaunchedProcess

(
    FName InVariant,
    const FString& ProcessIdentifier
)

Cancel the application running on the device

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss