GipGameControllerProvider
GipGameControllerProvider
GipGameControllerProvider
GipGameControllerProvider
Class
Definition
Represents a physical game controller connected to the system using GIP.SYS (for Xbox One accesories).
public : sealed class GipGameControllerProvider : IGameControllerProvider, IGipGameControllerProviderpublic sealed class GipGameControllerProvider : IGameControllerProvider, IGipGameControllerProviderPublic NotInheritable Class GipGameControllerProvider Implements IGameControllerProvider, IGipGameControllerProvider// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Properties
FirmwareVersionInfo FirmwareVersionInfo FirmwareVersionInfo FirmwareVersionInfo
The firmware version of the controller.
public : GameControllerVersionInfo FirmwareVersionInfo { get; }public GameControllerVersionInfo FirmwareVersionInfo { get; }Public ReadOnly Property FirmwareVersionInfo As GameControllerVersionInfo// You can use this property in JavaScript.
- Value
- GameControllerVersionInfo GameControllerVersionInfo GameControllerVersionInfo GameControllerVersionInfo
The firmware version of the controller.
HardwareProductId HardwareProductId HardwareProductId HardwareProductId
The hardware product ID of the controller.
public : ushort HardwareProductId { get; }public ushort HardwareProductId { get; }Public ReadOnly Property HardwareProductId As ushort// You can use this property in JavaScript.
- Value
- ushort ushort ushort ushort
The hardware product ID of the controller.
HardwareVendorId HardwareVendorId HardwareVendorId HardwareVendorId
The hardware vendor ID of the controller.
public : ushort HardwareVendorId { get; }public ushort HardwareVendorId { get; }Public ReadOnly Property HardwareVendorId As ushort// You can use this property in JavaScript.
- Value
- ushort ushort ushort ushort
The hardware vendor ID of the controller.
HardwareVersionInfo HardwareVersionInfo HardwareVersionInfo HardwareVersionInfo
Contains information on the hardware version of the controller.
public : GameControllerVersionInfo HardwareVersionInfo { get; }public GameControllerVersionInfo HardwareVersionInfo { get; }Public ReadOnly Property HardwareVersionInfo As GameControllerVersionInfo// You can use this property in JavaScript.
- Value
- GameControllerVersionInfo GameControllerVersionInfo GameControllerVersionInfo GameControllerVersionInfo
Contains information on the hardware version of the controller.
IsConnected IsConnected IsConnected IsConnected
Boolean value indicating whether the controller is connected.
public : PlatForm::Boolean IsConnected { get; }public bool IsConnected { get; }Public ReadOnly Property IsConnected As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
Boolean value indicating whether the controller is connected.
Methods
SendMessage(GipMessageClass, Byte, Byte[]) SendMessage(GipMessageClass, Byte, Byte[]) SendMessage(GipMessageClass, Byte, Byte[]) SendMessage(GipMessageClass, Byte, Byte[])
Sends a message.
public : void SendMessage(GipMessageClass messageClass, Byte messageId, Byte[] messageBuffer)public void SendMessage(GipMessageClass messageClass, Byte messageId, Byte[] messageBuffer)Public Function SendMessage(messageClass As GipMessageClass, messageId As Byte, messageBuffer As Byte[]) As void// You can use this method in JavaScript.
- messageClass
- GipMessageClass GipMessageClass GipMessageClass GipMessageClass
The class of the message.
- messageId
- Byte Byte Byte Byte
The ID of the message.
- messageBuffer
- Byte[] Byte[] Byte[] Byte[]
A buffer holding the message contents.
SendReceiveMessage(GipMessageClass, Byte, Byte[], Byte[]) SendReceiveMessage(GipMessageClass, Byte, Byte[], Byte[]) SendReceiveMessage(GipMessageClass, Byte, Byte[], Byte[]) SendReceiveMessage(GipMessageClass, Byte, Byte[], Byte[])
Sends a request for a message.
public : void SendReceiveMessage(GipMessageClass messageClass, Byte messageId, Byte[] requestMessageBuffer, Byte[] responseMessageBuffer)public void SendReceiveMessage(GipMessageClass messageClass, Byte messageId, Byte[] requestMessageBuffer, Byte[] responseMessageBuffer)Public Function SendReceiveMessage(messageClass As GipMessageClass, messageId As Byte, requestMessageBuffer As Byte[], responseMessageBuffer As Byte[]) As void// You can use this method in JavaScript.
- messageClass
- GipMessageClass GipMessageClass GipMessageClass GipMessageClass
The class of the message.
- messageId
- Byte Byte Byte Byte
The ID of the message.
- requestMessageBuffer
- Byte[] Byte[] Byte[] Byte[]
A buffer containing the request.
- responseMessageBuffer
- Byte[] Byte[] Byte[] Byte[]
A buffer that will contain the request response.
UpdateFirmwareAsync(IInputStream) UpdateFirmwareAsync(IInputStream) UpdateFirmwareAsync(IInputStream) UpdateFirmwareAsync(IInputStream)
Attempts to asynchronously update the firmware for the controller.
public : IAsyncOperationWithProgress<GipFirmwareUpdateResult, GipFirmwareUpdateProgress> UpdateFirmwareAsync(IInputStream firmwareImage)public IAsyncOperationWithProgress<GipFirmwareUpdateResult, GipFirmwareUpdateProgress> UpdateFirmwareAsync(IInputStream firmwareImage)Public Function UpdateFirmwareAsync(firmwareImage As IInputStream) As IAsyncOperationWithProgress( Of GipFirmwareUpdateResult, GipFirmwareUpdateProgress )// You can use this method in JavaScript.
- firmwareImage
- IInputStream IInputStream IInputStream IInputStream
A stream pointing to the firmware image with which to update the controller.
Returns the result of the asynchronous operation.