LampArrayBlinkEffect LampArrayBlinkEffect LampArrayBlinkEffect LampArrayBlinkEffect LampArrayBlinkEffect Class

Definition

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

public : sealed class LampArrayBlinkEffect : ILampArrayEffect
struct winrt::Windows::Devices::Lights::Effects::LampArrayBlinkEffect : ILampArrayEffect
public sealed class LampArrayBlinkEffect : ILampArrayEffect
Public NotInheritable Class LampArrayBlinkEffect Implements ILampArrayEffect
var lampArrayBlinkEffect = new lampArrayBlinkEffect(lampArray, lampIndexes);
Attributes

Windows 10 requirements

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

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[]) LampArrayBlinkEffect(LampArray, Int32[]) LampArrayBlinkEffect(LampArray, Int32[]) LampArrayBlinkEffect(LampArray, Int32[]) LampArrayBlinkEffect(LampArray, Int32[])

Creates and initializes a new instance of the effect.

Properties

AttackDuration AttackDuration AttackDuration AttackDuration AttackDuration

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

Color Color Color Color Color

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

DecayDuration DecayDuration DecayDuration DecayDuration DecayDuration

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

Occurrences Occurrences Occurrences Occurrences Occurrences

Number of occurrences this effect will play.

RepetitionDelay RepetitionDelay RepetitionDelay RepetitionDelay RepetitionDelay

Gets or sets the delay between effect repetitions.

RepetitionMode RepetitionMode RepetitionMode RepetitionMode RepetitionMode

Gets or sets the repetition behavior of the effect.

StartDelay StartDelay StartDelay StartDelay StartDelay

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

SustainDuration SustainDuration SustainDuration SustainDuration SustainDuration

Gets or sets the time spent displaying peak intensity for the effect.

ZIndex ZIndex ZIndex ZIndex ZIndex

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