Interface IGameDevice

Aruba's generic Game Device Interface. Similar to Phoenix's IDevice, but with additional fields.

Namespace: Microsoft.Internal.Studios.Aruba.Infrastructure

Assembly: Aruba.Infrastructure.dll

Syntax

public interface IGameDevice

Properties

Alias

Gets or sets a user defined alias for the device.

Declaration

string Alias { get; set; }

Property Value

Type	Description
string

AttachedObjectModel

Gets or sets the game object model that is attached to this device.

Declaration

object AttachedObjectModel { get; set; }

Property Value

Type	Description
object

Configuration

Gets or sets the configuration string for this device.

Declaration

string Configuration { get; set; }

Property Value

Type	Description
string

DeviceImplementation

Gets the underlying device implementation.

Declaration

object DeviceImplementation { get; }

Property Value

Type	Description
object

DeviceTypeName

Gets the name of the device type.

Declaration

string DeviceTypeName { get; }

Property Value

Type	Description
string

DisplayName

Gets the display name for UI and logging. This is the Name if valid or the IPAddress.

Declaration

string DisplayName { get; }

Property Value

Type	Description
string

DisplayPrefix

Gets or sets the display prefix to be used in the UI. Ex. PC, XB

Declaration

string DisplayPrefix { get; set; }

Property Value

Type	Description
string

IPAddress

Gets the IPAddress of this device.

Declaration

IPAddress IPAddress { get; }

Property Value

Type	Description
IPAddress

Id

Gets the unique identifier of the device.

Declaration

string Id { get; }

Property Value

Type	Description
string

InfoString

Gets the info string to be displayed in the UI. Essentially a tool tip.

Declaration

string InfoString { get; }

Property Value

Type	Description
string

Name

Gets or sets the name of this device.

Declaration

string Name { get; set; }

Property Value

Type	Description
string

XboxLiveDeviceId

Gets a value representing the XBL device ID.

Declaration

string XboxLiveDeviceId { get; }

Property Value

Type	Description
string

Methods

Cleanup()

Performs device cleanup

Declaration

void Cleanup()