ArcadeStick ArcadeStick ArcadeStick ArcadeStick ArcadeStick Class

Definition

Represents an arcade stick.

public : sealed class ArcadeStick : IGameController, IGameControllerBatteryInfo
struct winrt::Windows::Gaming::Input::ArcadeStick : IGameController, IGameControllerBatteryInfo
public sealed class ArcadeStick : IGameController, IGameControllerBatteryInfo
Public NotInheritable Class ArcadeStick Implements IGameController, IGameControllerBatteryInfo
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

Instances of the ArcadeStick class cannot be created directly; instead, instances of the class are retrieved through the ArcadeStick.ArcadeSticks property listing all connected arcade sticks or through the ArcadeStick.ArcadeStickAdded event. See Arcade stick for more information about how to use the ArcadeStick class.

Supported Devices

ArcadeStick supports any Xbox One-certified or Xbox 360-compatible arcade stick.

Version history

Windows version SDK version Value added
1703 15063 FromGameController
1703 15063 TryGetBatteryReport

Properties

ArcadeSticks ArcadeSticks ArcadeSticks ArcadeSticks ArcadeSticks

The list of all connected arcade sticks.

Headset Headset Headset Headset Headset

The audio headset attached to the arcade stick.

IsWireless IsWireless IsWireless IsWireless IsWireless

Gets a value that indicates the wireless state of the arcade stick.

User User User User User

The user associated with the arcade stick.

Methods

FromGameController(IGameController) FromGameController(IGameController) FromGameController(IGameController) FromGameController(IGameController) FromGameController(IGameController)

Returns the given game controller as an arcade stick.

GetButtonLabel(ArcadeStickButtons) GetButtonLabel(ArcadeStickButtons) GetButtonLabel(ArcadeStickButtons) GetButtonLabel(ArcadeStickButtons) GetButtonLabel(ArcadeStickButtons)

Retrieves the button label for the specified button.

GetCurrentReading() GetCurrentReading() GetCurrentReading() GetCurrentReading() GetCurrentReading()

Gets a snapshot of the arcade stick state.

TryGetBatteryReport() TryGetBatteryReport() TryGetBatteryReport() TryGetBatteryReport() TryGetBatteryReport()

Gets information about the arcade stick's current battery state.

Events

ArcadeStickAdded ArcadeStickAdded ArcadeStickAdded ArcadeStickAdded ArcadeStickAdded

Signals when a new arcade stick is connected.

ArcadeStickRemoved ArcadeStickRemoved ArcadeStickRemoved ArcadeStickRemoved ArcadeStickRemoved

Signals when an arcade stick is disconnected.

HeadsetConnected HeadsetConnected HeadsetConnected HeadsetConnected HeadsetConnected

Signals when a headset is attached to the arcade stick.

HeadsetDisconnected HeadsetDisconnected HeadsetDisconnected HeadsetDisconnected HeadsetDisconnected

Signals when a headset is disconnected from the arcade stick.

UserChanged UserChanged UserChanged UserChanged UserChanged

Signals when the user associated with the arcade stick has changed.

See also