LampArrayBlinkEffect Class

  • Reference

Definition

Namespace:
Windows.Devices.Lights.Effects
Edit

Blinks lamp/s a color for a specific duration. Timing of attack/sustain/decay phases can be defined.

public ref class LampArrayBlinkEffect sealed : ILampArrayEffect
/// [Windows.Foundation.Metadata.Activatable(Windows.Devices.Lights.Effects.ILampArrayBlinkEffectFactory, 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 LampArrayBlinkEffect final : ILampArrayEffect
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Devices.Lights.Effects.ILampArrayBlinkEffectFactory), 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 LampArrayBlinkEffect : ILampArrayEffect
function LampArrayBlinkEffect(lampArray, lampIndexes)
Public NotInheritable Class LampArrayBlinkEffect
Implements ILampArrayEffect
Inheritance
Object Platform::Object IInspectable LampArrayBlinkEffect
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

Always starts from off/Black, attacks to a defined color, sustains at peak color intensity, then decays back to off/Black

Will always set the state of lamp/s to off/Black when effect completes, regardless of progress.

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

All lamps within the effect behave identically, subject to contraints 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 LampArrayBlinkEffect and it disconnects, progress of the effect continues as a no-op. No exception/error is thrown/returned.

Constructors

LampArrayBlinkEffect(LampArray, Int32[])

Creates and initializes a new instance of the effect.

Properties

AttackDuration

Gets or sets the time spent attacking/ramping-up from off/Black to peak intensity.
Color

Gets or sets the color of peak intensity for the effect. Duration color is visible defined by SustainDuration.
DecayDuration

Gets or sets the time spent decaying/ramping-down from peak intensity to off/Black.
Occurrences

Number of occurrences this effect will play.
RepetitionDelay

Gets or sets the delay between effect repetitions.
RepetitionMode

Gets or sets the repetition behavior of the effect.
StartDelay

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

Gets or sets the time spent displaying peak intensity for 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