GameControllerBatteryChargingState 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.
Battery charging state of the controller.
public enum class GameControllerBatteryChargingState/// [Windows.Foundation.Metadata.ContractVersion(Windows.Gaming.Input.GamingInputPreviewContract, 131072)]
enum class GameControllerBatteryChargingState[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Gaming.Input.GamingInputPreviewContract), 131072)]
public enum GameControllerBatteryChargingStatevar value = Windows.Gaming.Input.Preview.GameControllerBatteryChargingState.unknownPublic Enum GameControllerBatteryChargingState- Inheritance
-
GameControllerBatteryChargingState
- 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 |
|---|---|---|
| Unknown | 0 | The battery charging state is unknown. |
| Inactive | 1 | The battery is not charging. |
| Active | 2 | The battery is charging. |
| Error | 3 | The controller has reported a charging error. |
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);
}