ITargetDeviceService

Interface for target device services.

Windows
MacOS
Linux

References

Module

TargetDeviceServices

Header

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

Include

#include "ITargetDeviceService.h"

Syntax

class ITargetDeviceService

Remarks

Interface for target device services.

Device services make locally connected or discovered network target devices available over the network. Remote clients communicate with device services through a target device proxy.

Destructors

Name Description

Public function Virtual

~ITargetDeviceService()

Virtual destructor.

Functions

Name Description

Public function

void

 

AddTargetDevice

Adds a flavor to this device.

Public function Const

bool

 

CanStart

(
    FName InFlavor
)

Checks whether this service can start.

Public function

const FStrin...

 

GetClaimHost()

Gets the name of the host that has a claim on the device.

Public function

const FStrin...

 

GetClaimUser()

Gets the name of the user that has a claim on the device.

Public function Const

TSharedPtr< ...

 

GetDevice

(
    FName InFlavor
)

Gets the target device for the supplied flavor, if no flavor is specified then the default device flavor is returned.

Public function Const

FString

 

GetDeviceName()

Gets the name of the device that this service exposes.

Public function Const

FString

 

GetDevicePlatformDisplayName()

Gets the display name of the platform of device that this service exposes.

Public function Const

FName

 

GetDevicePlatformName()

Gets the name of the platform of device that this service exposes.

Public function Const

bool

 

IsRunning()

Checks whether the service is currently running.

Public function Const

bool

 

IsShared()

Checks whether the device is being shared with other users.

Public function

int32

 

NumTargetDevices()

Gets number of target devices.

Public function

void

 

RemoveTargetDevice

Removes a flavor from this device.

Public function

void

 

SetShared

(
    bool InShared
)

Sets whether the device should be shared with other users.

Public function

bool

 

Start()

Starts the service.

Public function

void

 

Stop()

Stops the service.

See Also

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