HeadsetOperation Enum

Reference

Definition

Namespace:: Windows.Gaming.Input.Preview

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.

Edit

Settings that can be read from or written to a headset that supports them.

public enum class HeadsetOperation

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Gaming.Input.GamingInputPreviewContract, 131072)]
enum class HeadsetOperation

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Gaming.Input.GamingInputPreviewContract), 131072)]
public enum HeadsetOperation

var value = Windows.Gaming.Input.Preview.HeadsetOperation.geq

Public Enum HeadsetOperation

Inheritance: Enum
HeadsetOperation

Attributes: ContractVersionAttribute

Windows requirements

Device family	Windows Desktop Extension SDK (introduced in 10.0.23665.0)
API contract	Windows.Gaming.Input.GamingInputPreviewContract (introduced in v2.0)

Fields

BassBoostGain	1	Controls bass boost. The buffer must be a little-endian 4-byte signed integer between 0 and 12 decibels inclusive.
Geq	0	Controls the equalizer. Buffers must be a byte array with the same layout as the HeadsetGeqGains struct.
MuteLedBrightness	4	Controls the mute LED brightness. The buffer must be an unsigned 1-byte integer set to HeadsetLevel.Low, HeadsetLevel.Medium, or HeadsetLevel.High.
SideTone	3	Controls the side tone feature. The buffer must be an unsigned 1-byte integer set to one of the values of the HeadsetLevel enum.
SmartMute	2	Controls the smart mute feature. The buffer must be an unsigned 1-byte integer set to one of the values of the HeadsetLevel enum.
SwapMixAndVolumeDials	5	Controls whether the mix and volume dials are in-place or swapped. The buffer must be a one-byte boolean, false if the dials are in-place and true if they are swapped.

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);
}

Remarks

Caution

To avoid damaging devices, the headset control APIs should only be used with hardware you have developed.

Applies to