GameControllerBatteryLevel 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.
The amount of battery remaining in the controller.
public enum class GameControllerBatteryLevel/// [Windows.Foundation.Metadata.ContractVersion(Windows.Gaming.Input.GamingInputPreviewContract, 131072)]
enum class GameControllerBatteryLevel[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Gaming.Input.GamingInputPreviewContract), 131072)]
public enum GameControllerBatteryLevelvar value = Windows.Gaming.Input.Preview.GameControllerBatteryLevel.unknownPublic Enum GameControllerBatteryLevel- Inheritance
-
GameControllerBatteryLevel
- 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 level is unknown. |
| Critical | 1 | The battery level is very low. |
| Low | 2 | The battery level is low. |
| Medium | 3 | The battery is partly charged. |
| Full | 4 | The battery is fully charged. |
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);
}