LampArray LampArray LampArray LampArray LampArray Class

Definition

Represents a LampArray device attached the system. Currently, only HID LampArrays are supported.

public : sealed class LampArray
struct winrt::Windows::Devices::Lights::LampArray
public sealed class LampArray
Public NotInheritable Class LampArray
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10, version 1809 (introduced v10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v7)

Remarks

LampArray devices have one or more lamp indexes (for example, lights/LEDs/bulbs, etc…) whose color state can be directly manipulated. Static information (retrieved from the device) describe supported colors, geometric positions and intended purposes for each lamp index.

These devices can be found as part of composite devices (for example, keyboard with RGB lighting) or as standalone.

An application can set lamp state at any time, but state will only be applied by the system while application is in focus.

LampArrays are enumerated by DeviceWatcher, and retrieved via FromIdAsync.

Properties

BoundingBox BoundingBox BoundingBox BoundingBox BoundingBox

Gets the logical bounding box encompassing the LampArray.

BrightnessLevel BrightnessLevel BrightnessLevel BrightnessLevel BrightnessLevel

Gets or sets the overall brightness of the LampArray, where 0.0 is completely off and 1.0 is maximum brightness.

Every lamp is scaled equally by the brightness.

DeviceId DeviceId DeviceId DeviceId DeviceId

Gets the plug and play (PnP) device identifier of the underlying LampArray device.

HardwareProductId HardwareProductId HardwareProductId HardwareProductId HardwareProductId

The hardware product Id of the underlying device.

HardwareVendorId HardwareVendorId HardwareVendorId HardwareVendorId HardwareVendorId

The hardware vendor Id of the underlying device.

HardwareVersion HardwareVersion HardwareVersion HardwareVersion HardwareVersion

The hardware version of the underlying device.

IsConnected IsConnected IsConnected IsConnected IsConnected

Gets a value indicating whether the LampArray device is connected to the system.

IsEnabled IsEnabled IsEnabled IsEnabled IsEnabled

Gets or sets the enabled state.

LampArrayKind LampArrayKind LampArrayKind LampArrayKind LampArrayKind

The LampArrayKind describing this device.

LampCount LampCount LampCount LampCount LampCount

The number of lamps part of this LampArray.

MinUpdateInterval MinUpdateInterval MinUpdateInterval MinUpdateInterval MinUpdateInterval

Minimal interval (required by the device) between the system sending two updates for any one lamp. This is comparable to the effective device refresh rate.

SupportsVirtualKeys SupportsVirtualKeys SupportsVirtualKeys SupportsVirtualKeys SupportsVirtualKeys

Boolean indicating whether any lamp is mapped to a virtual key.

Methods

FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String)

Retrieves a LampArray object asynchronously for the LampArray device that has the specified plug and play (PnP) device identifier/device instance path.

GetDeviceSelector() GetDeviceSelector() GetDeviceSelector() GetDeviceSelector() GetDeviceSelector()

Retrieves an Advanced Query Syntax (AQS) string encompassing all LampArray devices on the system.

GetIndicesForKey(VirtualKey) GetIndicesForKey(VirtualKey) GetIndicesForKey(VirtualKey) GetIndicesForKey(VirtualKey) GetIndicesForKey(VirtualKey)

Searches for all lamp indices that are bound to the specific VirtualKey

GetIndicesForPurposes(LampPurposes) GetIndicesForPurposes(LampPurposes) GetIndicesForPurposes(LampPurposes) GetIndicesForPurposes(LampPurposes) GetIndicesForPurposes(LampPurposes)

Searches for all lamp indices that are bound to the specified LampPurposes.

GetLampInfo(Int32) GetLampInfo(Int32) GetLampInfo(Int32) GetLampInfo(Int32) GetLampInfo(Int32)

Fetches the LampInfo corresponding to the lamp index.

RequestMessageAsync(Int32) RequestMessageAsync(Int32) RequestMessageAsync(Int32) RequestMessageAsync(Int32) RequestMessageAsync(Int32)

Asynchronously retrieves an IBuffer representing the message identified by the message identifer argument.

SendMessageAsync(Int32, IBuffer) SendMessageAsync(Int32, IBuffer) SendMessageAsync(Int32, IBuffer) SendMessageAsync(Int32, IBuffer) SendMessageAsync(Int32, IBuffer)

Asynchronously sends a message identified by the message identifer argument.

SetColor(Color) SetColor(Color) SetColor(Color) SetColor(Color) SetColor(Color)

Sets every lamp belonging to the LampArray to the desired color.

SetColorForIndex(Int32, Color) SetColorForIndex(Int32, Color) SetColorForIndex(Int32, Color) SetColorForIndex(Int32, Color) SetColorForIndex(Int32, Color)

Sets the lamp corresponding to the index to the desired color.

SetColorsForIndices(Color[], Int32[]) SetColorsForIndices(Color[], Int32[]) SetColorsForIndices(Color[], Int32[]) SetColorsForIndices(Color[], Int32[]) SetColorsForIndices(Color[], Int32[])

Sets the color for multiple lamps. Position within each array maps lamp index to desired color.

SetColorsForKey(Color, VirtualKey) SetColorsForKey(Color, VirtualKey) SetColorsForKey(Color, VirtualKey) SetColorsForKey(Color, VirtualKey) SetColorsForKey(Color, VirtualKey)

Sets the color for all lamps that map to the key. Multiple lamps can map to the same key.

SetColorsForKeys(Color[], VirtualKey[]) SetColorsForKeys(Color[], VirtualKey[]) SetColorsForKeys(Color[], VirtualKey[]) SetColorsForKeys(Color[], VirtualKey[]) SetColorsForKeys(Color[], VirtualKey[])

Sets the color of multiple lamps, corresponding to mapped keys. Position within each array maps keys to desired color.

SetColorsForPurposes(Color, LampPurposes) SetColorsForPurposes(Color, LampPurposes) SetColorsForPurposes(Color, LampPurposes) SetColorsForPurposes(Color, LampPurposes) SetColorsForPurposes(Color, LampPurposes)

Sets the color of multiple lamps, corresponding to LampPurposes.

SetSingleColorForIndices(Color, Int32[]) SetSingleColorForIndices(Color, Int32[]) SetSingleColorForIndices(Color, Int32[]) SetSingleColorForIndices(Color, Int32[]) SetSingleColorForIndices(Color, Int32[])

Sets all lamps specified to the same color.