ArcadeStick Class

Definition

Namespace:

Windows.Gaming.Input

Represents an arcade stick.

public ref class ArcadeStick sealed : IGameControllerBatteryInfo

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ArcadeStick final : IGameControllerBatteryInfo

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ArcadeStick : IGameControllerBatteryInfo

Public NotInheritable Class ArcadeStick
Implements IGameControllerBatteryInfo

Inheritance

Object Platform::Object IInspectable ArcadeStick

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

IGameController IGameControllerBatteryInfo

Windows requirements

Device family	Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v3.0)

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 GIP (Gaming Input Protocol) or XUSB arcade stick.

Version history

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

Properties

ArcadeSticks	The list of all connected arcade sticks.
Headset	The audio headset attached to the arcade stick.
IsWireless	Gets a value that indicates the wireless state of the arcade stick.
User	The user associated with the arcade stick.

Methods

FromGameController(IGameController)	Returns the given game controller as an arcade stick.
GetButtonLabel(ArcadeStickButtons)	Retrieves the button label for the specified button.
GetCurrentReading()	Gets a snapshot of the arcade stick state.
TryGetBatteryReport()	Gets information about the arcade stick's current battery state.

Events

ArcadeStickAdded	Signals when a new arcade stick is connected.
ArcadeStickRemoved	Signals when an arcade stick is disconnected.
HeadsetConnected	Signals when a headset is attached to the arcade stick.
HeadsetDisconnected	Signals when a headset is disconnected from the arcade stick.
UserChanged	Signals when the user associated with the arcade stick has changed.

See also

• IGameController
• Arcade stick
• Input practices for games