Interface IChromaApi

Chroma API contract.

Namespace: Colore.Api

Assembly: Colore.dll

Syntax

public interface IChromaApi

Methods

CreateChromaLinkEffectAsync(ChromaLinkEffectType)

Creates a new Chroma Link effect without any effect data.

Declaration

Task<Guid> CreateChromaLinkEffectAsync(ChromaLinkEffectType effectType)

Parameters

Type	Name	Description
ChromaLinkEffectType	effectType	The type of effect to create.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

CreateChromaLinkEffectAsync<T>(ChromaLinkEffectType, T)

Creates a new Chroma Link effect with the specified effect data.

Declaration

Task<Guid> CreateChromaLinkEffectAsync<T>(ChromaLinkEffectType effectType, T data)
    where T : struct, ValueType

Parameters

Type	Name	Description
ChromaLinkEffectType	effectType	The type of effect to create.
T	data	Effect options struct.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

Type Parameters

Name	Description
T	The effect struct type.

CreateDeviceEffectAsync(Guid, EffectType)

Creates a new device effect without any effect data.

Declaration

Task<Guid> CreateDeviceEffectAsync(Guid deviceId, EffectType effectType)

Parameters

Type	Name	Description
Guid	deviceId	The ID of the device to create the effect for.
EffectType	effectType	The type of effect to create.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

CreateDeviceEffectAsync<T>(Guid, EffectType, T)

Creates a new device effect with the specified effect data.

Declaration

Task<Guid> CreateDeviceEffectAsync<T>(Guid deviceId, EffectType effectType, T data)
    where T : struct, ValueType

Parameters

Type	Name	Description
Guid	deviceId	The ID of the device to create the effect for.
EffectType	effectType	The type of effect to create.
T	data	The effect structure parameter.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

Type Parameters

Name	Description
T	The structure type, needs to be compatible with the effect type.

CreateHeadsetEffectAsync(HeadsetEffectType)

Creates a new headset effect without any effect data.

Declaration

Task<Guid> CreateHeadsetEffectAsync(HeadsetEffectType effectType)

Parameters

Type	Name	Description
HeadsetEffectType	effectType	The type of effect to create.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

CreateHeadsetEffectAsync<T>(HeadsetEffectType, T)

Creates a new headset effect with the specified effect data.

Declaration

Task<Guid> CreateHeadsetEffectAsync<T>(HeadsetEffectType effectType, T data)
    where T : struct, ValueType

Parameters

Type	Name	Description
HeadsetEffectType	effectType	The type of effect to create.
T	data	Effect options struct.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

Type Parameters

Name	Description
T	The effect struct type.

CreateKeyboardEffectAsync(KeyboardEffectType)

Creates a new keyboard effect without any effect data.

Declaration

Task<Guid> CreateKeyboardEffectAsync(KeyboardEffectType effectType)

Parameters

Type	Name	Description
KeyboardEffectType	effectType	The type of effect to create.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

CreateKeyboardEffectAsync<T>(KeyboardEffectType, T)

Creates a new keyboard effect with the specified effect data.

Declaration

Task<Guid> CreateKeyboardEffectAsync<T>(KeyboardEffectType effectType, T data)
    where T : struct, ValueType

Parameters

Type	Name	Description
KeyboardEffectType	effectType	The type of effect to create.
T	data	The effect structure parameter.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

Type Parameters

Name	Description
T	The structure type, needs to be compatible with the effect type.

CreateKeypadEffectAsync(KeypadEffectType)

Creates a new keypad effect without any effect data.

Declaration

Task<Guid> CreateKeypadEffectAsync(KeypadEffectType effectType)

Parameters

Type	Name	Description
KeypadEffectType	effectType	THe type of effect to create.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

CreateKeypadEffectAsync<T>(KeypadEffectType, T)

Creates a new keypad effect with the specified effect data.

Declaration

Task<Guid> CreateKeypadEffectAsync<T>(KeypadEffectType effectType, T data)
    where T : struct, ValueType

Parameters

Type	Name	Description
KeypadEffectType	effectType	The type of effect to create.
T	data	Effect options struct.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

Type Parameters

Name	Description
T	The effect struct type.

CreateMouseEffectAsync(MouseEffectType)

Creates a new mouse effect without any effect data.

Declaration

Task<Guid> CreateMouseEffectAsync(MouseEffectType effectType)

Parameters

Type	Name	Description
MouseEffectType	effectType	The type of effect to create.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

CreateMouseEffectAsync<T>(MouseEffectType, T)

Creates a new mouse effect with the specified effect data.

Declaration

Task<Guid> CreateMouseEffectAsync<T>(MouseEffectType effectType, T data)
    where T : struct, ValueType

Parameters

Type	Name	Description
MouseEffectType	effectType	The type of effect to create.
T	data	Effect options struct.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

Type Parameters

Name	Description
T	The effect struct type.

CreateMousepadEffectAsync(MousepadEffectType)

Creates a new mousepad effect without any effect data.

Declaration

Task<Guid> CreateMousepadEffectAsync(MousepadEffectType effectType)

Parameters

Type	Name	Description
MousepadEffectType	effectType	The type of effect to create.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

CreateMousepadEffectAsync<T>(MousepadEffectType, T)

Creates a new mousepad effect with the specified effect data.

Declaration

Task<Guid> CreateMousepadEffectAsync<T>(MousepadEffectType effectType, T data)
    where T : struct, ValueType

Parameters

Type	Name	Description
MousepadEffectType	effectType	The type of effect to create.
T	data	Effect options struct.

Returns

Type	Description
Task<Guid>	A Guid for the created effect.

Type Parameters

Name	Description
T	The effect struct type.

DeleteEffectAsync(Guid)

Deletes an effect with the specified Guid.

Declaration

Task DeleteEffectAsync(Guid effectId)

Parameters

Type	Name	Description
Guid	effectId	Effect ID to delete.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

InitializeAsync(AppInfo)

Initializes the Chroma SDK.

Declaration

Task InitializeAsync(AppInfo info)

Parameters

Type	Name	Description
AppInfo	info	Information about the application.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

QueryDeviceAsync(Guid)

Query for device information.

Declaration

Task<SdkDeviceInfo> QueryDeviceAsync(Guid deviceId)

Parameters

Type	Name	Description
Guid	deviceId	Device ID, found in Devices.

Returns

Type	Description
Task<SdkDeviceInfo>	A populated SdkDeviceInfo structure with information about the requested device.

RegisterEventNotifications(IntPtr)

Registers for Chroma SDK notifications.

Declaration

void RegisterEventNotifications(IntPtr windowHandle)

Parameters

Type	Name	Description
IntPtr	windowHandle	App handle for the window handling events.

SetEffectAsync(Guid)

Set effect.

Declaration

Task SetEffectAsync(Guid effectId)

Parameters

Type	Name	Description
Guid	effectId	Effect ID to set.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

UninitializeAsync()

Uninitializes the Chroma SDK.

Declaration

Task UninitializeAsync()

Returns

Type	Description
Task	A Task representing the asynchronous operation.

UnregisterEventNotifications()

Unregisters from receiving Chroma SDK notifications.

Declaration

void UnregisterEventNotifications()