Share via

LampArrayKind Enum

  • Reference

Definition

Namespace:
Windows.Devices.Lights
Edit

The type of physical device the LampArray is part of.

public enum class LampArrayKind
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
enum class LampArrayKind
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
public enum LampArrayKind
var value = Windows.Devices.Lights.LampArrayKind.undefined
Public Enum LampArrayKind
Inheritance
Enum
LampArrayKind
Attributes
ContractVersionAttribute

Windows requirements

Device family
Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v7.0)

Fields

Name Value Description
Undefined 0

No Kind specified for this device.
Keyboard 1

Is part of a keyboard or keypad.
Mouse 2

Is part of a mouse.
GameController 3

Is part of a game controller (for example, gamepad, flightstick, sailing simulation device).
Peripheral 4

Is part of a more general peripheral/accessory (for example, speakers, mousepad, microphone, webcam).
Scene 5

Illuminates a room/performance-stage/area (for example, room light-bulbs, spotlights, washlights, strobelights, booth-strips, billboard/sign, camera-flash).
Notification 6

Is part of a notification device.
Chassis 7

Is part of an internal PC case component (for example, RAM-stick, motherboard, fan).
Wearable 8

Is embedded in a wearable accessory (for example, audio-headset, wristband, watch, shoes).
Furniture 9

Is embedded in a piece of furniture (for example, chair, desk, bookcase).
Art 10

Is embedded in an artwork (for example, painting or sculpture).
Headset 11

Is embedded in a wearable accessory designed specifically for the head (for example, headphones or microphones). This is a specialization of Wearable.
Microphone 12
Speaker 13

Examples

LampArray sample

Demonstrates how to control RGB lighting of peripheral devices using the Windows.Devices.Lights and Windows.Devices.Lights.Effects APIs.

AutoRGB Sample

Demonstrates how to extract a single, representative color from a desktop screen and use it to illuminate LED lamps on a connected RGB device.

Remarks

Avoid placing error checks that validate LampArrayKind within the current bounds, because this list might expand over time. Rather, compare against the subset of LampArrayKind that your application supports.

Applies to

See also