LampArray クラス

定義

システムに接続されている LampArray デバイスを表します。 現在、 HID LampArrays のみがサポートされています。

public ref class LampArray sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 458752)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class LampArray final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 458752)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class LampArray
Public NotInheritable Class LampArray
継承
Object Platform::Object IInspectable LampArray
属性

Windows の要件

デバイス ファミリ
Windows 10, version 1809 (10.0.17763.0 で導入)
API contract
Windows.Foundation.UniversalApiContract (v7.0 で導入)

LampArray サンプル

Windows.Devices.Lights および Windows.Devices.Lights.Effects API を使用して周辺機器の RGB 照明を制御する方法を示します。

AutoRGB サンプル

デスクトップ画面から 1 つの代表的な色を抽出し、それを使用して、接続された RGB デバイス上の LED ランプを点灯させる方法を示します。

注釈

LampArray デバイスには、色の状態を直接操作できる 1 つ以上のランプ インデックス (ライト、LED、電球など) があります。 静的情報 (デバイスから取得) では、サポートされている色、幾何学的位置、各ランプ インデックスの目的について説明します。

これらのデバイスは、複合デバイス (RGB 照明付きのキーボードなど) の一部として、またはスタンドアロンとして見つけることができます。

アプリケーションは、いつでもランプの状態を設定できますが、状態は、アプリケーションがフォーカスされている間にのみシステムによって適用されます。

LampArrays は DeviceWatcher によって列挙され、 FromIdAsync を介して取得されます。

プロパティ

BoundingBox

LampArray を含む論理境界ボックスを取得します。

BrightnessLevel

LampArray の全体的な明るさを取得または設定します。0.0 は完全にオフ、1.0 は最大輝度です。

すべてのランプは明るさによって均等にスケーリングされます。

DeviceId

基になる LampArray デバイスのプラグ アンド プレイ (PnP) デバイス識別子を取得します。

HardwareProductId

基になるデバイスのハードウェア製品 ID。

HardwareVendorId

基になるデバイスのハードウェア ベンダー ID。

HardwareVersion

基になるデバイスのハードウェア バージョン。

IsAvailable

このプロセスで、ランプ配列が制御に使用できるかどうか、または使用できないかどうかを取得します。

IsConnected

LampArray デバイスがシステムに接続されているかどうかを示す値を取得します。

IsEnabled

有効な状態を取得または設定します。

LampArrayKind

ランプ配列デバイスの種類を取得します。

LampCount

この LampArray のランプ部分の数。

MinUpdateInterval

1 つのランプに対して 2 つの更新プログラムを送信するシステム間の最小間隔 (デバイスで必要)。 これは、有効なデバイス更新レートに相当します。

SupportsVirtualKeys

任意のランプが仮想キーにマップされているかどうかを示すブール値。

メソッド

FromIdAsync(String)

指定したプラグ アンド プレイ (PnP) デバイス識別子/デバイス インスタンス パスを持つ LampArray デバイスの LampArray オブジェクトを非同期的に取得します。

GetDeviceSelector()

システム上のすべての LampArray デバイスを含む高度なクエリ構文 (AQS) 文字列を取得します。

GetIndicesForKey(VirtualKey)

特定の VirtualKey にバインドされているすべてのランプ インデックスを検索します

GetIndicesForPurposes(LampPurposes)

指定した LampPurposes にバインドされているすべてのランプ インデックスを検索します。

GetLampInfo(Int32)

lamp インデックスに対応する LampInfo をフェッチします。

RequestMessageAsync(Int32)

メッセージ identifer 引数によって識別されるメッセージを表す IBuffer を非同期的に取得します。

SendMessageAsync(Int32, IBuffer)

message identifer 引数によって識別されるメッセージを非同期的に送信します。

SetColor(Color)

LampArray に属するすべてのランプを目的の色に設定します。

SetColorForIndex(Int32, Color)

インデックスに対応するランプを目的の色に設定します。

SetColorsForIndices(Color[], Int32[])

複数のランプの色を設定します。 各配列内の位置は、ランプインデックスを目的の色にマップします。

SetColorsForKey(Color, VirtualKey)

キーにマップされるすべてのランプの色を設定 します。 複数のランプを同じ キーにマップできます。

SetColorsForKeys(Color[], VirtualKey[])

マップされたキーに対応する複数のランプの色を設定 します。 各配列内の位置は 、キー を目的の色にマップします。

SetColorsForPurposes(Color, LampPurposes)

LampPurposes に対応する複数のランプの色を設定します。

SetSingleColorForIndices(Color, Int32[])

指定したすべてのランプを同じ色に設定します。

イベント

AvailabilityChanged

IsAvailable の値が変更されたときに発生します。これは、ユーザーがデバイス設定を使用してデバイスへのシステム アクセスを変更したときに発生する可能性があります。

イベント ハンドラーのパラメーターは、プロパティが変更された送信者 LampArrayObject (常に null) です。

適用対象

こちらもご覧ください