Class CorsairDeviceProvider

Represents the abstract base implementation for a IRGBDeviceProvider.

Inheritance
object
AbstractRGBDeviceProvider
CorsairDeviceProvider
Implements
Inherited Members
Namespace: RGB.NET.Devices.Corsair
Assembly: RGB.NET.Devices.Corsair.dll
Syntax
public sealed class CorsairDeviceProvider : AbstractRGBDeviceProvider, IRGBDeviceProvider, IDisposable

Constructors

| Edit this page View Source

CorsairDeviceProvider()

Initializes a new instance of the CorsairDeviceProvider class.

Declaration
public CorsairDeviceProvider()
Exceptions
Type Condition
InvalidOperationException

Thrown if this constructor is called even if there is already an instance of this class.

Fields

| Edit this page View Source

SessionStateChanged

Declaration
public EventHandler<CorsairSessionState>? SessionStateChanged
Field Value
Type Description
EventHandler<CorsairSessionState>

Properties

| Edit this page View Source

ConnectionTimeout

Gets or sets the timeout used when connecting to the SDK.

Declaration
public static TimeSpan ConnectionTimeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

ExclusiveAccess

Gets or sets a bool indicating if exclusive request should be requested through the iCUE-SDK.

Declaration
public static bool ExclusiveAccess { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Instance

Gets the singleton CorsairDeviceProvider instance.

Declaration
public static CorsairDeviceProvider Instance { get; }
Property Value
Type Description
CorsairDeviceProvider
| Edit this page View Source

PossibleX64NativePaths

Gets a modifiable list of paths used to find the native SDK-dlls for x64 applications. The first match will be used.

Declaration
public static List<string> PossibleX64NativePaths { get; }
Property Value
Type Description
List<string>
| Edit this page View Source

PossibleX86NativePaths

Gets a modifiable list of paths used to find the native SDK-dlls for x86 applications. The first match will be used.

Declaration
public static List<string> PossibleX86NativePaths { get; }
Property Value
Type Description
List<string>
| Edit this page View Source

SessionDetails

Gets the details for the current SDK-session.

Declaration
public CorsairSessionDetails SessionDetails { get; }
Property Value
Type Description
CorsairSessionDetails
| Edit this page View Source

SessionState

Declaration
public CorsairSessionState SessionState { get; }
Property Value
Type Description
CorsairSessionState

Methods

| Edit this page View Source

Dispose(bool)

Disposes the object and frees all resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true if explicitely called through the Dispose-Method, false if called by the destructor.
Overrides
| Edit this page View Source

InitializeSDK()

Initializes the underlying SDK.

Declaration
protected override void InitializeSDK()
Overrides
| Edit this page View Source

LoadDevices()

Loads all devices this device provider is capable of loading.

Declaration
protected override IEnumerable<IRGBDevice> LoadDevices()
Returns
Type Description
IEnumerable<IRGBDevice>

A collection of loaded devices.
Overrides
Remarks

Filtering happens in GetLoadedDevices(RGBDeviceType).

Implements