Dela via


Headset Class

Definition

Contains information about an audio headset attached to a gamepad.

public ref class Headset sealed
public ref class Headset sealed : IGameControllerBatteryInfo
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Headset final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Headset final : IGameControllerBatteryInfo
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class Headset
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class Headset : IGameControllerBatteryInfo
Public NotInheritable Class Headset
Public NotInheritable Class Headset
Implements IGameControllerBatteryInfo
Inheritance
Object Platform::Object IInspectable Headset
Attributes
Implements

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Instances of the Headset class cannot be created directly; instead, instances of the Headset class are retrieved through the Gamepad.Headset property or the Gamepad.HeadsetConnected event.

Version history

Windows version SDK version Value added
1703 15063 TryGetBatteryReport

Properties

CaptureDeviceId

The XAudio endpoint ID for the headset's audio capture device.

RenderDeviceId

The XAudio enpoint ID for the headset's audio render device.

Methods

TryGetBatteryReport()

Gets information about the headset's current battery state.

Applies to