DeviceCommand Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Commands that can be executed on a GIP (Gaming Input Protocol) headset.
public enum class DeviceCommand/// [Windows.Foundation.Metadata.ContractVersion(Windows.Gaming.Input.GamingInputPreviewContract, 131072)]
enum class DeviceCommand[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Gaming.Input.GamingInputPreviewContract), 131072)]
public enum DeviceCommandvar value = Windows.Gaming.Input.Preview.DeviceCommand.resetPublic Enum DeviceCommand- Inheritance
-
DeviceCommand
- Attributes
Windows requirements
| Requirements | Description |
|---|---|
| Device family |
Windows Desktop Extension SDK (introduced in 10.0.23665.0)
|
| API contract |
Windows.Gaming.Input.GamingInputPreviewContract (introduced in v2.0)
|
Fields
| Name | Value | Description |
|---|---|---|
| Reset | 0 | Resets the headset. |
Examples
public void SetupHeadset(IGameControllerProvider headsetProvider)
{
LegacyGipGameControllerProvider legacyGipGameControllerProvider =
LegacyGipGameControllerProvider.FromGameControllerProvider(headsetProvider);
// Reset the device
legacyGipGameControllerProvider.ExecuteCommand(DeviceCommand.Reset);
// Check the smart mute level
byte[] smartMuteBuffer =
legacyGipGameControllerProvider.GetHeadsetOperation(HeadsetOperation.SmartMute);
HeadsetLevel smartMuteValue = (HeadsetLevel)smartMuteBuffer[0];
// Set bass boost to 3db
byte[] bassBuffer = BitConverter.GetBytes((UInt32)3);
legacyGipGameControllerProvider.SetHeadsetOperation(HeadsetOperation.BassBoostGain,
bassBuffer);
}
Remarks
Caution
To avoid damaging devices, the headset control APIs should only be used with hardware you have developed.