LampArrayEffectPlaylist Class

  • Reference

Definition

Namespace:
Windows.Devices.Lights.Effects
Edit

Used to either chain multiple effects together, or to start effects simultaneously.

public ref class LampArrayEffectPlaylist sealed : IIterable<ILampArrayEffect ^>, IVectorView<ILampArrayEffect ^>
/// [Windows.Foundation.Metadata.Activatable(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 LampArrayEffectPlaylist final : IIterable<ILampArrayEffect>, IVectorView<ILampArrayEffect>
[Windows.Foundation.Metadata.Activatable(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 LampArrayEffectPlaylist : IEnumerable<ILampArrayEffect>, IReadOnlyList<ILampArrayEffect>
function LampArrayEffectPlaylist()
Public NotInheritable Class LampArrayEffectPlaylist
Implements IEnumerable(Of ILampArrayEffect), IReadOnlyList(Of ILampArrayEffect)
Inheritance
Object Platform::Object IInspectable LampArrayEffectPlaylist
Attributes
ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute
Implements
IIterable<T> IEnumerable<T> IIterable<ILampArrayEffect> IEnumerable<ILampArrayEffect> IVectorView<ILampArrayEffect> IReadOnlyList<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).

Constructors

LampArrayEffectPlaylist()

Creates and initializes a new instance of a playlist.

Properties

EffectStartMode

Gets or sets the starting behavior for the effects.
Occurrences

Gets or sets the number of occurrences that this playlist will play.
RepetitionMode

Gets or sets the repetition behavior for playlist.
Size

Gets the size of (the number of elements in) the playlist.

Methods

Append(ILampArrayEffect)

Appends the effect to the end of the playlist.
First()

Retrieves an iterator representing the first item in a lamp array effect playlist.
GetAt(UInt32)

Retrieves the lamp array effect at the specified index within a playlist.
GetMany(UInt32, ILampArrayEffect[])

Retrieves a range of lamp array effects, beginning at the specified index within a playlist.
IndexOf(ILampArrayEffect, UInt32)

Retrieves the index, within a playlist, of the specified lamp array effect.
OverrideZIndex(Int32)

Overrides the zIndex for all contained effects.
Pause()

Pauses the playlist, and persists the last state set by the internally playing effect.
PauseAll(IIterable<LampArrayEffectPlaylist>)

Guarantees that all playlists will pause at the same time.
Start()

Starts this playlist from the beginning, unless it was previously paused, which will then resuming playing from the paused position.
StartAll(IIterable<LampArrayEffectPlaylist>)

Guarantees that all playlists will start at the same time.
Stop()

Stops playing this playlist.
StopAll(IIterable<LampArrayEffectPlaylist>)

Guarantees that all playlists will stop at the same time.

Applies to

See also