Headset Headset Headset Headset Class

Definition

Contains information about an audio headset attached to a gamepad.

public : sealed class Headset : IGameControllerBatteryInfo, IHeadsetpublic sealed class Headset : IGameControllerBatteryInfo, IHeadsetPublic NotInheritable Class Headset Implements IGameControllerBatteryInfo, IHeadset// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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.

Properties

CaptureDeviceId CaptureDeviceId CaptureDeviceId CaptureDeviceId

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

public : PlatForm::String CaptureDeviceId { get; }public string CaptureDeviceId { get; }Public ReadOnly Property CaptureDeviceId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

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

RenderDeviceId RenderDeviceId RenderDeviceId RenderDeviceId

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

public : PlatForm::String RenderDeviceId { get; }public string RenderDeviceId { get; }Public ReadOnly Property RenderDeviceId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

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

Methods

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

Gets information about the headset's current battery state.

public : BatteryReport TryGetBatteryReport()public BatteryReport TryGetBatteryReport()Public Function TryGetBatteryReport() As BatteryReport// You can use this method in JavaScript.
Returns

Information about the headset's current battery state.

Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)