Interface IChromaLink

Interface for Chroma Link functionality.

Inherited Members

IDevice.ClearAsync()

IDevice.SetAllAsync(Color)

IDevice.SetEffectAsync(Guid)

IDevice.CurrentEffectId

Namespace: Colore

Assembly: Colore.dll

Syntax

public interface IChromaLink : IDevice

Properties

Item[Int32]

Gets or sets the Color for a specific zone on the Chroma Link device. The SDK will translate this appropriately depending on user configuration.

Declaration

Color this[int index] { get; set; }

Parameters

Type	Name	Description
Int32	index	The zone to access.

Property Value

Type	Description
Color	The color currently set for the specified key.

Methods

IsSet(Int32)

Returns whether an element has had a custom color set.

Declaration

bool IsSet(int index)

Parameters

Type	Name	Description
Int32	index	The index to query.

Returns

Type	Description
Boolean	true if the position has a color set that is not black, otherwise false.

SetCustomAsync(CustomChromaLinkEffect)

Sets a CustomChromaLinkEffect effect on the Chroma Link.

Declaration

Task<Guid> SetCustomAsync(CustomChromaLinkEffect effect)

Parameters

Type	Name	Description
CustomChromaLinkEffect	effect	An instance of the CustomChromaLinkEffect struct.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.

SetEffectAsync(ChromaLinkEffectType)

Sets an effect without any parameters.

Declaration

Task<Guid> SetEffectAsync(ChromaLinkEffectType effectType)

Parameters

Type	Name	Description
ChromaLinkEffectType	effectType	Effect options.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.

SetStaticAsync(Color)

Sets a StaticChromaLinkEffect effect on the Chroma Link.

Declaration

Task<Guid> SetStaticAsync(Color color)

Parameters

Type	Name	Description
Color	color	Color of the effect.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.

SetStaticAsync(StaticChromaLinkEffect)

Sets a StaticChromaLinkEffect effect on the Chroma Link.

Declaration

Task<Guid> SetStaticAsync(StaticChromaLinkEffect effect)

Parameters

Type	Name	Description
StaticChromaLinkEffect	effect	An instance of the StaticChromaLinkEffect struct.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.