LampArraySolidEffect Class

  • Reference

Definition

Namespace:
Windows.Devices.Lights.Effects
Edit

Displays a solid/static color for a specific duration.

public ref class LampArraySolidEffect sealed : ILampArrayEffect
/// [Windows.Foundation.Metadata.Activatable(Windows.Devices.Lights.Effects.ILampArraySolidEffectFactory, 458752, "Windows.Foundation.UniversalApiContract")]
/// [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 LampArraySolidEffect final : ILampArrayEffect
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Devices.Lights.Effects.ILampArraySolidEffectFactory), 458752, "Windows.Foundation.UniversalApiContract")]
[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 LampArraySolidEffect : ILampArrayEffect
function LampArraySolidEffect(lampArray, lampIndexes)
Public NotInheritable Class LampArraySolidEffect
Implements ILampArrayEffect
Inheritance
Object Platform::Object IInspectable LampArraySolidEffect
Attributes
ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute
Implements
ILampArrayEffect

Windows requirements

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

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

Before you can play an effect, you must append it to a LampArrayEffectPlaylist (see Append).

All lamps within the effect behave identically, subject to constraints of the lamp indexes (for example, color channels). Best effort will always be done to accommodate lamp index constraints.

If a LampArray is bound to a LampArraySolidEffect and it disconnects, progress of the effect continues as a no-op. No exception/error is thrown/returned.

Constructors

LampArraySolidEffect(LampArray, Int32[])

Creates and initializes a new instance of the effect.

Properties

Color

Gets or sets the solid color of the effect.
CompletionBehavior

Gets or sets the behavior when effect completes.
Duration

Gets or sets the duration of the effect; StartDelay is not included.
StartDelay

Gets or sets the duration to delay before starting the effect.
ZIndex

Gets or sets the global precedence (across all playlists) for two effects that modify the same lamp (on the same LampArray).

Applies to

See also