Interface IHeadset
Interface for headset functionality.
Inherited Members
Namespace: Colore
Assembly: Colore.dll
Syntax
public interface IHeadset : IDeviceProperties
Item[Int32]
Gets or sets the color of a specific LED on the headset.
Declaration
Color this[int index] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | index | The index to access. |
Property Value
| Type | Description |
|---|---|
| Color | The current Color at the |
Methods
SetCustomAsync(CustomHeadsetEffect)
Sets a new CustomHeadsetEffect effect on the headset.
Declaration
Task<Guid> SetCustomAsync(CustomHeadsetEffect effect)Parameters
| Type | Name | Description |
|---|---|---|
| CustomHeadsetEffect | effect | An instance of the CustomHeadsetEffect struct describing the effect. |
Returns
| Type | Description |
|---|---|
| Task<Guid> | A Guid for the effect that was set. |
SetEffectAsync(HeadsetEffectType)
Sets an effect on the headset that doesn't take any parameters, currently only valid for the None effect.
Declaration
Task<Guid> SetEffectAsync(HeadsetEffectType effectType)Parameters
| Type | Name | Description |
|---|---|---|
| HeadsetEffectType | effectType | The type of effect to set. |
Returns
| Type | Description |
|---|---|
| Task<Guid> | A Guid for the effect that was set. |
SetStaticAsync(Color)
Sets a new StaticHeadsetEffect effect on the headset using the specified Color.
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(StaticHeadsetEffect)
Sets a new static effect on the headset.
Declaration
Task<Guid> SetStaticAsync(StaticHeadsetEffect effect)Parameters
| Type | Name | Description |
|---|---|---|
| StaticHeadsetEffect | effect | An instance of the StaticHeadsetEffect struct describing the effect. |
Returns
| Type | Description |
|---|---|
| Task<Guid> | A Guid for the effect that was set. |